XmRowColumn(3X) — Subroutines
NAME
XmRowColumn — the RowColumn widget class.
SYNOPSIS
#include <Xm/RowColumn.h>
DESCRIPTION
The RowColumn widget is a general purpose RowColumn manager capable of containing any widget type as a child. In general, it requires no special knowledge about how its children function and provides nothing beyond support for several different layout styles. However, it can be configured as a menu, in which case, it expects only certain children, and it configures to a particular layout. The menus supported are: MenuBar, Pulldown or Popup MenuPanes, and OptionMenu.
The type of layout performed is controlled by how the application has set the various layout resources. It can be configured to lay out its children in either rows or columns. In addition, the application can specify how the children are laid out, as follows:
•the children are packed tightly together into either rows or columns
•each child is placed in an identically sized box (producing a symmetrical look)
•a specific layout (the current x and y positions of the children control their location)
In addition, the application has control over both the spacing that occurs between each row and column and the margin spacing present between the edges of the RowColumn widget and any children that are placed against it.
By default the RowColumn widget has no 3-D visuals associated with it; if an application wishes to have a 3-D shadow placed around this widget, it can create the RowColumn as a child of a Frame widget.
Classes
RowColumn inherits behavior and resources from Core, Composite, Constraint, and XmManager classes.
The class pointer is xmRowColumnWidgetClass.
The class name is XmRowColumn.
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 set at creation time (C), set by using XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A).
| XmRowColumn Resource Set | ||||
| Name | Class | Type | Default | Access |
| XmNadjustLast | XmCAdjustLast | Boolean | True | CSG |
| XmNadjustMargin | XmCAdjustMargin | Boolean | True | CSG |
| XmNentryAlignment | XmCAlignment | unsigned char | XmALIGNMENT_BEGINNING | CSG |
| XmNentryBorder | XmCEntryBorder | Dimension | 0 | CSG |
| XmNentryCallback | XtCCallback | XtCallbackList | NULL | C |
| XmNentryClass | XmCEntryClass | WidgetClass | dynamic | CSG |
| XmNisAligned | XmCIsAligned | Boolean | True | CSG |
| XmNisHomogeneous | XmCIsHomogeneous | Boolean | dynamic | CSG |
| XmNlabelString | XmCXmString | XmString | NULL | C |
| XmNmapCallback | XmCCallback | XtCallbackList | NULL | C |
| XmNmarginHeight | XmCMarginHeight | Dimension | dynamic | CSG |
| XmNmarginWidth | XmCMarginWidth | Dimension | dynamic | CSG |
| XmNmenuAccelerator | XmCAccelerators | String | dynamic | CSG |
| XmNmenuHelpWidget | XmCMenuWidget | Widget | NULL | CSG |
| XmNmenuHistory | XmCMenuWidget | Widget | NULL | CSG |
| XmNmenuPost | XmCMenuPost | String | NULL | CSG |
| XmNmnemonic | XmCMnemonic | KeySym | NULL | CSG |
| XmNmnemonicCharSet | XmCMnemonicCharSet | String | dynamic | CSG |
| XmNnumColumns | XmCNumColumns | short | 1 | CSG |
| XmNorientation | XmCOrientation | unsigned char | dynamic | CSG |
| XmNpacking | XmCPacking | unsigned char | dynamic | CSG |
| XmNpopupEnabled | XmCPopupEnabled | Boolean | True | CSG |
| XmNradioAlwaysOne | XmCRadioAlwaysOne | Boolean | True | CSG |
| XmNradioBehavior | XmCRadioBehavior | Boolean | False | CSG |
| XmNresizeHeight | XmCResizeHeight | Boolean | True | CSG |
| XmNresizeWidth | XmCResizeWidth | Boolean | True | CSG |
| XmNrowColumnType | XmCRowColumnType | unsigned char | XmWORK_AREA | CG |
| XmNspacing | XmCSpacing | Dimension | dynamic | CSG |
| XmNsubMenuId | XmCMenuWidget | Widget | NULL | CSG |
| XmNunmapCallback | XmCCallback | XtCallbackList | NULL | C |
| XmNwhichButton | XmCWhichButton | unsigned int | dynamic | CSG |
XmNadjustLast
Extends the last row of children to the bottom edge of RowColumn (when XmOrientation is XmHORIZONTAL) or extends the last column to the right edge of RowColumn (when XmOrientation is XmVERTICAL). This feature is disabled by setting XmNadjustLast to False.
XmNadjustMargin
Specifies whether the inner minor margins of all items contained within the RowColumn widget are forced to the same value. The inner minor margin corresponds to the XmNmarginLeft, XmNmarginRight, XmNmarginTop, and XmNmarginBottom resources supported by XmLabel and XmLabelGadget.
A horizontal orientation causes XmNmarginTop and XmNmarginBottom for all items in a particular row to be forced to the same value; the value is the largest margin specified for one of the Label items.
A vertical orientation causes XmNmarginLeft and XmNmarginRight for all items in a particular column to be forced to the same value; the value is the largest margin specified for one of the Label items.
This keeps all text within each row or column lined up with all other text in its row or column. If the XmNrowColumnType is either XmMENU_POPUP or XmMENU_PULLDOWN and this resource is True, only button children have their margins adjusted.
XmNentryAlignment
Specifies the alignment type for children that are subclasses of XmLabel or XmLabelGadget when XmNisAligned is enabled. The following are textual alignment types:
XmALIGNMENT_BEGINNING — the default
XmALIGNMENT_CENTER
XmALIGNMENT_END
See the description of XmNalignment in the XmLabel(3X) man page for an explanation of these actions.
XmNentryBorder
Imposes a uniform border width upon all RowColumn’s children. The default value is 0, which disables the feature.
XmNentryCallback
Disables the XmNactivateCallback and XmNvalueChangedCallback callbacks for all CascadeButton, DrawnButton, PushButton, and ToggleButton widgets and gadgets contained within the RowColumn widget. If the application supplies this resource, the XmNactivateCallback and XmNvalueChangedCallback callbacks are then revectored to the XmNentryCallback callbacks. This allows an application to supply a single callback routine for handling all items contained in a RowColumn widget. The callback reason is XmCR_ACTIVATE. If the application does not supply this resource, the XmNactivateCallback and XmNvalueChangedCallback callbacks for each item in the RowColumn widget work as normal.
The application must supply this resource when this widget is created. Changing this resource using the XtSetValues is not supported.
XmNentryClass
Specifies the only widget class that can be added to the RowColumn widget; this resource is meaningful only when the XmNisHomogeneous resource is set to True. Both widget and gadget variants of the specified class may be added to the widget.
When XmNrowColumnType is set to XmWORK_AREA and XmNradioBehavior is True, the default value for XmNentryClass is xmToggleButtonGadgetClass. When XmNrowColumnType is set to XmMENU_BAR, the value of XmNentryClass is forced to xmCascadeButtonWidgetClass.
XmNisAligned
Specifies text alignment for each item within the RowColumn widget; this applies only to items that are subclasses of XmLabel or XmLabelGadget. However, if the item is a Label widget or gadget and its parent is either a Popup MenuPane or a Pulldown MenuPane, alignment is not performed; the Label is treated as the title within the MenuPane, and the alignment set by the application is not overridden. XmNentryAlignment controls the type of textual alignment.
XmNisHomogeneous
Indicates if the RowColumn widget should enforce exact homogeneity among the items it contains; if True, only the widgets that are of the class indicated by XmNentryClass are allowed as children of the RowColumn widget. This is most often used when creating a MenuBar or a RadioBox widget.
Attempting to insert a child that is not a member of the specified class generates a warning message. The default value is False, except when creating a MenuBar or a RadioBox, when the default is True.
XmNlabelString
Points to a text string, which displays the label to one side of the selection area when XmNrowColumnType is set to XmMENU_OPTION. This resource is not meaningful for all other RowColumn types. If the application wishes to change the label after creation, it must get the LabelGadget ID (XmOptionLabelGadget) and call XtSetValues on the LabelGadget directly. The default value is no label.
XmNmapCallback
Specifies a widget-specific callback function that is invoked when the window associated with the RowColumn widget is about to be mapped. The callback reason is XmCR_MAP.
XmNmarginHeight
Specifies the amount of blank space between the top edge of the RowColumn widget and the first item in each column, and the bottom edge of the RowColumn widget and the last item in each column. The default value is 0 for Pulldown and Popup MenuPanes, and three pixels for other RowColumn types.
XmNmarginWidth
Specifies the amount of blank space between the left edge of the RowColumn widget and the first item in each row, and the right edge of the RowColumn widget and the last item in each row. The default value is 0 for Pulldown and Popup MenuPanes, and three pixels for other RowColumn types.
XmNmenuAccelerator
This resource is useful only when the RowColumn widget has been configured to operate as a Popup MenuPane or a MenuBar. The format of this resource is similar to the left side specification of a translation string, with the limitation that it must specify a key event. For a Popup MenuPane, when the accelerator is typed by the user, the Popup MenuPane is posted. For a MenuBar, when the accelerator is typed by the user, the first item in the MenuBar is highlighted, and traversal is enabled in the MenuBar. The default for a Popup MenuPane is KMenu. The default for a MenuBar is KMenuBar. The accelerator can be disabled by setting the XmNpopupEnabled resource to False.
XmNmenuHelpWidget
Specifies the widget ID for the CascadeButton, which is treated as the Help widget if XmNrowColumnType is set to XmMENU_BAR. The MenuBar always places the Help widget at a lower corner of the menu. If the RowColumn widget is any type other than XmMENU_BAR, this resource is not meaningful.
XmNmenuHistory
Specifies the widget ID of the last menu entry to be activated. It is also useful for specifying the current selection for an OptionMenu. If XmNrowColumnType is set to XmMENU_OPTION, the specified menu item is positioned under the cursor when the menu is displayed.
If the RowColumn widget has the XmNradioBehavior resource set to True, the widget field associated with this resource contains the widget ID of the last ToggleButton or ToggleButtonGadget to change from unselected to selected. The default value is the widget ID of the first child in the widget.
XmNmenuPost
Specifies an X event description indicating an event that posts a menu system. The default for XmMENU_POPUP is BMenu Press. The default for XmMENU_OPTION, XmMENU_BAR, and XmWORK_AREA is BSelect Press. This resource is not useful for RowColumn widgets of type XmMENU_PULLDOWN.
XmNmnemonic
This resource is useful only when XmNrowColumnType is set to XmMENU_OPTION. Specifies a keysym for a key that, when pressed by the user along with the MAlt modifier, posts the associated Pulldown MenuPane. The first character in the OptionMenu label string that exactly matches the mnemonic in the character set specified in XmNmnemonicCharSet is underlined. The user can post the menu by pressing either the shifted or the unshifted mnemonic key. The default is no mnemonic.
XmNmnemonicCharSet
Specifies the character set of the mnemonic for an OptionMenu. The default is determined dynamically depending on the current language environment.
XmNnumColumns
Specifies the number of minor dimension extensions that are made to accommodate the entries; this attribute is meaningful only when XmNpacking is set to XmPACK_COLUMN.
For vertically-oriented RowColumn widgets, this attribute indicates how many columns are built; the number of entries per column is adjusted to maintain this number of columns, if possible.
For horizontally-oriented RowColumn widgets, this attribute indicates how many rows are built.
The default value is one.
XmNorientation
Determines whether RowColumn layouts are row-major or column-major. In a column-major layout, the children of the RowColumn are laid out in columns top to bottom within the widget. In a row-major layout the children of the RowColumn are laid out in rows. XmVERTICAL resource value selects a column-major layout. XmHORIZONTAL resource value selects a row-major layout.
The default value is XmVERTICAL, except when creating a MenuBar, when the default is XmHORIZONTAL.
XmNpacking
Specifies how to pack the items contained within a RowColumn widget. This can be set to XmPACK_TIGHT, XmPACK_COLUMN or XmPACK_NONE. When a RowColumn widget packs the items it contains, it determines its major dimension using the value of the XmNorientation resource.
XmPACK_TIGHT indicates that given the current major dimension (for example, vertical if XmNorientation is XmVERTICAL), entries are placed one after the other until the RowColumn widget must wrap. RowColumn wraps when there is no room left for a complete child in that dimension. Wrapping occurs by beginning a new row or column in the next available space. Wrapping continues, as often as necessary, until all of the children are laid out. In the vertical dimension (columns), boxes are set to the same width; in the horizontal dimension (rows), boxes are set to the same depth. Each entry’s position in the major dimension is left unaltered (for example, XmNy is left unchanged when XmNorientation is XmVERTICAL); its position in the minor dimension is set to the same value as the greatest entry in that particular row or column. The position in the minor dimension of any particular row or column is independent of all other rows or columns.
XmPACK_COLUMN indicates that all entries are placed in identically sized boxes. The box is based on the largest height and width values of all the children widgets. The value of the XmNnumColumns resource determines how many boxes are placed in the major dimension, before extending in the minor dimension.
XmPACK_NONE indicates that no packing is performed. The x and y attributes of each entry are left alone, and the RowColumn widget attempts to become large enough to enclose all entries.
The default value is XmPACK_TIGHT except when building an OptionMenu or a RadioBox, when the default is XmPACK_COLUMN.
XmNpopupEnabled
Allows the menu system to enable keyboard input (accelerators and mnemonics) defined for the Popup MenuPane and any of its submenus. The Popup MenuPane needs to be informed whenever its accessibility to the user changes because posting of the Popup MenuPane is controlled by the application. The default value for this resource is True (keyboard input − accelerators and mnemonics − defined for the Popup MenuPane and any of its submenus is enabled).
XmNradioAlwaysOne
If True, forces the active ToggleButton or ToggleButtonGadget to be automatically selected after having been unselected (if no other toggle was activated). If False, the active toggle may be unselected. The default value is True. This resource is important only when XmNradioBehavior is True.
The application can always add and subtract toggles from RowColumn regardless of the selected/unselected state of the toggle. The application can also manage and unmanage toggle children of RowColumn at any time regardless of state. Therefore, the application can sometimes create a RowColumn that has XmNradioAlwaysOne set to True and none of the toggle children selected. The result is undefined if the value of this resource is True and the application sets more than one ToggleButton at a time.
XmNradioBehavior
Specifies a Boolean value that when True, indicates that the RowColumn widget should enforce a RadioBox-type behavior on all of its children that are ToggleButtons or ToggleButtonGadgets.
When the value of this resource is True, the defaults for two resources for ToggleButton and ToggleButtonGadget children change: XmNindicatorType defaults to XmONE_OF_MANY and XmNvisibleWhenOff defaults to True.
RadioBox behavior dictates that when one toggle is selected and the user selects another toggle, the first toggle is unselected automatically. The RowColumn usually does not enforce this behavior if the application, rather than the user, changes the state of a toggle. The RowColumn does enforce this behavior if a toggle child is selected using XmToggleButtonSetState or XmToggleButtonGadgetSetState with a notify argument of True.
The default value is False, except that XmCreateRadioBox sets it to true.
XmNresizeHeight
Requests a new height if necessary, when set to True. When set to False, the widget does not request a new height regardless of any changes to the widget or its children.
XmNresizeWidth
Requests a new width if necessary, when set to True. When set to False, the widget does not request a new width regardless of any changes to the widget or its children.
XmNrowColumnType
Specifies the type of RowColumn widget to be created. It is a non-standard resource that cannot be changed after it is set. If an application uses any of the convenience routines, except XmCreateRowColumn, this resource is automatically forced to the appropriate value by the convenience routine. If an application uses the Xt Intrinsics API to create its RowColumn widgets, it must specify this resource itself. The set of possible settings for this resource are:
XmWORK_AREA — the default
XmMENU_BAR
XmMENU_PULLDOWN
XmMENU_POPUP
XmMENU_OPTION
This resource cannot be changed after the RowColumn widget is created. Any changes attempted through XtSetValues are ignored.
The value of this resource is used to determine the value of a number of other resources. The descriptions of RowColumn resources explain this when it is the case. The resource XmNnavigationType, inherited from XmManager, is changed to XmNONE if XmNrowColumnType is XmMENU_OPTION.
XmNspacing
Specifies the horizontal and vertical spacing between items contained within the RowColumn widget. The default value is three pixels for XmOPTION_MENU and XmWORK_AREA and 0 for other RowColumn types.
XmNsubMenuId
Specifies the widget ID for the Pulldown MenuPane to be associated with an OptionMenu. This resource is useful only when XmNrowColumnType is set to XmMENU_OPTION. The default value is NULL.
XmNunmapCallback
Specifies a list of callbacks that is called after the window associated with the RowColumn widget has been unmapped. The callback reason is XmCR_UNMAP. The default value is NULL.
XmNwhichButton
Specifies the mouse button to which a menu system is sensitive. The default for XmMENU_POPUP is BMenu. The default for XmMENU_OPTION, XmMENU_BAR, and XmWORK_AREA is BSelect. This resource is not useful for RowColumn widgets of type XmMENU_PULLDOWN. This resource is obsolete; it has been replaced by XmNmenuPost and is present for compatibility with older releases of OSF/Motif.
| Simple Menu Creation Resource Set | ||||
| Name | Class | Type | Default | Access |
| XmNbuttonAccelerators | XmCButtonAccelerators | StringTable | NULL | C |
| XmNbuttonAcceleratorText | XmCButtonAcceleratorText | XmStringTable | NULL | C |
| XmNbuttonCount | XmCButtonCount | int | 0 | C |
| XmNbuttonMnemonicCharSets | XmCButtonMnemonicCharSets | XmStringCharSetTable | NULL | C |
| XmNbuttonMnemonics | XmCButtonMnemonics | XmKeySymTable | NULL | C |
| XmNbuttons | XmCButtons | XmStringTable | NULL | C |
| XmNbuttonSet | XmCButtonSet | int | −1 | C |
| XmNbuttonType | XmCButtonType | XmButtonTypeTable | NULL | C |
| XmNoptionLabel | XmCOptionLabel | XmString | NULL | C |
| XmNoptionMnemonic | XmCOptionMnemonic | KeySym | NULL | C |
| XmNpostFromButton | XmCPostFromButton | int | −1 | C |
| XmNsimpleCallback | XmCCallback | XtCallbackProc | NULL | C |
XmNbuttonAccelerators
This resource is for use with the simple menu creation routines. It specifies a list of accelerators for the buttons created. The list contains one element for each button, separator, and title created.
XmNbuttonAcceleratorText
This resource is for use with the simple menu creation routines. It specifies a list of compound strings to display for the accelerators for the buttons created. The list contains one element for each button, separator, and title created.
XmNbuttonCount
This resource is for use with the simple menu creation routines. It specifies the total number of menu buttons, separators, and titles to create.
XmNbuttonMnemonicCharSets
This resource is for use with the simple menu creation routines. It specifies a list of character sets with which button mnemonics are to be displayed. The list contains one element for each button, separator, and title created. The default is determined dynamically depending on the locale of the widget.
XmNbuttonMnemonics
This resource is for use with the simple menu creation routines. It specifies a list of mnemonics for the buttons created. The list contains one element for each button, separator, and title created.
XmNbuttons
This resource is for use with the simple menu creation routines. It specifies a list of compound strings to use as labels for the buttons created. The list contains one element for each button, separator, and title created.
XmNbuttonSet
This resource is for use with the simple menu creation routines. It specifies which button of a RadioBox or OptionMenu Pulldown submenu is initially set. The value is an integer n indicating the nth ToggleButtonGadget specified for a RadioBox or the nth PushButtonGadget specified for an OptionMenu Pulldown submenu. The first button specified is number 0.
XmNbuttonType
This resource is for use with the simple menu creation routines. It specifies a list of button types associated with the buttons to be created. The list contains one element for each button, separator, and title created. If this resource is not specified, each button in a MenuBar is a CascadeButtonGadget; each button in any other type of RowColumn widget is a PushButtonGadget. Each button type is of type XmButtonType, an enumeration with the following possible values:
XmCASCADEBUTTON − Specifies a CascadeButtonGadget for a MenuBar, Popup MenuPane, Pulldown MenuPane, or OptionMenu Pulldown submenu.
XmCHECKBUTTON − Specifies a ToggleButtonGadget for a CheckBox, Popup MenuPane, or Pulldown MenuPane.
XmDOUBLE_SEPARATOR − Specifies a SeparatorGadget for a Popup MenuPane, Pulldown MenuPane, or OptionMenu Pulldown submenu. The separator type is XmDOUBLE_LINE.
XmPUSHBUTTON − Specifies a PushButtonGadget for a Popup MenuPane, Pulldown MenuPane, or OptionMenu Pulldown submenu.
XmRADIOBUTTON − Specifies a ToggleButtonGadget for a RadioBox, Popup MenuPane, or Pulldown MenuPane.
XmSEPARATOR − Specifies a SeparatorGadget for a Popup MenuPane, Pulldown MenuPane, or OptionMenu Pulldown submenu.
XmTITLE − Specifies a LabelGadget used as a title for a Popup MenuPane or Pulldown MenuPane.
XmNoptionLabel
This resource is for use with the simple menu creation routines. It specifies a compound string for the label string to be used on the left side of an OptionMenu.
XmNoptionMnemonic
This resource is for use with the simple menu creation routines. It specifies a keysym for a key that, when pressed by the user along with the MAlt modifier, posts the associated Pulldown MenuPane for an OptionMenu.
XmNpostFromButton
This resource is for use with the simple menu creation routines. For a Pulldown MenuPane, it specifies the button in the parent to which the submenu is attached. The menu is then posted from this button. The value is an integer n indicating the nth CascadeButton or CascadeButtonGadget specified for the parent of the Pulldown MenuPane. The first button specified is number 0.
XmNsimpleCallback
This resource is for use with the simple menu creation routines. It specifies a callback procedure to be called when a button is activated or when its value changes. This callback function is added to each button after creation. For a CascadeButtonGadget or a PushButtonGadget, the callback is added as the button’s XmNactivateCallback, and it is called when the button is activated. For a ToggleButtonGadget, the callback is added as the button’s XmNvalueChangedCallback, and it is called when the button’s value changes. The button number is passed in the client_data field.
| Display Resource | ||||
| Name | Class | Type | Default | Access |
| XmNmenuCursor | XmCCursor | String | arrow | C |
XmNmenuCursor
Sets a variable that controls the cursor used whenever this application posts a menu. This resource can be specified only once at application startup time, either by placing it within a defaults file or by using the −xrm command line argument.
Example: myProg −xrm "∗menuCursor: arrow"
The menu cursor can also be selected programmatically by using the function XmSetMenuCursor. The following is a list of acceptable cursor names. If the application does not specify a cursor or if an invalid name is supplied, the default cursor (an arrow pointing up and to the right) is used.
| X_cursor | dotbox | man | sizing |
| arrow | double_arrow | middlebutton | spider |
| based_arrow_down | draft_large | mouse | spraycan |
| based_arrow_up | draft_small | pencil | star |
| boat | draped_box | pirate | target |
| bogosity | exchange | plus | tcross |
| bottom_left_corner | fleur | question_arrow | top_left_arrow |
| bottom_right_corner | gobbler | right_ptr | top_left_corner |
| bottom_side | gumby | right_side | top_right_corner |
| bottom_tee | hand1 | right_tee | top_side |
| box_spiral | hand2 | rightbutton | top_tee |
| center_ptr | heart | rtl_logo | trek |
| circle | icon | sailboat | ul_angle |
| clock | iron_cross | sb_down_arrow | umbrella |
| coffee_mug | left_ptr | sb_h_double_arrow | ur_angle |
| cross | left_side | sb_left_arrow | watch |
| cross_reverse | left_tee | sb_right_arrow | xterm |
| crosshair | leftbutton | sb_up_arrow | |
| diamond_cross | ll_angle | sb_v_double_arrow | |
| dot | lr_angle | shuttle |
Inherited Resources
RowColumn inherits behavior and resources from the following named superclasses. For a complete description of each resource, refer to the man page for that superclass.
| XmManager Resource Set | ||||
| Name | Class | Type | Default | Access |
| XmNbottomShadowColor | XmCBottomShadowColor | Pixel | dynamic | CSG |
| XmNbottomShadowPixmap | XmCBottomShadowPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG |
| XmNforeground | XmCForeground | Pixel | dynamic | CSG |
| XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
| XmNhighlightColor | XmCHighlightColor | Pixel | dynamic | CSG |
| XmNhighlightPixmap | XmCHighlightPixmap | Pixmap | dynamic | CSG |
| XmNnavigationType | XmCNavigationType | XmNavigationType | dynamic | CSG |
| XmNshadowThickness | XmCShadowThickness | Dimension | 0 | CSG |
| XmNstringDirection | XmCStringDirection | XmStringDirection | dynamic | CG |
| XmNtopShadowColor | XmCBackgroundTopShadowColor | Pixel | dynamic | CSG |
| XmNtopShadowPixmap | XmCTopShadowPixmap | Pixmap | dynamic | CSG |
| XmNtraversalOn | XmCTraversalOn | Boolean | True | CSG |
| XmNunitType | XmCUnitType | unsigned char | dynamic | CSG |
| XmNuserData | XmCUserData | Pointer | NULL | CSG |
| Composite Resource Set | ||||
| Name | Class | Type | Default | Access |
| XmNchildren | XmCReadOnly | WidgetList | NULL | G |
| XmNinsertPosition | XmCInsertPosition | (∗)() | NULL | CSG |
| XmNnumChildren | XmCReadOnly | Cardinal | 0 | G |
| Core Resource Set | ||||
| Name | Class | Type | Default | Access |
| XmNaccelerators | XmCAccelerators | XtAccelerators | NULL | CSG |
| XmNancestorSensitive | XmCSensitive | Boolean | dynamic | G |
| XmNbackground | XmCBackground | Pixel | dynamic | CSG |
| XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG |
| XmNborderColor | XmCBorderColor | Pixel | XtDefaultForeground | CSG |
| XmNborderPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP | CSG |
| XmNborderWidth | XmCBorderWidth | Dimension | 0 | CSG |
| XmNcolormap | XmCColormap | Colormap | dynamic | CG |
| XmNdepth | XmCDepth | int | dynamic | CG |
| XmNdestroyCallback | XmCCallback | XtCallbackList | NULL | C |
| XmNheight | XmCHeight | Dimension | dynamic | CSG |
| XmNinitialResourcesPersistent | XmCInitialResourcesPersistent | Boolean | True | CG |
| XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
| XmNscreen | XmCScreen | Screen ∗ | dynamic | CG |
| XmNsensitive | XmCSensitive | Boolean | True | CSG |
| XmNtranslations | XmCTranslations | XtTranslations | NULL | CSG |
| XmNwidth | XmCWidth | Dimension | dynamic | CSG |
| XmNx | XmCPosition | Position | 0 | CSG |
| XmNy | XmCPosition | Position | 0 | CSG |
Callback Information
A pointer to the following structure is passed to each callback:
typedef struct
{
intreason;
XEvent∗ event;
Widgetwidget;
char∗ data;
char∗ callbackstruct;
} XmRowColumnCallbackStruct;
reasonIndicates why the callback was invoked
eventPoints to the XEvent that triggered the callback
The following fields apply only when the callback reason is XmCR_ACTIVATE; for all other callback reasons, these fields are set to NULL. The XmCR_ACTIVATE callback reason is generated only when the application has supplied an entry callback, which overrides any activation callbacks registered with the individual RowColumn items.
widgetIs set to the widget ID of the RowColumn item that has been activated
dataContains the client-data value supplied by the application when the RowColumn item’s activation callback was registered
callbackstructPoints to the callback structure generated by the RowColumn item’s activation callback
Translations
XmRowColumn translations depend on the value of the XmNrowColumnType resource.
If XmNrowColumnType is set to XmWORK_AREA, XmRowColumn inherits traversal translations from XmManager.
If XmNrowColumnType is set to XmMENU_OPTION, XmRowColumn inherits traversal translations from XmManager and has the additional translations listed below. These translations may not directly correspond to a translation table.
BSelect Press:MenuBtnDown()
BSelect Release:MenuBtnUp()
KActivate:ManagerGadgetSelect()
KSelect:ManagerGadgetSelect()
KHelp:Help()
The translations for XmRowColumn if XmNrowColumnType is set to XmMENU_BAR XmMENU_PULLDOWN, or XmMENU_POPUP are listed below. In a Popup menu system, BMenu also performs the BSelect actions. These translations may not directly correspond to a translation table.
BSelect Press:MenuBtnDown()
BSelect Release:MenuBtnUp()
KActivate:ManagerGadgetSelect()
KSelect:ManagerGadgetSelect()
MAny KCancel:MenuGadgetEscape()
KHelp:Help()
KLeft:MenuGadgetTraverseLeft()
KRight:MenuGadgetTraverseRight()
KUp:MenuGadgetTraverseUp()
KDown:MenuGadgetTraverseDown()
Action Routines
The XmRowColumn action routines are described below:
Help():
Calls the callbacks for XmNhelpCallback if any exist. If there are no help callbacks for this widget, this action calls the help callbacks for the nearest ancestor that has them.
ManagerGadgetSelect():
When a gadget child of the menu has the focus, invokes the gadget child’s behavior associated with KActivate or KSelect. This generally has the effect of unposting the menu hierarchy and arming and activating the gadget, except that for a CascadeButtonGadget with a submenu, it posts the submenu.
MenuBtnDown():
When a gadget child of the menu has the focus, invokes the gadget child’s behavior associated with BSelect Press. This generally has the effect of unposting any menus posted by the parent menu, enabling mouse traversal in the menu, and arming the gadget. For a CascadeButtonGadget with a submenu, it also posts the associated submenu.
MenuBtnUp():
When a gadget child of the menu has the focus, invokes the gadget child’s behavior associated with BSelect Release. This generally has the effect of unposting the menu hierarchy and activating the gadget, except that for a CascadeButtonGadget with a submenu, it posts the submenu and enables keyboard traversal in the menu.
MenuGadgetEscape():
In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, disarms the MenuBar CascadeButton and the MenuBar, and, when the shell’s keyboard focus policy is XmEXPLICIT, restores keyboard focus to the tab group that had the focus before the MenuBar was entered. In other Pulldown MenuPanes, unposts the menu.
In a Popup MenuPane, unposts the menu and, when the shell’s keyboard focus policy is XmEXPLICIT, restores keyboard focus to the widget from which the menu was posted.
MenuGadgetTraverseDown():
In a vertical menu, disarms the current menu entry and arms the entry just below it in the MenuPane. This action wraps within the MenuPane.
In a horizontal menu, if the menu entry is a CascadeButton with a submenu, posts the MenuPane associated with the CascadeButton. Otherwise, this action searches for an ancestor menu that is vertical. If it finds one, it unposts the cascade from the vertical menu and traverses to the next entry toward the bottom in the vertical menu. If this entry is a CascadeButton with a submenu, posts the MenuPane associated with the Cascadeutton. This action wraps within the vertical menu.
MenuGadgetTraverseLeft():
In a vertical menu, if the menu’s parent is a horizontal menu, this action unposts the current MenuPane and traverses to the next entry to the left in the parent menu. If this entry is a CascadeButton with a submenu, posts the MenuPane associated with the CascadeButton. This action wraps within the horizontal menu. If the menu’s parent is a vertical menu, this action unposts the current MenuPane.
In a horizontal menu, disarms the current menu entry and arms the entry just to the left of it in the menu. This action wraps within the menu.
MenuGadgetTraverseRight():
In a vertical menu, if the menu entry is a CascadeButton with a submenu, posts the MenuPane associated with the CascadeButton. Otherwise, this action searches for an ancestor menu that is horizontal. If it finds one, it unposts the cascade from the horizontal menu and traverses to the next entry to the right in the horizontal menu. If this entry is a CascadeButton with a submenu, posts the MenuPane associated with the CascadeButton. This action wraps within the horizontal menu.
In a horizontal menu, disarms the current menu entry and arms the entry just to the right of it in the menu. This action wraps within the menu.
MenuGadgetTraverseUp():
In a vertical menu, disarms the current menu entry and arms the entry just above it in the MenuPane. This action wraps within the MenuPane.
In a horizontal menu, if the menu’s parent is a vertical menu, this action unposts the current MenuPane and traverses to the next entry toward the top in the parent menu. If this entry is a CascadeButton with a submenu, posts the MenuPane associated with the CascadeButton. This action wraps within the vertical menu. If the menu’s parent is a horizontal menu, this action unposts the current MenuPane.
Related Behavior
The following menu functions are available.
KMenuBar:
In any non-popup descendant of a MenuBar’s parent, excluding the MenuBar itself, this action enables keyboard traversal and moves keyboard focus to the first item in the MenuBar. In the MenuBar or any menu cascaded from it, this action unposts the menu hierarchy and, when the shell’s keyboard focus policy is XmEXPLICIT, restores focus to the tab group that had the focus when the menu system was entered.
KMenu:
Pops up the menu associated with the control that has the keyboard focus. Enables keyboard traversal in the menu. In the Popup menu system or any menu cascaded from it, this action unposts the menu hierarchy and, when the shell’s keyboard focus policy is XmEXPLICIT, restores focus to the tab group that had the focus when the menu system was entered.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information about bindings for virtual buttons and keys, see VirtualBindings(3X).
RELATED INFORMATION
Composite(3X), Constraint(3X), Core(3X), XmCreateMenuBar(3X), XmCreateOptionMenu(3X), XmCreatePopupMenu(3X), XmCreatePulldownMenu(3X), XmCreateRadioBox(3X), XmCreateRowColumn(3X), XmCreateSimpleCheckBox(3X), XmCreateSimpleMenuBar(3X), XmCreateSimpleOptionMenu(3X), XmCreateSimplePopupMenu(3X), XmCreateSimplePulldownMenu(3X), XmCreateSimpleRadioBox(3X), XmCreateWorkArea(3X), XmGetMenuCursor(3X), XmGetPostedFromWidget(3X), XmLabel(3X), XmManager(3X), XmMenuPosition(3X), XmOptionButtonGadget(3X), XmOptionLabelGadget(3X), XmSetMenuCursor(3X), XmUpdateDisplay(3X), XmVaCreateSimpleCheckBox(3X), XmVaCreateSimpleMenuBar(3X), XmVaCreateSimpleOptionMenu(3X), XmVaCreateSimplePopupMenu(3X), XmVaCreateSimplePulldownMenu(3X), and XmVaCreateSimpleRadioBox(3X).