Classes

XmComboBox inherits behavior, resources, and traits from Core, Composite, and XmManager classes.

The class pointer is xmComboBoxWidgetClass.

The class name is XmComboBox.

New Resources

The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a .Xdefaults file, remove the XmN or XmC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the Xm prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be at creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A).

XmNarrowSize

Specifies the width of the arrow. The default size depends on the size of the text, as well as the size of the ComboBox.

XmNarrowSpacing

Specifies the space between the text and arrow visual in pixels. The default value is obtained from the XmNmarginWidth resource.

XmNcolumns

Specifies the number of columns in the text field. If unset, the text field's value is used. Refer to the XmTextField man page for more detailed information.

XmNcomboBoxType

Specifies the type of ComboBox to be created. This can be one of the following:

XmNfontList

Specifies the fontlist associated with XmComboBox. The fontlist is an obsolete construct, and has been superseded by the render table. It is included for compatibility with earlier versions of Motif, and for applications that do not easily support render tables. The default fontlist is derived from the default render table, and if both a fontlist and a render table are specified, the render table takes precedence.

XmNhighlightThickness

Specifies the thickness of the highlighting rectangle.

XmNitemCount

Specifies the number of items in the list. If unset, the lists's value is used. Refer to the XmList man page for more detailed information.

XmNitems

Specifies the items in the list. If unset, the lists's value is used. Refer to the XmList man page for more detailed information.

XmNlist

The list widget.

XmNmarginWidth

Specifies the horizontal spacing between the child widgets and the boundary of the ComboBox.

XmNmarginHeight

Specifies the vertical spacing between the child widgets and the boundary of the ComboBox.

XmNmatchBehavior

Defines the matching algorithm applied to match the text typed by the user in the TextField field with items in the list. The current values are XmNONE and XmQUICK_NAVIGATE, as follows:

XmNpositionMode

Specifies how the value of the XmNselectedPosition resource and the item_position field of the callback structure are to be interpreted. Note that the convenience functions XmComboBoxDeletePos and XmComboBoxAddItem are not affected by this resource, and (like XmList) always use 1-based positions. Valid values for this resource are:

XmNrenderTable

Specifies the render table associated with ComboBox. This render table is used in both the TextField field and the List in the ComboBox. This is used in conjunction with the XmNvisibleItemCount resource of the List to determine the height of the ComboBox widget.

If this value is NULL at initialization, and if the widget parent is XmBulletinBoard or its subclasses, VendorShell or its subclasses, or XmMenuShell, then the widget parent provides the default render table associated with the widget. If both a render table and a fontlist are specified, the render table will take precedence.

XmNselectedItem

Specifies a compound string that represents the current selection of the ComboBox. The selected item is the content of the ComboBox text entry field.

XmNselectedPosition

If the selection in the ComboBox is an item in the list, this is the index of the selected item in the list. If no item in the list is selected, this is 0.

XmNselectionCallback

Specifies the list of callbacks called when an item is selected. The reason field in the XmComboBoxCallbackStruct is XmCR_SELECT.

XmNtextField

The text field widget.

XmNvisibleItemCount

Specifies the number of visible items in the list. This will override any value specified for the list. Refer to the XmList man page for more detailed information.

Inherited Resources

ComboBox inherits behavior and resources from superclasses described in the following tables. For a complete description of each resource, refer to the reference page for that superclass.

Callback Information

A pointer to the following structure is passed to each callback. The callback structure is defined as follows:

typedef struct
{


        int reason;


        XEvent *event;


        XmString item_or_text;


        int item_position;
} XmComboBoxCallbackStruct;

reason

Indicates why the callback was invoked.

event

Points to the XEvent that triggered the callback. It can be NULL.

item_or_text

The contents of the text field at the time the event caused the callback. The item_or_text parameter points to a temporary storage space that is reused after the callback is finished. If an application needs to save the item, it should copy item_or_text into its own data space.

item_position

The position of item in the list's XmNitems 1-based array. If this is 0, it means that the item_or_text was not selected from the List.

Translations

The ComboBox translations are listed below.

