bionic (3) XmCascadeButton.3.gz
NAME
XmCascadeButton — The CascadeButton widget class "XmCascadeButton" "widget class" "CascadeButton"
SYNOPSIS
#include <Xm/CascadeB.h>
DESCRIPTION
CascadeButton links two menu panes or a MenuBar to a menu pane.
It is used in menu systems and must have a RowColumn parent with its XmNrowColumnType resource set to
XmMENU_BAR, XmMENU_POPUP or XmMENU_PULLDOWN.
It is the only widget that can have a Pulldown menu pane attached to it as a submenu. The submenu is
displayed when this widget is activated within a MenuBar, a PopupMenu, or a PulldownMenu. Its visuals can
include a label or pixmap and a cascading indicator when it is in a Popup or Pulldown menu pane; or it
can include only a label or a pixmap when it is in a MenuBar. The positioning of the PulldownMenu with
respect to the CascadeButton depends on the XmNlayoutDirection resource of the MenuShell.
The default behavior associated with a CascadeButton depends on the type of menu system in which it
resides. By default, BSelect controls the behavior of the CascadeButton. In addition, BMenu controls
the behavior of the CascadeButton if it resides in a PopupMenu system. The actual mouse button used is
determined by its RowColumn parent. BMenu also performs the BSelect actions in all types of menu
systems.
A CascadeButton's visuals differ from most other button gadgets. When the button becomes armed, its
visuals change from a 2-D to a 3-D look, and it displays the submenu that has been attached to it. If no
submenu is attached, it simply changes its visuals.
When a CascadeButton within a Pulldown or Popup menu pane is armed as the result of the user moving the
mouse pointer into the widget, it does not immediately display its submenu. Instead, it waits a short
amount of time to see if the arming was temporary (that is, the user was simply passing through the
widget), or whether the user really wanted the submenu posted. This time delay is configurable using
XmNmappingDelay.
CascadeButton provides a single mechanism for activating the widget from the keyboard. This mechanism is
referred to as a keyboard mnemonic. If a mnemonic has been specified for the widget, the user may
activate the CascadeButton by simply typing the mnemonic while the CascadeButton is visible. If the
CascadeButton is in a MenuBar and the MenuBar does not have the focus, the MAlt modifier must be pressed
with the mnemonic. Mnemonics are typically used to interact with a menu using the keyboard interface.
If the Cascadebutton is in a Pulldown or Popup menu pane and there is a submenu attached, the
XmNmarginBottom, XmNmarginLeft, XmNmarginRight, and XmNmarginTop resources may enlarge to accommodate
XmNcascadePixmap. XmNmarginWidth defaults to 6 if this resource is in a MenuBar; otherwise, it takes
Label's default, which is 2.
CascadeButton uses the XmQTmenuSystem and XmQTspecifyRenderTable traits.
Classes
CascadeButton inherits behavior, resources, and traits from Core, XmPrimitive, and XmLabel classes.
The class pointer is xmCascadeButtonWidgetClass.
The class name is XmCascadeButton.
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).
┌───────────────────────────────────────────────────────────────────────────┐
--
RELATED
Core(3), XmCascadeButtonHighlight(3), XmCreateCascadeButton(3), XmCreateMenuBar(3), XmCreatePulldownMenu(3), XmCreatePopupMenu(3), XmLabel(3), XmPrimitive(3), XmRowColumn(3), XmVaCreateCascadeButton(3), XmVaCreateManagedCascadeButton(3). XmCascadeButton(3)