XmCreatePulldownMenu(3Xm) XmCreatePulldownMenu(3Xm)
NAME
XmCreatePulldownMenu - a RowColumn widget convenience
creation function.
AES SUPPORT LEVEL
full-use
SYNOPSIS
#include <Xm/RowColumn.h>
Widget XmCreatePulldownMenu (parent, name, arglist,
argcount)
Widget parent;
String name;
ArgList arglist;
Cardinal argcount;
DESCRIPTION
XmCreatePulldownMenu creates an instance of a RowColumn
widget of type XmMENU_PULLDOWN and returns the
associated widget ID. When using this function to
create the Pulldown MenuPane, a MenuShell widget is
automatically created as the parent of the MenuPane.
If the widget specified by the parent parameter is a
Popup or a Pulldown MenuPane, then the MenuShell widget
is created as a child of the parent's MenuShell;
otherwise, it is created as a child of the specified
parent widget.
XmCreatePulldownMenu is provided as a convenience
function for creating RowColumn widgets configured to
operate as Pulldown MenuPanes and is not implemented as
a separate widget class.
A Pulldown MenuPane displays a 3-D shadow, unless the
feature is disabled by the application. The shadow
appears around the edge of the MenuPane.
A Pulldown MenuPane is used when creating submenus that
are to be attached to a CascadeButton or a
CascadeButtonGadget. This is the case for all
MenuPanes that are part of a PulldownMenu system (a
MenuBar), the MenuPane associated with an OptionMenu,
and any MenuPanes that cascade from a Popup MenuPane.
Pulldown MenuPanes, which are to be associated with an
OptionMenu, must be created before the OptionMenu is
created.
The Pulldown MenuPane must be attached to a
CascadeButton or CascadeButtonGadget which resides in a
- 1 -
XmCreatePulldownMenu(3Xm) XmCreatePulldownMenu(3Xm)
MenuBar, a Popup MenuPane, a Pulldown MenuPane, or an
OptionMenu. This is done by using the button resource
XmNsubMenuId.
A MenuShell widget is required between the Pulldown
MenuPane and its parent. If the application uses this
convenience function for creating a Pulldown MenuPane,
then the MenuShell is automatically created as the real
parent of the MenuPane; otherwise, it is the
application's responsibility to create the MenuShell
widget.
To function correctly when incorporated into a menu,
the Pulldown MenuPane's hierarchy must be considered;
this hierarchy is dependent upon the type of menu
system that is being built:
⊕ If the Pulldown MenuPane is to be pulled down from a
MenuBar, its parent must be the MenuBar.
⊕ If the Pulldown MenuPane is to be pulled down from a
Popup or another Pulldown MenuPane, its parent must
be that Popup or Pulldown MenuPane.
⊕ If the Pulldown MenuPane is to be pulled down from
an OptionMenu, its parent must be the same as the
OptionMenu parent.
parent Specifies the parent widget ID.
name Specifies the name of the created widget.
arglistSpecifies the argument list.
argcount
Specifies the number of attribute/value pairs in
the argument list (arglist).
For a complete definition of RowColumn and its
associated resources, see XmRowColumn(3X).
RETURN VALUE
Returns the RowColumn widget ID.
RELATED INFORMATION
XmCascadeButton(3X), XmCascadeButtonGadget(3X),
XmCreateOptionMenu(3X), XmCreatePopupMenu(3X),
XmCreatePulldownMenu(3X), XmMenuShell(3X), and
- 2 -
XmCreatePulldownMenu(3Xm) XmCreatePulldownMenu(3Xm)
XmRowColumn(3X).
- 3 -