The following key names are listed in the X standard key event translation table syntax. This format is the one used by Motif to specify the widget actions corresponding to a given key. A brief overview of the format is provided under VirtualBindings(3). For a complete description of the format, please refer to the X Toolkit Instrinsics Documentation.

<Btn1Down>:

CBArmAndDropDownList()

<Btn1Up>:

CBDisarm()

The following lists the List translations in the drop-down list. When ComboBox XmNcomboBoxType is XmDROP_DOWN_LIST, <osfActivate>, <osfCancel>, and Return are overriden by ComboBox actions.

:c <Key><osfDown>:

CBDropDownList()

:c <Key><osfUp>:

CBDropDownList()

:<Key><osfCancel>:

CBCancel()

:<Key><osfActivate>:

CBActivate()

∼s ∼m ∼a<Key>Return:

CBActivate()

Accelerators

The following accelerators are added to ComboBox and its children. The accelerators may not directly correspond to a translation table. If the translation is not listed below, it may depend on the context of the event.

:c <Key><osfUp>:

CBDropDownList()

:<Key><osfUp>:

CBListAction(Up)

:c <Key><osfDown>:

CBDropDownList()

:<Key><osfDown>:

CBListAction(Down)

:c <Key><osfBeginLine>:

CBListAction(ListBeginData)

:c <Key><osfEndLine>:

CBListAction(ListEndData)

:<Key><osfPageUp>:

CBListAction(ListPrevPage)

:<Key><osfPageDown>:

CBListAction(ListNextPage)

A drop-down ComboBox also adds accelerators to its List child. Aside from the accelerators that are already listed in this section, those accelerators are the default TextField key translations.

Action Routines

The XmComboBox action routines are as follows:

CBActivate():

Calls the XmNselectionCallback callbacks. If the XmNcomboBoxType is XmDROP_DOWN_COMBO_BOX or XmDROP_DOWN_LIST, it unposts the list. If the parent is a manager, passes the event to the parent.

CBArmAndDropDownList():

If the pointer is within the down arrow, draws the shadow of the arrow in the selected state, and then posts the list.

CBCancel():

If the XmNcomboBoxType is XmDROP_DOWN_COMBO_BOX or XmDROP_DOWN_LIST, pops down the list. If the parent is a manager, passes the event to the parent.

CBDisarm():

Redraws the arrow in an unselected state.

CBDropDownList():

If XmNcomboBoxType is XmDROP_DOWN or XmDROP_DOWN_LIST, and list is not displayed, posts the list. If list is displayed, it unposts the list.

CBListAction(ListBeginData):

Moves the location cursor to the first item in the list. In Normal Mode, this also deselects any current selection, selects the first item in the list, and calls the XmNbrowseSelectionCallback selection callback.

CBListAction(ListEndData):

Moves the location cursor to the last item in the list. In Normal Mode, this also deselects any current selection, selects the last item in the list, and calls the XmNbrowseSelectionCallback selection callback.

CBListAction(ListPrevPage):

Scrolls the list to the previous page, moving the location cursor to a new item. This action also selects the new item, deselects any current selection, and calls the XmNbrowseSelectionCallback callbacks. If the ComboBox is not a drop-down type, then this action does nothing.

CBListAction(ListNextPage):

Scrolls the list to the next page, moving the location cursor to a new item. This action also selects the new item, deselects any current selection, and calls the XmNbrowseSelectionCallback callbacks. If the ComboBox is not a drop-down type, then this action does nothing.

CBListAction(Up):

Moves the location cursor to the previous item in the list. This action also selects the previous item, deselects any current selection, and calls the XmNbrowseSelectionCallback callbacks. Note that, unlike the List ListPrevItem action, this action wraps around.

CBListAction(Down):

Moves the location cursor to the next item in the list. This action also selects the next item, deselects any current selection, and calls the XmNbrowseSelectionCallback callbacks. Note that, unlike the List ListNextItem action, this action wraps around.

Virtual Bindings

The bindings for virtual keys are vendor specific. For information about bindings for virtual buttons and keys, see VirtualBindings(3).