XmRowColumn(library call) XmRowColumn(library call)
NAME [Toc] [Back]
XmRowColumn - The RowColumn widget class
SYNOPSIS [Toc] [Back]
#include <Xm/RowColumn.h>
DESCRIPTION [Toc] [Back]
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 menu panes, and OptionMenu. RowColumn uses
the XmQTmenuSavvy trait and holds the XmQTmenuSystem trait.
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.
The default XmNinsertPosition procedure for the RowColumn returns the
value of XmNpositionIndex if one has been specified for the child.
Otherwise, this procedure returns the number of children in the
RowColumn's XmNnumChildren list. In a MenuBar, Pulldown menu pane, or
Popup menu pane the default for the XmNshadowThickness resource is 2.
In an OptionMenu or a WorkArea, (such as a RadioBox or CheckBox) this
resource is not applicable and its use is undefined. If an
application wishes to place a 3-D shadow around an OptionMenu or
WorkArea, it can create the RowColumn as a child of a Frame widget.
In a MenuBar, Pulldown menu pane, or Popup menu pane the
XmNnavigationType resource is not applicable and its use is undefined.
In a WorkArea, the default for XmNnavigationType is XmTAB_GROUP. In
an OptionMenu the default for XmNnavigationType is XmNONE.
- 1 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
In a MenuBar, Pulldown menu pane, or Popup menu pane the
XmNtraversalOn resource is not applicable and its use is undefined.
In an OptionMenu or WorkArea, the default for XmNtraversalOn is True.
If the parent of the RowColumn is a MenuShell, the
XmNmappedWhenManaged resource is forced to False when the widget is
realized.
The user can specify resources in a resource file for the
automatically created widgets and gadgets of an OptionMenu. The
following list identifies the names of these widgets (or gadgets) and
the associated OptionMenu areas.
Option Menu Label Gadget
OptionLabel
Option Menu Cascade Button
OptionButton
For the Popup and Pulldown Menupanes, popup and pulldown menus have
particular behaviors when the <Btn1> button is pressed outside the
menus. These behaviors are summarized here.
When there is already a popped up menu, a user can either press <Btn1>
in the same area as the popped up menu, or can press <Btn1> in another
area that should have a menu popped up. When <Btn1> is pressed in the
same area as the already popped up menu, that menu is unposted. If
<Btn1> is pressed in a different area, the associated popup menu is
posted for the new area. Note, however, that if the
XmNpopupHandlerCallback of either XmManager or XmPrimitive is
available, then the callback may override these default behaviors.
For pulldown menus, a user can press <Btn1> on the Cascade button to
post the pulldown menu, then click on it again. Upon the second click,
the pulldown menu is unposted.
Popup menus are not allowed to have NULL parents.
Tear-off Menus [Toc] [Back]
Pulldown and Popup menu panes support tear-off menus, which enable the
user to retain a menu pane on the display to facilitate subsequent
menu selections. A menu pane that can be torn-off is identified by a
tear-off button that spans the width of the menu pane and displays a
dashed line. A torn-off menu pane contains a window manager system
menu icon and a title bar. The window title displays the label of the
cascade button that initiated the action when the label type is
XmSTRING. If the label contains a pixmap the window title is empty. A
tear-off menu from a Popup menu pane also displays an empty title.
Tear-off menus should not be shared.
- 2 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
The user can tear off a menu pane using the mouse or keyboard.
Clicking <Btn1> or pressing <osfActivate> (or <osfSelect>) on the
tear-off button, tears off the menu pane at the current position.
Pressing <Btn2> on the tear-off button tears off the menu pane and
allows the user to drag the torn-off menu to a new position designated
by releasing the mouse button. Tearing off a menu pane unposts the
current active menu. Only one tear-off copy for each menu pane is
allowed. Subsequent tear-off actions of a torn menu pane unpost the
existing copy first.
The name of the tear-off button of a torn-off menu pane is
TearOffControl. The name can be used to set resources in a resource
file. An application can also obtain the tear-off button itself using
XmGetTearOffControl and then set resource values by calling
XtSetValues.
The tear-off button has Separator-like behavior. Its appearance can be
specified with the following tear-off button resources: XmNbackground,
XmNbackgroundPixmap, XmNbottomShadowColor, XmNforeground, XmNheight,
XmNmargin, XmNseparatorType, XmNshadowThickness, and
XmNtopShadowColor. Refer to the XmSeparator reference page for a
complete description of each of these resources.
The XmNtearOffModel, XmNtearOffMenuActivateCallback, and
XmNtearOffMenuDeactivateCallback are RowColumn resources that affect
tear-off menu behavior. The XmNtearOffTitle resource enables the
application to specify the tear-off menu's title if the menu is torn
off.
By default, menus do not tear off. Setting the XmNtearOffModel
resource to XmTEAR_OFF_ENABLED enables tear-off functionality. There
is no resource converter preregistered for XmNtearOffModel. To allow
tear-off functionality to be enabled through the resource database,
call the function XmRepTypeInstallTearOffModelConverter.
Tear-off menu focus policy follows standard window manager policy. It
is recommended that the startupKeyFocus and autoKeyFocus mwm resources
be set to True.
Descendants [Toc] [Back]
RowColumn automatically creates the descendants shown in the following
table. An application can use XtNameToWidget to gain access to the
named descendant. In addition, a user or an application can use the
named descendant when specifying resource values.
- 3 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
_________________________________________________________________
|Named Descendant | Class | Identity |
|_________________|_________________________|____________________|
|_________________|_________________________|____________________|
|_________________|_________________________|____________________|
|OptionButton | XmCascadeButtonGadget | option menu button |
|_________________|_________________________|____________________|
|OptionLabel | XmLabelGadget | option menu label |
|_________________|_________________________|____________________|
|TearOffControl | subclass of XmPrimitive | tear-off button of |
| | | torn-off menu pane |
|_________________|_________________________|____________________|
|_________________|_________________________|____________________|
Classes [Toc] [Back]
RowColumn inherits behavior, resources, and traits from Core,
Composite, Constraint, and XmManager classes.
The class pointer is xmRowColumnWidgetClass.
The class name is XmRowColumn.
New Resources [Toc] [Back]
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).
- 4 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
____________________________________________________________________________________________________________
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 XmCCallback XtCallbackList NULL C
____________________________________________________________________________________________________________
XmNentryClass XmCEntryClass WidgetClass dynamic CSG
____________________________________________________________________________________________________________
XmNentryVerticalAlignment XmCVerticalAlignment unsigned char XmALIGNMENT_CENTER CSG
____________________________________________________________________________________________________________
XmNisAligned XmCIsAligned Boolean True CSG
____________________________________________________________________________________________________________
XmNisHomogeneous XmCIsHomogeneous Boolean dynamic CG
____________________________________________________________________________________________________________
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 XmFONTLIST_DEFAULT_TAG CSG
____________________________________________________________________________________________________________
XmNnumColumns XmCNumColumns short 1 CSG
____________________________________________________________________________________________________________
XmNorientation XmCOrientation unsigned char dynamic CSG
____________________________________________________________________________________________________________
XmNpacking XmCPacking unsigned char dynamic CSG
____________________________________________________________________________________________________________
XmNpopupEnabled XmCPopupEnabled int XmPOPUP_KEYBOARD CSG
____________________________________________________________________________________________________________
XmNradioAlwaysOne XmCRadioAlwaysOne Boolean True CSG
- 5 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
____________________________________________________________________________________________________________
|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 |
|_________________________________|______________________|________________|________________________|________|
|XmNtearOffMenuActivateCallback | XmCCallback | XtCallbackList | NULL | C |
|_________________________________|______________________|________________|________________________|________|
|XmNtearOffMenuDeactivateCallback | XmCCallback | XtCallbackList | NULL | C |
|_________________________________|______________________|________________|________________________|________|
|XmNtearOffModel | XmCTearOffModel | unsigned char | XmTEAR_OFF_DISABLED | CSG |
|_________________________________|______________________|________________|________________________|________|
|XmNtearOffTitle | XmCTearOffTitle | XmString | NULL | CSG |
|_________________________________|______________________|________________|________________________|________|
|XmNunmapCallback | XmCCallback | XtCallbackList | NULL | C |
|_________________________________|______________________|________________|________________________|________|
|XmNwhichButton | XmCWhichButton | unsigned int | dynamic | CSG |
|_________________________________|______________________|________________|________________________|________|
|_________________________________|______________________|________________|________________________|________|
XmNadjustLast [Toc] [Back]
Extends the last row of children to the bottom edge of
RowColumn (when XmNorientation is XmHORIZONTAL) or extends
the last column to the right edge of RowColumn (when
XmNorientation is XmVERTICAL). Setting XmNadjustLast to
False disables this feature.
XmNadjustMargin [Toc] [Back]
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.
- 6 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
This keeps all text within each row or column lined up with
all other text in its row or column. If XmNrowColumnType is
either XmMENU_POPUP or XmMENU_PULLDOWN and this resource is
True, only button children have their margins adjusted.
XmNentryAlignment [Toc] [Back]
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 (default)
+ XmALIGNMENT_CENTER
+ XmALIGNMENT_END
See the description of XmNalignment in the XmLabel(3)
reference page for an explanation of these actions.
XmNentryBorder [Toc] [Back]
Imposes a uniform border width upon all RowColumn's
children. The default value is 0 (zero), which disables the
feature.
XmNentryCallback [Toc] [Back]
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 [Toc] [Back]
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.
- 7 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
When XmCreateRadioBox is called or when XmNrowColumnType is
set to XmWORK_AREA and XmNradioBehavior is True, the default
value of XmNentryClass is xmToggleButtonGadgetClass. When
XmNrowColumnType is set to XmMENU_BAR, the value of
XmNentryClass is forced to xmCascadeButtonWidgetClass.
XmNentryVerticalAlignment [Toc] [Back]
Specifies the type of vertical alignment for children that
are subclasses of XmLabel, XmLabelGadget, and XmText. This
resource is invalid if XmNorientation is XmVERTICAL and
XmNpacking is XmPACK_TIGHT, because this layout preserves
variable heights among the children. The vertical alignment
types include:
XmALIGNMENT_BASELINE_BOTTOM [Toc] [Back]
Causes the bottom baseline of all children in a
row to be aligned. This resource is applicable
only when all children in a row contain textual
data.
XmALIGNMENT_BASELINE_TOP [Toc] [Back]
Causes the top baseline of all children in a row
to be aligned. This resource is applicable only
when all children in a row contain textual data.
XmALIGNMENT_CONTENTS_BOTTOM [Toc] [Back]
Causes the bottom of the contents (text or pixmap)
of all children in a row to be aligned.
XmALIGNMENT_CENTER [Toc] [Back]
Causes the center of all children in a row to be
aligned.
XmALIGNMENT_CONTENTS_TOP [Toc] [Back]
Causes the top of the contents (text or pixmap) of
all children in a row to be aligned.
XmNisAligned [Toc] [Back]
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 menu pane
or a Pulldown menu pane, alignment is not performed; the
Label is treated as the title within the menu pane, and the
alignment set by the application is not overridden.
XmNentryAlignment controls the type of textual alignment.
XmNisHomogeneous [Toc] [Back]
Indicates whether the RowColumn widget should enforce exact
homogeneity among the items it contains; if this resource is
set to True, only the widgets that are of the class
- 8 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
indicated by XmNentryClass are allowed as children of the
RowColumn widget. This is most often used when creating a
MenuBar. Attempting to insert a child that is not a member
of the specified class generates a warning message.
In a MenuBar, the value of XmNisHomogeneous is forced to
True. In an OptionMenu, the value is forced to False. When
XmCreateRadioBox is called the default value is True.
Otherwise, the default value is False.
XmNlabelString [Toc] [Back]
When XmNrowColumnType is set to XmMENU_OPTION, this resource
points to a text string that displays the label with respect
to the selection area. The positioning of the label relative
to the selection area depends on the layout direction in the
horizontal orientation. 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 [Toc] [Back]
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 [Toc] [Back]
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 (zero) for Pulldown and
Popup menu panes, and 3 pixels for other RowColumn types.
XmNmarginWidth [Toc] [Back]
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 (zero) for Pulldown and Popup
menu panes, and 3 pixels for other RowColumn types.
XmNmenuAccelerator [Toc] [Back]
This resource is useful only when the RowColumn widget has
been configured to operate as a Popup menu pane 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
menu pane, when the accelerator is typed by the user, the
Popup menu pane 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 menu pane is <osfMenu>.
- 9 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
The default for a MenuBar is <osfMenuBar>. Setting the
XmNpopupEnabled resource to False disables the accelerator.
XmNmenuHelpWidget [Toc] [Back]
Specifies the widget ID for the CascadeButton, which is
treated as the Help widget if XmNrowColumnType is set to
XmMENU_BAR. Which corner of the MenuBar the Help widget is
placed at depends on the XmNlayoutDirection resource of the
widget. If the RowColumn widget is any type other than
XmMENU_BAR, this resource is not meaningful.
XmNmenuHistory [Toc] [Back]
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 [Toc] [Back]
Specifies an X event description indicating a button 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 <Btn1> Press. The XmNmenuPost resource for
pulldowns should be consistent with that of the top-level
parent menu (although the event type is ignored). Setting
this resource to BTransfer Press will conflict with drag and
drop operations, which use BTransfer Press as a default
button binding. Therefore, this resource cannot be
BTransfer Press.
XmNmnemonic [Toc] [Back]
This resource is useful only when XmNrowColumnType is set to
XmMENU_OPTION. It specifies a keysym for a key that, when
pressed by the user along with the MAlt modifier, posts the
associated Pulldown menu pane. 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 [Toc] [Back]
Specifies the character set of the mnemonic for an
OptionMenu. The default is XmFONTLIST_DEFAULT_TAG. If the
- 10 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
RowColumn widget is any type other than XmMENU_OPTION, this
resource is not meaningful.
XmNnumColumns [Toc] [Back]
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 1. In an OptionMenu the value is
forced to 1. The value must be greater than 0 (zero).
XmNorientation [Toc] [Back]
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 within the widget. In a
row-major layout the children of the RowColumn are laid out
in rows. The direction of the horizontal layout in the rowmajor
layout (from left or right), and the wrapping in the
column-major layout (vertical), depend on the
XmNlayoutDirection resource of the widget. The XmVERTICAL
resource value selects a column-major layout. XmHORIZONTAL
selects a row-major layout.
When creating a MenuBar or an OptionMenu, the default is
XmHORIZONTAL. Otherwise, the default value is XmVERTICAL.
The results of specifying a value of XmVERTICAL for a
MenuBar are undefined.
XmNpacking [Toc] [Back]
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
- 11 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
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 boxes are 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.
When XmCreateRadioBox is called or when XmNrowColumnType is
set to XmWORK_AREA and XmNradioBehavior is True, the default
value of XmNpacking is XmPACK_COLUMN. In an OptionMenu the
value is initialized to XmPACK_TIGHT. Otherwise, the value
defaults to XmPACK_TIGHT.
XmNpopupEnabled [Toc] [Back]
Allows the menu system to enable keyboard input
(accelerators and mnemonics) defined for the Popup menu pane
and any of its submenus. The Popup menu pane needs to be
informed whenever its accessibility to the user changes
because posting of the Popup menu pane is controlled by the
application. This resource can take four values, including:
XmPOPUP_KEYBOARD [Toc] [Back]
Specifies that the keyboard input-accelerators and
mnemonics-defined for the Popup menu pane and any
of its submenus is enabled. This is the default.
XmPOPUP_DISABLED [Toc] [Back]
Specifies that the keyboard input is disabled.
XmPOPUP_AUTOMATIC [Toc] [Back]
Specifies that the keyboard is enabled for
automatic popup menus.
XmPOPUP_AUTOMATIC_RECURSIVE [Toc] [Back]
Specifies that the keyboard is enabled for
recursive automatic popup menus.
- 12 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
XmNradioAlwaysOne [Toc] [Back]
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 [Toc] [Back]
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, XmNindicatorType
defaults to XmONE_OF_MANY for ToggleButton and
ToggleButtonGadget children.
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 with
XmToggleButtonSetState or XmToggleButtonGadgetSetState with
a notify argument of True.
When XmCreateRadioBox is called, the default value of
XmNradioBehavior is True. Otherwise, the default value is
False.
XmNresizeHeight [Toc] [Back]
Requests a new height if necessary, when set to True. When
this resource is set to False, the widget does not request a
new height regardless of any changes to the widget or its
children.
XmNresizeWidth [Toc] [Back]
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.
- 13 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
XmNrowColumnType [Toc] [Back]
Specifies the type of RowColumn widget to be created. It is
a nonstandard 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 (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 [Toc] [Back]
Specifies the horizontal and vertical spacing between items
contained within the RowColumn widget. The default value is
3 pixels for XmOPTION_MENU and XmWORK_AREA and 0 (zero) for
other RowColumn types.
XmNsubMenuId [Toc] [Back]
Specifies the widget ID for the Pulldown menu pane to be
associated with an OptionMenu. This resource is useful only
when XmNrowColumnType is set to XmMENU_OPTION. The default
value is NULL.
XmNtearOffMenuActivateCallback [Toc] [Back]
Specifies the callback list that notifies the application
when the tear-off menu pane is about to be activated. It
precedes the tear-off's map callback.
Use this resource when your application has shared menu
panes and when the torn-off menu can have two or more
parents that can have opposing sensitivity states for the
- 14 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
same menu item. This resource enables the application to
track whether a menu item is sensitive or insensitive and to
set the state to the original parent's menu item state when
the torn-off menu is reposted. The application can use
XmGetPostedFromWidget to determine from which parent the
menu was torn. The callback reason is
XmCR_TEAR_OFF_ACTIVATE. The default is NULL.
XmNtearOffMenuDeactivateCallback [Toc] [Back]
Specifies the callback list that notifies the application
when the tear-off menu pane is about to be deactivated. It
follows the tear-off's unmap callback.
Use this resource when your application has shared menu
panes and when the torn-off menu can have two or more
parents that can have opposing sensitivity states for the
same menu item. This resource enables the application to
track whether a menu item is sensitive or insensitive and to
set the state to the original parent's menu item state when
the torn-off menu is reposted. The application can use
XmGetPostedFromWidget to determine from which parent the
menu was torn. The callback reason is
XmCR_TEAR_OFF_DEACTIVATE. The default is NULL.
XmNtearOffModel [Toc] [Back]
Indicates whether tear-off functionality is enabled or
disabled when XmNrowColumnType is set to XmMENU_PULLDOWN or
XmMENU_POPUP. The values are XmTEAR_OFF_ENABLED or
XmTEAR_OFF_DISABLED (default value). This resource is
invalid for type XmMENU_OPTION; however, it does affect any
pulldown submenus within an OptionMenu. The function
XmRepTypeInstallTearOffModelConverter installs a resource
converter for this resource.
XmNtearoffTitle [Toc] [Back]
Used by the TearOff shell to set the title for the window
manager to display.
XmNunmapCallback [Toc] [Back]
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 [Toc] [Back]
This resource is obsolete; it has been replaced by
XmNmenuPost and is present for compatibility with older
releases of Motif. This resource cannot be 2.
- 15 - Formatted: January 24, 2005
XmRowColumn(library call) XmRowColumn(library call)
________________________________________________________________________
| XmRowColumn Constraint Resource Set |
|Name Class Type Default Access |
|_________________|__________________|_______|_________________|________|
|XmNpositionIndex | XmCPositionIndex | short | XmLAST_POSITION | CSG |
|_________________|__________________|_______|_________________|________|
|_________________|__________________|_______|_________________|________|
XmNpositionIndex [Toc] [Back]
Specifies the position of the widget in its parent's list of
children (the value of the XmNchildren resource). The value
is an integer that is no less than 0 (zero) and no greater
than the number of children in the list at the time the
value is specified. A value of 0 (zero) means that the child
is placed at the beginning of the list. The value can also
be specified as XmLAST_POSITION (the default), which means
that the child is placed at the end of the list. Any other
value is ignored. XtGetValues returns the position of the
widget in its parent's child list at the time of the call to
XtGetValues.
When a widget is inserted into its parent's child list, the
positions of any existing children that are greater than or
equal to the specified widget's XmNpositionIndex are
increased by 1. The effect of a call to XtSetValues for
XmNpositionIndex is to remove the specified widget from its
parent's child list, decrease by 1 the positions of any
existing children that are greater than the specified
widget's former position in the list, and then insert the
specified widget into its parent's child list as described
|
