1XmCommand(library call)                                XmCommand(library call)
2
3
4

NAME

6       XmCommand — The Command widget class
7

SYNOPSIS

9       #include <Xm/Command.h>
10

DESCRIPTION

12       Command  is  a  special-purpose composite widget for command entry that
13       provides a built-in command-history mechanism.  Command includes a com‐
14       mand-line  text-input  field, a command-line prompt, and a command-his‐
15       tory list region.
16
17       One additional WorkArea child may be added to the  Command  after  cre‐
18       ation.
19
20       Whenever  a command is entered, it is automatically added to the end of
21       the command-history list and made visible.  This does  not  change  the
22       selected item in the list, if there is one.
23
24       Many of the new resources specified for Command are actually Selection‐
25       Box resources that have been renamed for clarity and ease of use.
26
27   Descendants
28       Command automatically creates the descendants shown  in  the  following
29       table.   An  application  can  use XtNameToWidget to gain access to the
30       named descendant. In addition, a user or an  application  can  use  the
31       named descendant when specifying resource values.
32
33       ┌─────────────────┬──────────────────┬───────────────────────────────┐
34Named Descendant Class            Identity                      
35       ├─────────────────┼──────────────────┼───────────────────────────────┤
36       ├─────────────────┼──────────────────┼───────────────────────────────┤
37       ├─────────────────┼──────────────────┼───────────────────────────────┤
38ItemsList        XmList           │ command-history list region   │
39       ├─────────────────┼──────────────────┼───────────────────────────────┤
40ItemsListSW      XmScrolledWindow │ the  ScrolledWindow parent of │
41       │                 │                  │ ItemsList                     
42       ├─────────────────┼──────────────────┼───────────────────────────────┤
43Selection        XmLabelGadget    │ command-line prompt           │
44       ├─────────────────┼──────────────────┼───────────────────────────────┤
45Text             XmTextField      │ command-line text-input field │
46       ├─────────────────┼──────────────────┼───────────────────────────────┤
47       └─────────────────┴──────────────────┴───────────────────────────────┘
48   Classes
49       Command inherits behavior, resources, and traits from Core,  Composite,
50       Constraint, XmManager, XmBulletinBoard, and XmSelectionBox.
51
52       The class pointer is xmCommandWidgetClass.
53
54       The class name is XmCommand.
55
56   New Resources
57       The  following table defines a set of widget resources used by the pro‐
58       grammer to specify data. The programmer can also set the resource  val‐
59       ues  for  the  inherited  classes to set attributes for this widget. To
60       reference a resource by name or by class in a .Xdefaults  file,  remove
61       the XmN or XmC prefix and use the remaining letters.  To specify one of
62       the defined values for a resource in a .Xdefaults file, remove  the  Xm
63       prefix and use the remaining letters (in either lowercase or uppercase,
64       but include any underscores between words).  The codes  in  the  access
65       column  indicate if the given resource can be set at creation time (C),
66       set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
67       not applicable (N/A).
68
69       ┌─────────────────────────────────────────────────────────────────────────────────────┐
70       │                           │   XmCommand ResourceSet             │         │        │
71Name                       Class               Type           Default Access 
72       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
73       │XmNcommand                 │ XmCTextString       │ XmString       │ ""      │ CSG    │
74       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
75       │XmNcommandChangedCallback  │ XmCCallback         │ XtCallbackList │ NULL    │ C      │
76       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
77       │XmNcommandEnteredCallback  │ XmCCallback         │ XtCallbackList │ NULL    │ C      │
78       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
79       │XmNhistoryItems            │ XmCItems            │ XmStringTable  │ NULL    │ CSG    │
80       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
81       │XmNhistoryItemCount        │ XmCItemCount        │ int            │ 0       │ CSG    │
82       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
83       │XmNhistoryMaxItems         │ XmCMaxItems         │ int            │ 100     │ CSG    │
84       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
85       │XmNhistoryVisibleItemCount │ XmCVisibleItemCount │ int            │ dynamic │ CSG    │
86       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
87       │XmNpromptString            │ XmCPromptString     │ XmString       │ dynamic │ CSG    │
88       ├───────────────────────────┼─────────────────────┼────────────────┼─────────┼────────┤
89       └───────────────────────────┴─────────────────────┴────────────────┴─────────┴────────┘
90       XmNcommand
91                 Contains  the  current  command-line  text.  This is the XmN‐
92                 textString resource in  SelectionBox,  renamed  for  Command.
93                 This resource can also be modified with XmCommandSetValue and
94                 XmCommandAppendValue functions.  The command area is  a  Text
95                 widget.
96
97       XmNcommandChangedCallback
98                 Specifies  the  list  of  callbacks that is called after each
99                 time the value of the command changes.  The  callback  reason
100                 is  XmCR_COMMAND_CHANGED.   This is equivalent to the XmNval‐
101                 ueChangedCallback of the Text widget, except that  a  pointer
102                 to  an  XmCommandCallbackStructure  is passed, and the struc‐
103                 ture's value member contains the XmString.
104
105       XmNcommandEnteredCallback
106                 Specifies the list of callbacks that is called when a command
107                 is  entered in the Command.  The callback reason is XmCR_COM‐
108                 MAND_ENTERED. A pointer to an XmCommandCallback structure  is
109                 passed.
110
111       XmNhistoryItems
112                 Lists XmString items that make up the contents of the history
113                 list. This is  the  XmNlistItems  resource  in  SelectionBox,
114                 renamed  for  Command.  XtGetValues for this resource returns
115                 the list items themselves, not a copy of the list items.  The
116                 application must not free the returned items.
117
118       XmNhistoryItemCount
119                 Specifies the number of XmStrings in XmNhistoryItems. This is
120                 the XmNlistItemCount resource in  SelectionBox,  renamed  for
121                 Command.  The value must not be negative.
122
123       XmNhistoryMaxItems
124                 Specifies  the maximum number of items allowed in the history
125                 list. Once this number is reached, an existing list item must
126                 be  removed  before  a new item can be added to the list. For
127                 each command entered, the first list item is removed from the
128                 list, so the new command can be added to the list.  The value
129                 must be greater than 0 (zero).
130
131       XmNhistoryVisibleItemCount
132                 Specifies the number of items in the history list that should
133                 be  visible  at  one  time. In effect, it sets the height (in
134                 lines) of the history list window. This is  the  XmNlistVisi‐
135                 bleItemCount  resource  in SelectionBox, renamed for Command.
136                 The value must be greater than  0  (zero).   The  default  is
137                 dynamic based on the height of the list.
138
139       XmNpromptString
140                 Specifies  a prompt for the command line.  This is the XmNse‐
141                 lectionLabelString resource in SelectionBox, renamed for Com‐
142                 mand.   The  default  may  vary depending on the value of the
143                 XmNlayoutDirection resource and the locale.  In the C  locale
144                 the default is > (right angle bracket).
145
146                 Now  that  some  default localized label strings are provided
147                 through message catalogs for the children of  composite  wid‐
148                 gets,  the  labelString  resources cannot be set on the child
149                 through default resource files.  Instead, the  resource  pro‐
150                 vided at the parent level must be used.
151
152   Inherited Resources
153       Command inherits behavior and resources from the superclasses described
154       in the following tables.  For a complete description of each  resource,
155       refer to the reference page for that superclass.
156
157       ┌──────────────────────────────────────────────────────────────────────────────────────────────────────┐
158       │                        │            XmSelectionBo│x Resource Set   │                         │        │
159Name                    Class                   Type           Default                 Access 
160       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
161       │XmNapplyCallback        │ XmCCallback             │ XtCallbackList │ NULL                    │ N/A    │
162       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
163       │XmNapplyLabelString     │ XmCApplyLabelString     │ XmString       │ dynamic                 │ N/A    │
164       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
165       │XmNcancelCallback       │ XmCCallback             │ XtCallbackList │ NULL                    │ N/A    │
166       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
167       │XmNcancelLabelString    │ XmCCancelLabelString    │ XmString       │ dynamic                 │ N/A    │
168       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
169       │XmNchildPlacement       │ XmCChildPlacement       │ unsigned char  │ XmPLACE_ABOVE_SELECTION │ CSG    │
170       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
171       │XmNdialogType           │ XmCDialogType           │ unsigned char  │ XmDIALOG_COMMAND        │ G      │
172       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
173       │XmNhelpLabelString      │ XmCHelpLabelString      │ XmString       │ dynamic                 │ N/A    │
174       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
175       │XmNlistItemCount        │ XmCItemCount            │ int            │ 0                       │ CSG    │
176       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
177       │XmNlistItems            │ XmCItems                │ XmStringTable  │ NULL                    │ CSG    │
178       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
179       │XmNlistLabelString      │ XmCListLabelString      │ XmString       │ NULL                    │ N/A    │
180       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
181       │XmNlistVisibleItemCount │ XmCVisibleItemCount     │ int            │ dynamic                 │ CSG    │
182       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
183       │XmNminimizeButtons      │ XmCMinimizeButtons      │ Boolean        │ False                   │ N/A    │
184       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
185       │XmNmustMatch            │ XmCMustMatch            │ Boolean        │ False                   │ N/A    │
186       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
187       │XmNnoMatchCallback      │ XmCCallback             │ XtCallbackList │ NULL                    │ N/A    │
188       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
189       │XmNokCallback           │ XmCCallback             │ XtCallbackList │ NULL                    │ N/A    │
190       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
191       │XmNokLabelString        │ XmCOkLabelString        │ XmString       │ dynamic                 │ N/A    │
192       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
193       │XmNselectionLabelString │ XmCSelectionLabelString │ XmString       │ dynamic                 │ CSG    │
194       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
195       │XmNtextAccelerators     │ XmCTextAccelerators     │ XtAccelerators │ default                 │ C      │
196       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
197       │XmNtextColumns          │ XmCColumns              │ short          │ dynamic                 │ CSG    │
198       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
199       │XmNtextString           │ XmCTextString           │ XmString       │ ""                      │ CSG    │
200       ├────────────────────────┼─────────────────────────┼────────────────┼─────────────────────────┼────────┤
201       └────────────────────────┴─────────────────────────┴────────────────┴─────────────────────────┴────────┘
202       ┌──────────────────────────────────────────────────────────────────────────────────────┐
203       │                     │      XmBulletinBoard │Resource Set     │               │        │
204Name                 Class                Type           Default       Access 
205       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
206       │XmNallowOverlap      │ XmCAllowOverlap      │ Boolean        │ True          │ CSG    │
207       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
208       │XmNautoUnmanage      │ XmCAutoUnmanage      │ Boolean        │ False         │ N/A    │
209       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
210       │XmNbuttonFontList    │ XmCButtonFontList    │ XmFontList     │ dynamic       │ N/A    │
211       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
212       │XmNbuttonRenderTable │ XmCButtonRenderTable │ XmRenderTable  │ dynamic       │ CSG    │
213       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
214       │XmNcancelButton      │ XmCWidget            │ Widget         │ NULL          │ N/A    │
215       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
216       │XmNdefaultButton     │ XmCWidget            │ Widget         │ NULL          │ N/A    │
217       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
218       │XmNdefaultPosition   │ XmCDefaultPosition   │ Boolean        │ False         │ CSG    │
219       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
220       │XmNdialogStyle       │ XmCDialogStyle       │ unsigned char  │ dynamic       │ CSG    │
221       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
222       │XmNdialogTitle       │ XmCDialogTitle       │ XmString       │ NULL          │ CSG    │
223       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
224       │XmNfocusCallback     │ XmCCallback          │ XtCallbackList │ NULL          │ C      │
225       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
226       │XmNlabelFontList     │ XmCLabelFontList     │ XmFontList     │ dynamic       │ CSG    │
227       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
228       │XmNlabelRenderTable  │ XmCLabelRenderTable  │ XmRenderTable  │ dynamic       │ CSG    │
229       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
230       │XmNmapCallback       │ XmCCallback          │ XtCallbackList │ NULL          │ C      │
231       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
232       │XmNmarginHeight      │ XmCMarginHeight      │ Dimension      │ 10            │ CSG    │
233       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
234       │XmNmarginWidth       │ XmCMarginWidth       │ Dimension      │ 10            │ CSG    │
235       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
236       │XmNnoResize          │ XmCNoResize          │ Boolean        │ False         │ CSG    │
237       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
238       │XmNresizePolicy      │ XmCResizePolicy      │ unsigned char  │ XmRESIZE_NONE │ CSG    │
239       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
240       │XmNshadowType        │ XmCShadowType        │ unsigned char  │ XmSHADOW_OUT  │ CSG    │
241       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
242       │XmNtextFontList      │ XmCTextFontList      │ XmFontList     │ dynamic       │ CSG    │
243       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
244       │XmNtextRenderTable   │ XmCTextRenderTable   │ XmRenderTable  │ dynamic       │ CSG    │
245       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
246       │XmNtextTranslations  │ XmCTranslations      │ XtTranslations │ NULL          │ C      │
247       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
248       │XmNunmapCallback     │ XmCCallback          │ XtCallbackList │ NULL          │ C      │
249       ├─────────────────────┼──────────────────────┼────────────────┼───────────────┼────────┤
250       └─────────────────────┴──────────────────────┴────────────────┴───────────────┴────────┘
251       ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
252       │                        │             XmManager │Resource Set        │                      │        │
253Name                    Class                 Type              Default              Access 
254       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
255       │XmNbottomShadowColor    │ XmCBottomShadowColor  │ Pixel             │ dynamic              │ CSG    │
256       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
257       │XmNbottomShadowPixmap   │ XmCBottomShadowPixmap │ Pixmap            │ XmUNSPECIFIED_PIXMAP │ CSG    │
258       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
259       │XmNforeground           │ XmCForeground         │ Pixel             │ dynamic              │ CSG    │
260       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
261       │XmNhelpCallback         │ XmCCallback           │ XtCallbackList    │ NULL                 │ C      │
262       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
263       │XmNhighlightColor       │ XmCHighlightColor     │ Pixel             │ dynamic              │ CSG    │
264       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
265       │XmNhighlightPixmap      │ XmCHighlightPixmap    │ Pixmap            │ dynamic              │ CSG    │
266       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
267       │XmNinitialFocus         │ XmCInitialFocus       │ Widget            │ dynamic              │ CSG    │
268       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
269       │XmNlayoutDirection      │ XmCLayoutDirection    │ XmDirection       │ dynamic              │ CG     │
270       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
271       │XmNnavigationType       │ XmCNavigationType     │ XmNavigationType  │ XmTAB_GROUP          │ CSG    │
272       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
273       │XmNpopupHandlerCallback │ XmCCallback           │ XtCallbackList    │ NULL                 │ C      │
274       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
275       │XmNshadowThickness      │ XmCShadowThickness    │ Dimension         │ dynamic              │ CSG    │
276       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
277       │XmNstringDirection      │ XmCStringDirection    │ XmStringDirection │ dynamic              │ CG     │
278       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
279       │XmNtopShadowColor       │ XmCTopShadowColor     │ Pixel             │ dynamic              │ CSG    │
280       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
281       │XmNtopShadowPixmap      │ XmCTopShadowPixmap    │ Pixmap            │ dynamic              │ CSG    │
282       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
283       │XmNtraversalOn          │ XmCTraversalOn        │ Boolean           │ True                 │ CSG    │
284       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
285       │XmNunitType             │ XmCUnitType           │ unsigned char     │ dynamic              │ CSG    │
286       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
287       │XmNuserData             │ XmCUserData           │ XtPointer         │ NULL                 │ CSG    │
288       ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
289       └────────────────────────┴───────────────────────┴───────────────────┴──────────────────────┴────────┘
290       ┌───────────────────────────────────────────────────────────────────────┐
291       │                  │     Composite Reso│urce Set      │         │        │
292Name              Class             Type        Default Access 
293       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
294       │XmNchildren       │ XmCReadOnly       │ WidgetList  │ NULL    │ G      │
295       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
296       │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL    │ CSG    │
297       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
298       │XmNnumChildren    │ XmCReadOnly       │ Cardinal    │ 0       │ G      │
299       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
300       └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
301       ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
302       │                              │               Core Resource Se│t                │                      │        │
303Name                          Class                         Type           Default              Access 
304       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
305       │XmNaccelerators               │ XmCAccelerators               │ XtAccelerators │ dynamic              │ N/A    │
306       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
307       │XmNancestorSensitive          │ XmCSensitive                  │ Boolean        │ dynamic              │ G      │
308       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
309       │XmNbackground                 │ XmCBackground                 │ Pixel          │ dynamic              │ CSG    │
310       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
311       │XmNbackgroundPixmap           │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
312       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
313       │XmNborderColor                │ XmCBorderColor                │ Pixel          │ XtDefaultForeground  │ CSG    │
314       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
315       │XmNborderPixmap               │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
316       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
317       │XmNborderWidth                │ XmCBorderWidth                │ Dimension      │ 0                    │ CSG    │
318       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
319       │XmNcolormap                   │ XmCColormap                   │ Colormap       │ dynamic              │ CG     │
320       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
321       │XmNdepth                      │ XmCDepth                      │ int            │ dynamic              │ CG     │
322       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
323       │XmNdestroyCallback            │ XmCCallback                   │ XtCallbackList │ NULL                 │ C      │
324       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
325       │XmNheight                     │ XmCHeight                     │ Dimension      │ dynamic              │ CSG    │
326       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
327       │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean        │ True                 │ C      │
328       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
329       │XmNmappedWhenManaged          │ XmCMappedWhenManaged          │ Boolean        │ True                 │ CSG    │
330       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
331       │XmNscreen                     │ XmCScreen                     │ Screen *       │ dynamic              │ CG     │
332       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
333       │XmNsensitive                  │ XmCSensitive                  │ Boolean        │ True                 │ CSG    │
334       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
335       │XmNtranslations               │ XmCTranslations               │ XtTranslations │ dynamic              │ CSG    │
336       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
337       │XmNwidth                      │ XmCWidth                      │ Dimension      │ dynamic              │ CSG    │
338       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
339       │XmNx                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
340       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
341       │XmNy                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
342       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
343       └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
344   Callback Information
345       A pointer to the following structure is passed to each callback:
346
347       typedef struct
348       {
349               int reason;
350               XEvent * event;
351               XmString value;
352               int length;
353       } XmCommandCallbackStruct;
354
355       reason    Indicates why the callback was invoked
356
357       event     Points to the XEvent that triggered the callback
358
359       value     Specifies the XmString in the CommandArea
360
361       length    Specifies the size in bytes of the XmString value.  This mem‐
362                 ber is obsolete and exists  for  compatibility  with  earlier
363                 releases.
364
365   Translations
366       XmCommand inherits translations from XmSelectionBox.
367
368   Accelerators
369       The  XmNtextAccelerators  from  XmSelectionBox  are  added  to the Text
370       descendant of XmCommand.
371
372   Action Routines
373       The XmCommand action routines are:
374
375       SelectionBoxUpOrDown(Previous|Next|First|Last):
376                 When called with an argument of Previous,  or  0  (zero)  for
377                 compatibility,  selects the previous item in the history list
378                 and replaces the text with that item.
379
380                 When called with an argument of Next, or 1 for compatibility,
381                 selects  the  next  item in the history list and replaces the
382                 text with that item.
383
384                 When called with an argument of First, or 2  for  compatibil‐
385                 ity,  selects the first item in the history list and replaces
386                 the text with that item.
387
388                 When called with an argument of Last, or 3 for compatibility,
389                 selects  the  last  item in the history list and replaces the
390                 text with that item.
391
392                 Calls the callbacks for XmNcommandChangedCallback.
393
394   Additional Behavior
395       The Command widget has the following additional behavior:
396
397       <Key><osfCancel>:
398                 If the parent of the Command  is  a  manager,  the  event  is
399                 passed to the parent.
400
401       <Key><osfActivate> in Text:
402                 Calls  the  Text  widget's XmNactivateCallback callbacks.  If
403                 the text is empty, this action then returns.   Otherwise,  if
404                 the history list has XmNhistoryMaxItems items, it removes the
405                 first item in the list.  It adds the text to the history list
406                 as  the  last item, clears the text, and calls the XmNcomman‐
407                 dEnteredCallback callbacks.
408
409       <Key> in Text:
410                 When any change is made to the text edit widget, this  action
411                 calls the callbacks for XmNcommandChangedCallback.
412
413       <BtnDown>(2+) or <Key><osfActivate> in List:
414                 Calls  the  List widget's XmNdefaultActionCallback callbacks.
415                 If the history list has XmNhistoryMaxItems items, this action
416                 removes  the  first  item  in the list.  It adds the selected
417                 List item to the history list as the last  item,  clears  the
418                 text, and calls the XmNcommandEnteredCallback callbacks.
419
420       <FocusIn>:
421                 Calls the callbacks for XmNfocusCallback.
422
423       <MapWindow>:
424                 When  a Command that is the child of a DialogShell is mapped,
425                 this action calls the callbacks for XmNmapCallback.
426
427       <UnmapWindow>:
428                 When a  Command  that  is  the  child  of  a  DialogShell  is
429                 unmapped,  this  action calls the callbacks for XmNunmapCall‐
430                 back.
431
432   Virtual Bindings
433       The bindings for virtual keys are  vendor  specific.   For  information
434       about bindings for virtual buttons and keys, see VirtualBindings(3).
435
437       Composite(3),  Constraint(3), Core(3), XmBulletinBoard(3), XmCommandAp‐
438       pendValue(3),  XmCommandError(3),  XmCommandGetChild(3),  XmCommandSet‐
439       Value(3), XmCreateCommand(3), XmManager(3), XmSelectionBox(3), XmVaCre‐
440       ateCommand(3), and XmVaCreateManagedCommand(3).
441
442
443
444                                                       XmCommand(library call)
Impressum