XmDropDown - Man Page

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

The class pointer is xmDropDownWidgetClass.

The class name is XmDropDown.

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).

XmNcustomizedCombinationBox

If this resource is True then the widget will not automatically create a popup shell  and list widget. This resource can be used, as the name implies, to create a custom  combination box that has something other than a list in it. If this resource is true  then a shell must be provided to the DropDown widget via the popupShellWidget  resource. Just before the shell is popped up the updateShellCallback is called. Just  after the shell is popped down the updateTextCallback is called. If verify is true  then the verifyTextCallback is called when the combo box needs to verify the  contents of the text widget against the allowable values in the custom shell.

XmNeditable

This boolean value determines whether the user is allowed to type into  TextField widget of the DropDown widget. If this value is False, selecting the text field will popup the combo box list

XmNhorizontalMargin

Specifies the horizontal spacing between the child widgets and the boundary of the DropDown widget.

XmNverticalMargin

Specifies the vertical spacing between the child widgets and the boundary of the DropDown widget.

XmNitemCount

The number of items in the popup list.

XmNitems

The list of all choice that will be displayed in the popup list.

XmNlabelString

The string displayed as the label of the DropDown widget.

XmNpopupCursor

The cursor to display to the user when the DropDown's list is popped up.  See X Window System, Robert Scheiffler et al., Appendix B, for choices.

XmNpopupOffset

The amount of space in pixels between the left edge of the Text widget and the left  edge of the list when the list is displayed. Positive values mean the text's left edge  is farther to the left, negative values mean the list's edge is farther to the left. If this  is a non-custom DropDown widget the right edge of the text and the right edge of  the arrow button will always line up.

XmNpopupShellWidget

The widget identifier for the shell that is popped up when the arrow is clicked. If  customizedCombinationBox is False then this widget is automatically created  by the DropDown widget.

XmNshowLabel

A boolean value that specifies whether or not to display the DropDown  Label widget.

XmNupdateShellCallback

XmNupdateTextCallback

The callback routine to call when either the shell widget contents or the Text  widget need to be updated to correspond with the other. The shell is updated just  before it is popped up. The text is updated just after the shell is popped down. If  customizedComboBox is False then the updates are done automatically by the  combo box. These routines are called to inform the application that an action has  been taken, in case it would like to do any further processing.

XmNuseTextField

A boolean value that specifies if an XmTextField or an XmText widget should be used for the text entry portion of the DropDown widget.

XmNvalue

The string displayed in the Text widget.

XmNverify

If this resource is true the DropDown widget will verify its value against the list  whenever it loses focus or the user types <Carriage Return>. If the verification  fails, an XtWarning is generated with a name of XmNtextVerifyFailed. To trap this  message register an XtWarningMsgHandler.

XmNverifyTextCallback

This routine is called whenever the Text widget's contents may need to be verified  against the popup shell's contents. If the customizedComboBox resource is False  then the DropDown widget has already performed the verification when this  routine is called.

XmNvisibleItemCount

The number of items visible in the popup list at one time.

The DropDown is composed of many sub-widgets. Most of the information  displayed to the user is set through these sub widgets. Most  values passed to this widget through the argument list at creation time or via set values  are passed to each of this widget's children. Get values requests must be made on a  child by child basis. The children of the DropDown are listed below. The  OSF/Motifdocumentation should be consulted for an exhaustive set of resources for each child. A partial list of the most common resources are listed here for convenience.

XmDropDown comboBox

XmLabel label

XmTextField text

XmArrowButton arrow

OverrideShell popupShell

XmScrolledWindow listSW

XmScrollBar ListvScrollBar

XmScrollBar ListhScrollBar

XmList list

The popup shell and its children are only created when  customizedCombinationBox is False.

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

None of the DropDown's callback procedures have any call data currently  defined for them. The widget passed to each of these functions is the DropDown widget.

void (Callback)(Widget cbw, XtPointer client_data, XtPointer unused)

cbw This is the widget identifier of the DropDown widget.

client_data The client data passed to this widget by the application programmer.

unused This value is undefined.

The DropDown widget lays out its children (the label, text and arrow) in a row.  The amount of space they are each allocated when the DropDown is not allowed  to be the exact size it desires is determined using the following rules:

1. The arrow is always given its requested size.

2. If the combo box is bigger than it wants to be all extra space is given to the text  widget.

3. If the combo box is smaller that is wants to be then the text and label widgets  are each sized smaller than they desire in exactly the same ratio.

For example:

If the amount of space for the label and text is 100 pixels and the label  wants to be 50 pixels wide and the text would like to be 100 pixels wide  then the label will get 34 pixels and the text 66.

The popup shell widget is sized such that the width of the scrolled list widget equals  the width of the text widget minus the value of the "popupOffset" resource. If the  popup shell resides in a customized combination box, however, it is allowed to be  whatever size the child of the popup shell would like to be.