[Contents] [Index] [Next] [Previous]

XmCreatePopupMenu


NAME

XmCreatePopupMenu - A RowColumn widget convenience creation function

SYNOPSIS

#include <Xm/RowColumn.h>
Widget XmCreatePopupMenu (parent, name, arglist, argcount)
      Widget    parent;
      String    name;
      ArgList   arglist;
      Cardinal  argcount;

DESCRIPTION

XmCreatePopupMenu creates an instance of a RowColumn widget

of type XmMENU_POPUP and returns the associated widget ID. When using this function to create the Popup MenuPane, a MenuShell widget is automatically created as the parent of the MenuPane. The parent of the MenuShell widget is the widget indicated by the parent parameter.

XmCreatePopupMenu is provided as a convenience function for creating RowColumn widgets configured to operate as Popup MenuPanes and is not implemented as a separate widget class.

The PopupMenu is used as the first MenuPane within a PopupMenu system; all other MenuPanes are of the Pulldown type. A Popup MenuPane displays a 3-D shadow, unless the feature is disabled by the application. The shadow appears around the edge of the MenuPane.

The Popup MenuPane must be created as the child of a MenuShell widget in order to function properly when it is incorporated into a menu. If the application uses this convenience function for creating a Popup MenuPane, the MenuShell is automatically created as the real parent of the MenuPane. If the application does not use this convenience function to create the RowColumn to function as a Popup MenuPane, it is the application's responsibility to create the MenuShell widget.

To access the PopupMenu, the application must first position the widget using the XmMenuPosition function and then manage it using XtManageChild.

parent
Specifies the parent widget ID
name
Specifies the name of the created widget
arglist
Specifies the argument list
argcount
Specifies the number of attribute/value pairs in the argument list (arglist)

Popup MenuPanes support tear-off capabilities for tear-off menus through XmRowColumn resources. For a complete definition of RowColumn and its associated resources, see XmRowColumn(3X).

RETURN VALUE

Returns the RowColumn widget ID.

RELATED INFORMATION

XmCreateSimplePopupMenu(3X), XmMenuPosition(3X), XmMenuShell(3X), XmRowColumn(3X), and XmVaCreateSimplePopupMenu(3X).