XmVaCreateSimpleOptionMenu(Xm) XmVaCreateSimpleOptionMenu(Xm)
6 January 1993
Name
XmVaCreateSimpleOptionMenu - a RowColumn widget convenience creation
function
Syntax
#include <Xm/RowColumn.h>
Widget XmVaCreateSimpleOptionMenu (parent, name, option_label,
option_mnemonic, button_set,
callback, arg...)
Widget parent;
String name;
XmString option_label;
KeySym option_mnemonic;
int button_set;
XtCallbackProc callback;
Description
XmVaCreateSimpleOptionMenu creates an instance of a RowColumn widget of
type XmMENUOPTION and returns the associated widget ID. This routine
uses the ANSI C variable-length argument list (varargs) calling conven-
tion.
This routine creates an OptionMenu and its Pulldown submenu containing
PushButtonGadget or CascadeButtonGadget children. The name of each but-
ton is buttonn, where n is an integer from 0 to one minus the number of
buttons in the menu. The name of each separator is separatorn, where n
is an integer from 0 to one minus the number of separators in the menu.
Buttons and separators are named and created in the order in which they
are specified in the variable portion of the argument list.
parent Specifies the parent widget ID
name Specifies the name of the created widget
optionlabel
Specifies the label string to be used on the left side of the
OptionMenu.
optionmnemonic
Specifies a keysym for a key that, when pressed by the user,
posts the associated Pulldown MenuPane.
buttonset
Specifies which PushButtonGadget is initially set. The value is
the integer n that corresponds to the nth PushButtonGadget speci-
fied in the variable portion of the argument list. Only a Push-
ButtonGadget can be set, and only PushButtonGadgets are counted
in determining the integer n. The first PushButtonGadget is num-
ber 0.
callback
Specifies a callback procedure to be called when a button is
activated. This callback function is added to each button after
creation as the button's XmNactivateCallback. The callback func-
tion is called when a button is activated, and the button number
is returned in the clientdata field.
The variable portion of the argument list consists of groups of argu-
ments. The first argument in each group is a constant or a string and
determines which arguments follow in that group. The last argument in
the list must be NULL. Following are the possible first arguments in
each group of varargs:
XmVaPUSHBUTTON
This is followed by four additional arguments. The set specifies
one button in the OptionMenu's Pulldown submenu and some of its
resource values. The button created is a PushButtonGadget. Fol-
lowing are the additional four arguments, in this order:
label The label string, of type XmString.
mnemonic
The mnemonic, of type KeySym.
accelerator
The accelerator, of type String.
acceleratortext
The accelerator text, of type XmString.
XmVaSEPARATOR
This is followed by no additional arguments. It specifies one
separator in the OptionMenu's Pulldown submenu.
XmVaDOUBLESEPARATOR
This is followed by no additional arguments. It specifies one
separator in the OptionMenu's Pulldown submenu. The separator
type is XmDOUBLELINE.
resourcename
This is followed by one additional argument, the value of the
resource, of type XtArgVal. The pair specifies a resource and its
value for the Pulldown submenu.
XtVaTypedArg
This is followed by four additional arguments. The set specifies
a resource and its value for the Pulldown submenu. A resource
type conversion is performed if necessary. Following are the
additional four arguments, in this order:
name The resource name, of type String.
type The type of the resource value supplied, of type String.
value The resource value (or a pointer to the resource value,
depending on the type and size of the value), of type
XtArgVal.
size The size of the resource value in bytes, of type int.
XtVaNestedList
This is followed by one additional argument of type
XtVarArgsList. This argument is a nested list of varargs
returned by XtVaCreateArgsList.
The user can specify resources in a resource file for the automatically
created widgets and gadgets of an OptionMenu. The following list identi-
fies the names of these widgets (or gadgets) and the associated Option-
Menu areas.
+ Option Menu Label Gadget -- ``OptionLabel''
+ Option Menu Cascade Button -- ``OptionButton''
For more information on variable-length argument lists, see the X Toolkit
Intrinsics documentation.
A number of resources exist specifically for use with this and other sim-
ple menu creation routines. For a complete definition of RowColumn and
its associated resources, see XmRowColumn(Xm).
Return value
Returns the RowColumn widget ID.
See also
XmCreateOptionMenu(Xm), XmCreateRowColumn(Xm),
XmCreateSimpleOptionMenu(Xm) and XmRowColumn(Xm).