XmMenuShell(library call) XmMenuShell(library call)
NAME [Toc] [Back]
XmMenuShell - The MenuShell widget class
SYNOPSIS [Toc] [Back]
#include <Xm/MenuShell.h>
DESCRIPTION [Toc] [Back]
The MenuShell widget is a custom OverrideShell widget. An
OverrideShell widget bypasses mwm when displaying itself. It is
designed specifically to contain Popup or Pulldown menu panes.
Most application writers never encounter this widget if they use the
menu-system convenience functions, XmCreatePopupMenu or
XmCreatePulldown Menu, to create a Popup or Pulldown menu pane. The
convenience functions automatically create a MenuShell widget as the
parent of the menu pane. However, if the convenience functions are not
used, the application programmer must create the required MenuShell.
In this case, it is important to note that the parent of the MenuShell
depends on the type of menu system being built.
+ If the MenuShell is for the top-level Popup menu pane, the
MenuShell's parent must be the widget from which the Popup menu
pane is popped up.
+ If the MenuShell is for a menu pane that is pulled down from a
Popup or another Pulldown menu pane, the MenuShell's parent must
be the Popup or Pulldown menu pane.
+ If the MenuShell is for a menu pane that is pulled down from a
MenuBar, the MenuShell's parent must be the MenuBar.
+ If the MenuShell is for a Pulldown menu pane in an OptionMenu,
the MenuShell's parent must be the OptionMenu's parent.
Setting XmNheight, XmNwidth, or XmNborderWidth for either a MenuShell
or its child sets that resource to the same value in both the parent
and the child. An application should always specify these resources
for the child, not the parent.
For the managed child of a MenuShell, regardless of the value of the
shell's XmNallowShellResize, setting XmNx or XmNy sets the
corresponding resource of the parent but does not change the child's
position relative to the parent. XtGetValues for the child's XmNx or
XmNy yields the value of the corresponding resource in the parent.
The x and y-coordinates of the child's upper left outside corner
relative to the parent's upper left inside corner are both 0 (zero)
minus the value of XmNborderWidth.
MenuShell uses the XmQTmenuSystem trait and holds the
XmQTspecifyRenderTable trait.
- 1 - Formatted: January 24, 2005
XmMenuShell(library call) XmMenuShell(library call)
Classes [Toc] [Back]
MenuShell inherits behavior, resources, and traits from Core,
Composite, Shell, and OverrideShell.
The class pointer is xmMenuShellWidgetClass.
The class name is XmMenuShell.
New Resources [Toc] [Back]
MenuShell overrides the XmNallowShellResize resource in Shell. 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).
________________________________________________________________________________________
| XmMenuShell Resource Set |
|Name Class Type Default Access |
|_____________________|______________________|_______________|_________________|________|
|XmNbuttonFontList | XmCButtonFontList | XmFontList | dynamic | CSG |
|_____________________|______________________|_______________|_________________|________|
|XmNbuttonRenderTable | XmCButtonRenderTable | XmRenderTable | NULL | CSG |
|_____________________|______________________|_______________|_________________|________|
|XmNdefaultFontList | XmCDefaultFontList | XmFontList | dynamic | CG |
|_____________________|______________________|_______________|_________________|________|
|XmNlabelFontList | XmCLabelFontList | XmFontList | dynamic | CSG |
|_____________________|______________________|_______________|_________________|________|
|XmNlabelRenderTable | XmCLabelRenderTable | XmRenderTable | NULL | CSG |
|_____________________|______________________|_______________|_________________|________|
|XmNlayoutDirection | XmCLayoutDirection | XmDirection | XmLEFT_TO_RIGHT | CG |
|_____________________|______________________|_______________|_________________|________|
|_____________________|______________________|_______________|_________________|________|
XmNbuttonFontList [Toc] [Back]
Specifies the font list used for button descendants. See the
XmNbuttonRenderTable resource.
XmNbuttonRenderTable [Toc] [Back]
Specifies the render table used for MenuShell's button
descendants. If this value is NULL at initialization and if
the value of XmNdefaultFontList is not NULL,
XmNbuttonRenderTable is initialized to the value of
XmNdefaultFontList. If the value of XmNdefaultFontList is
NULL, XmNbuttonRenderTable is initialized by looking up the
- 2 - Formatted: January 24, 2005
XmMenuShell(library call) XmMenuShell(library call)
parent hierarchy of the widget for an ancestor that holds
the XmQTspecifyRenderTable trait. If such an ancestor is
found, XmNbuttonRenderTable is initialized to the
XmBUTTON_RENDER_TABLE value of the ancestor widget. If no
such ancestor is found, the default is implementation
dependent. Refer to XmRenderTable(3) for more information
on the creation and structure of a render table.
XmNdefaultFontList [Toc] [Back]
Specifies a default font list for MenuShell's descendants.
This resource is obsolete and exists for compatibility with
earlier releases. It has been replaced by XmNbuttonFontList
and XmNlabelFontList.
XmNlabelFontList [Toc] [Back]
Specifies the font list used for label descendants. See the
XmNlabelRenderTable resource.
XmNlabelRenderTable [Toc] [Back]
Specifies the render table used for MenuShell's label
descendants (Labels and LabelGadgets). If this value is NULL
at initialization and if the value of XmNdefaultFontList is
not NULL, XmNlabelRenderTable is initialized to the value of
XmNdefaultFontList. If the value of XmNdefaultFontList is
NULL, the parent hierarchy of the widget is searched for an
ancestor that holds the XmQTspecifyRenderTable trait. If
such an ancestor is found, XmNlabelRenderTable is
initialized to the XmLABEL_RENDER_TABLE value of the
ancestor widget. If no such ancestor is found, the default
is implementation dependent. Refer to XmRenderTable(3) for
more information on the creation and structure of a render
table.
XmNlayoutDirection [Toc] [Back]
Specifies the direction in which the subwidgets, children of
a widget, or other visual components are to be laid out.
This policy will apply as the default layout policy for all
descendants of this MenuShell.
Inherited Resources [Toc] [Back]
MenuShell 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. The
programmer can set the resource values for these 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
- 3 - Formatted: January 24, 2005
XmMenuShell(library call) XmMenuShell(library call)
(S), retrieved by using XtGetValues (G), or is not applicable (N/A).
______________________________________________________________________________________________________
| Shell Resource Set |
|Name Class Type Default Access |
|________________________|_________________________|________________________|________________|________|
|XmNallowShellResize | XmCAllowShellResize | Boolean | True | G |
|________________________|_________________________|________________________|________________|________|
|XmNcreatePopupChildProc | XmCCreatePopupChildProc | XtCreatePopupChildProc | NULL | CSG |
|________________________|_________________________|________________________|________________|________|
|XmNgeometry | XmCGeometry | String | NULL | CSG |
|________________________|_________________________|________________________|________________|________|
|XmNoverrideRedirect | XmCOverrideRedirect | Boolean | True | CSG |
|________________________|_________________________|________________________|________________|________|
|XmNpopdownCallback | XmCCallback | XtCallbackList | NULL | C |
|________________________|_________________________|________________________|________________|________|
|XmNpopupCallback | XmCCallback | XtCallbackList | NULL | C |
|________________________|_________________________|________________________|________________|________|
|XmNsaveUnder | XmCSaveUnder | Boolean | True | CSG |
|________________________|_________________________|________________________|________________|________|
|XmNvisual | XmCVisual | Visual * | CopyFromParent | CSG |
|________________________|_________________________|________________________|________________|________|
|________________________|_________________________|________________________|________________|________|
________________________________________________________________________
| Composite Resource Set |
|Name Class Type Default Access |
|__________________|___________________|_____________|_________|________|
|XmNchildren | XmCReadOnly | WidgetList | NULL | G |
|__________________|___________________|_____________|_________|________|
|XmNinsertPosition | XmCInsertPosition | XtOrderProc | NULL | CSG |
|__________________|___________________|_____________|_________|________|
|XmNnumChildren | XmCReadOnly | Cardinal | 0 | G |
|__________________|___________________|_____________|_________|________|
|__________________|___________________|_____________|_________|________|
- 4 - Formatted: January 24, 2005
XmMenuShell(library call) XmMenuShell(library call)
________________________________________________________________________________________________________________
| Core Resource Set |
|Name Class Type Default Access |
|______________________________|_______________________________|________________|______________________|________|
|XmNaccelerators | XmCAccelerators | XtAccelerators | dynamic | 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 | C |
|______________________________|_______________________________|________________|______________________|________|
|XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
|______________________________|_______________________________|________________|______________________|________|
|XmNscreen | XmCScreen | Screen * | dynamic | CG |
|______________________________|_______________________________|________________|______________________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|______________________________|_______________________________|________________|______________________|________|
|XmNtranslations | XmCTranslations | XtTranslations | dynamic | CSG |
|______________________________|_______________________________|________________|______________________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|______________________________|_______________________________|________________|______________________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|______________________________|_______________________________|________________|______________________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|______________________________|_______________________________|________________|______________________|________|
|______________________________|_______________________________|________________|______________________|________|
Translations [Toc] [Back]
The XmMenuShell translations are described in the following list.
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
- 5 - Formatted: January 24, 2005
XmMenuShell(library call) XmMenuShell(library call)
complete description of the format, please refer to the X Toolkit
Instrinsics Documentation.
<BtnDown>:
ClearTraversal()
<BtnUp>: MenuShellPopdownDone()
Action Routines [Toc] [Back]
The XmMenuShell action routines are
ClearTraversal():
Disables keyboard traversal for the menu, enables mouse
traversal, and unposts any menus posted by this menu.
MenuShellPopdownDone():
Unposts the menu hierarchy and, when the shell's keyboard
focus policy is XmEXPLICIT, restores focus to the widget
that had the focus before the menu system was entered.
MenuShellPopdownOne():
In a top-level Pulldown MenuPane from a MenuBar, this action
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 widget that had
the focus before the MenuBar was entered. In other Pulldown
MenuPanes, this action unposts the menu.
In a Popup MenuPane, this action 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.
Virtual Bindings [Toc] [Back]
The bindings for virtual keys are vendor specific. For information
about bindings for virtual buttons and keys, see VirtualBindings(3).
RELATED [Toc] [Back]
Composite(3), Core(3), OverrideShell(3), Shell(3),
XmCreateMenuShell(3), XmCreatePopupMenu(3), XmCreatePulldownMenu(3),
and XmRowColumn(3).
- 6 - Formatted: January 24, 2005 [ Back ] |
