1XmVaCreateSimpleOptionMenu(library callX)mVaCreateSimpleOptionMenu(library call)
2
6 XmVaCreateSimpleOptionMenu — A RowColumn widget convenience creation
7 function
8
10 #include <Xm/RowColumn.h>
11 Widget XmVaCreateSimpleOptionMenu(
12 Widget parent,
13 String name,
14 XmString option_label,
15 KeySym option_mnemonic,
16 int button_set,
17 XtCallbackProc callback);
18
20 XmVaCreateSimpleOptionMenu creates an instance of a RowColumn widget of
21 type XmMENU_OPTION and returns the associated widget ID. This routine
22 uses the ANSI C variable-length argument list (varargs) calling conven‐
23 tion.
24 This routine creates an OptionMenu and its Pulldown submenu containing
26 PushButtonGadget or CascadeButtonGadget children. The name of each
27 button is button_n, where n is an integer from 0 (zero) to the number
28 of buttons in the menu minus 1. The name of each separator is separa‐
29 tor_n, where n is an integer from 0 (zero) to the number of separators
30 in the menu minus 1. Buttons and separators are named and created in
31 the order in which they are specified in the variable portion of the
32 argument list.
33 parent Specifies the parent widget ID
35 name Specifies the name of the created widget
37 option_label
39 Specifies the label string to be used on the left side of the
40 OptionMenu.
41 option_mnemonic
43 Specifies a keysym for a key that, when pressed by the user,
44 posts the associated Pulldown menu pane.
45 button_set
47 Specifies which PushButtonGadget is initially set. The value
48 is the integer n that corresponds to the nth PushButtonGadget
49 specified in the variable portion of the argument list. Only
50 a PushButtonGadget can be set, and only PushButtonGadgets are
51 counted in determining the integer n. The first PushButton‐
52 Gadget is number 0 (zero).
53 callback Specifies a callback procedure to be called when a button is
55 activated. This callback function is added to each button
56 after creation as the button's XmNactivateCallback. The
57 callback function is called when a button is activated, and
58 the button number is returned in the client_data field.
59 The variable portion of the argument list consists of groups of argu‐
61 ments. The first argument in each group is a constant or a string and
62 determines which arguments follow in that group. The last argument in
63 the list must be NULL. Following are the possible first arguments in
64 each group of varargs:
65 XmVaPUSHBUTTON
67 This is followed by four additional arguments. The set speci‐
68 fies one button in the OptionMenu's Pulldown submenu and some
69 of its resource values. The button created is a PushButton‐
70 Gadget. Following are the additional four arguments, in
71 order:
72 label The label string, of type XmString
74 mnemonic The mnemonic, of type KeySym
76 accelerator
78 The accelerator, of type String
79 accelerator_text
81 The accelerator text, of type XmString
82 XmVaSEPARATOR
84 This is followed by no additional arguments. It specifies one
85 separator in the OptionMenu's Pulldown submenu.
86 XmVaDOUBLE_SEPARATOR
88 This is followed by no additional arguments. It specifies one
89 separator in the OptionMenu's Pulldown submenu. The separator
90 type is XmDOUBLE_LINE.
91 resource_name
93 This is followed by one additional argument, the value of the
94 resource, of type XtArgVal. The pair specifies a resource and
95 its value for the Pulldown submenu.
96 XtVaTypedArg
98 This is followed by four additional arguments. The set speci‐
99 fies a resource and its value for the Pulldown submenu. A
100 resource type conversion is performed if necessary. Following
101 are the additional four arguments, in order:
102 name The resource name, of type String
104 type The type of the resource value supplied, of type
106 String
107 value The resource value (or a pointer to the resource
109 value, depending on the type and size of the
110 value), of type XtArgVal
111 size The size of the resource value in bytes, of type
113 int
114 XtVaNestedList
116 This is followed by one additional argument of type
117 XtVarArgsList. This argument is a nested list of varargs
118 returned by XtVaCreateArgsList.
119 The user can specify resources in a resource file for the automatically
121 created widgets and gadgets of an OptionMenu. The following list iden‐
122 tifies the names of these widgets (or gadgets) and the associated
123 OptionMenu areas:
124 Option Menu Label Gadget
126 OptionLabel
127 Option Menu Cascade Button
129 OptionButton
130 For more information on variable-length argument lists, see the X Tool‐
132 kit Intrinsics documentation.
133 A number of resources exist specifically for use with this and other
135 simple menu creation routines. For a complete definition of RowColumn
136 and its associated resources, see XmRowColumn(3).
137
139 Returns the RowColumn widget ID.
140
142 XmCreateOptionMenu(3), XmCreateRowColumn(3), XmCreateSimpleOption‐
143 Menu(3), and XmRowColumn(3).
144 XmVaCreateSimpleOptionMenu(library call)