XmCascadeButton(3X) OSF/Motif XmCascadeButton(3X)NAMEXmCascadeButton - The CascadeButton widget class
SYNOPSIS
#include <Xm/CascadeB.h>
DESCRIPTION
CascadeButton links two MenuPanes or a MenuBar to a MenuPane.
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 MenuPane 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 MenuPane; or, it can include only a label or a pixmap
when it is in a MenuBar.
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.
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 sub‐
menu is attached, it simply changes its visuals.
When a CascadeButton within a Pulldown or Popup MenuPane 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 via XmNmap‐
pingDelay.
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 via
the keyboard interface.
If in a Pulldown or Popup MenuPane 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.
Classes
CascadeButton inherits behavior and resources 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 pro‐
grammer to specify data. The programmer can also set the resource val‐
ues 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).
XmCascadeButton Resource Set
───────────────────────────────────────────────────────
Name Default Access
Class Type
───────────────────────────────────────────────────────
───────────────────────────────────────────────────────
XmNactivateCallback NULL C
XmCCallback XtCallbackList
───────────────────────────────────────────────────────
XmNcascadePixmap dynamic CSG
XmCPixmap Pixmap
───────────────────────────────────────────────────────
XmNcascadingCallback NULL C
XmCCallback XtCallbackList
───────────────────────────────────────────────────────
XmNmappingDelay 180 ms CSG
XmCMappingDelay int
───────────────────────────────────────────────────────
XmNsubMenuId NULL CSG
XmCMenuWidget Widget
───────────────────────────────────────────────────────
Specifies the list of callbacks that is called when the user activates
the CascadeButton widget, and there is no submenu attached to pop up.
The activation occurs by releasing a mouse button or by typing the
mnemonic associated with the widget. The specific mouse button depends
on information in the RowColumn parent. The reason sent by the call‐
back is XmCR_ACTIVATE. Specifies the cascade pixmap displayed on one
end of the widget when a CascadeButton is used within a Popup or Pull‐
down MenuPane and a submenu is attached. The Label class resources
XmNmarginBottom, XmNmarginLeft, XmNmarginRight, and XmNmarginTop may be
modified to ensure that room is left for the cascade pixmap. The
default cascade pixmap is an arrow pointing to the side of the menu
where the submenu will appear. Specifies the list of callbacks that is
called just prior to the mapping of the submenu associated with Cas‐
cadeButton. The reason sent by the callback is XmCR_CASCADING. Speci‐
fies the amount of time, in milliseconds, between when a CascadeButton
becomes armed and when it maps its submenu. This delay is used only
when the widget is within a Popup or Pulldown MenuPane. The value must
not be negative. Specifies the widget ID for the Pulldown MenuPane to
be associated with this CascadeButton. The specified MenuPane is dis‐
played when the CascadeButton becomes armed. The MenuPane must have
been created with the appropriate parentage depending on the type of
menu used. See XmCreateMenuBar(3X), XmCreatePulldownMenu(3X), and
XmCreatePopupMenu(3X) for more information on the menu systems.
Inherited Resources
CascadeButton inherits behavior and resources from the following super‐
classes. For a complete description of each resource, refer to the man
page for that superclass.
XmLabel Resource Set
────────────────────────────────────────────────────────────────────
Name Default Access
Class Type
────────────────────────────────────────────────────────────────────
────────────────────────────────────────────────────────────────────
XmNaccelerator NULL N/A
XmCAccelerator String
────────────────────────────────────────────────────────────────────
XmNacceleratorText NULL N/A
XmCAcceleratorText XmString
────────────────────────────────────────────────────────────────────
XmNalignment dynamic CSG
XmCAlignment unsigned char
────────────────────────────────────────────────────────────────────
XmNfontList dynamic CSG
XmCFontList XmFontList
────────────────────────────────────────────────────────────────────
XmNlabelInsensitivePixmap XmUNSPECIFIED_PIXMAP CSG
XmCLabelInsensitivePixmap Pixmap
────────────────────────────────────────────────────────────────────
XmNlabelPixmap XmUNSPECIFIED_PIXMAP CSG
XmCLabelPixmap Pixmap
────────────────────────────────────────────────────────────────────
XmNlabelString dynamic CSG
XmCXmString XmString
────────────────────────────────────────────────────────────────────
XmNlabelType XmSTRING CSG
XmCLabelType unsigned char
────────────────────────────────────────────────────────────────────
XmNmarginBottom dynamic CSG
XmCMarginBottom Dimension
────────────────────────────────────────────────────────────────────
XmNmarginHeight 2 CSG
XmCMarginHeight Dimension
────────────────────────────────────────────────────────────────────
XmNmarginLeft 0 CSG
XmCMarginLeft Dimension
────────────────────────────────────────────────────────────────────
XmNmarginRight dynamic CSG
XmCMarginRight Dimension
────────────────────────────────────────────────────────────────────
XmNmarginTop dynamic CSG
XmCMarginTop Dimension
────────────────────────────────────────────────────────────────────
XmNmarginWidth dynamic CSG
XmCMarginWidth Dimension
────────────────────────────────────────────────────────────────────
XmNmnemonic NULL CSG
XmCMnemonic KeySym
────────────────────────────────────────────────────────────────────
XmNmnemonicCharSet XmFONTLIST_DEFAULT_TAG CSG
XmCMnemonicCharSet String
────────────────────────────────────────────────────────────────────
XmNrecomputeSize True CSG
XmCRecomputeSize Boolean
────────────────────────────────────────────────────────────────────
XmNstringDirection dynamic CSG
XmCStringDirection XmStringDirection
────────────────────────────────────────────────────────────────────
XmPrimitive Resource Set
───────────────────────────────────────────────────────────────
Name Default Access
Class Type
───────────────────────────────────────────────────────────────
───────────────────────────────────────────────────────────────
XmNbottomShadowColor dynamic CSG
XmCBottomShadowColor Pixel
───────────────────────────────────────────────────────────────
XmNbottomShadowPixmap XmUNSPECIFIED_PIXMAP CSG
XmCBottomShadowPixmap Pixmap
───────────────────────────────────────────────────────────────
XmNforeground dynamic CSG
XmCForeground Pixel
───────────────────────────────────────────────────────────────
XmNhelpCallback NULL C
XmCCallback XtCallbackList
───────────────────────────────────────────────────────────────
XmNhighlightColor dynamic CSG
XmCHighlightColor Pixel
───────────────────────────────────────────────────────────────
XmNhighlightOnEnter False CSG
XmCHighlightOnEnter Boolean
───────────────────────────────────────────────────────────────
XmNhighlightPixmap dynamic CSG
XmCHighlightPixmap Pixmap
───────────────────────────────────────────────────────────────
XmNhighlightThickness 0 CSG
XmCHighlightThickness Dimension
───────────────────────────────────────────────────────────────
XmNnavigationType XmNONE CSG
XmCNavigationType XmNavigationType
───────────────────────────────────────────────────────────────
XmNshadowThickness 2 CSG
XmCShadowThickness Dimension
───────────────────────────────────────────────────────────────
XmNtopShadowColor dynamic CSG
XmCTopShadowColor Pixel
───────────────────────────────────────────────────────────────
XmNtopShadowPixmap dynamic CSG
XmCTopShadowPixmap Pixmap
───────────────────────────────────────────────────────────────
XmNtraversalOn dynamic G
XmCTraversalOn Boolean
───────────────────────────────────────────────────────────────
XmNunitType dynamic CSG
XmCUnitType unsigned char
───────────────────────────────────────────────────────────────
XmNuserData NULL CSG
XmCUserData XtPointer
───────────────────────────────────────────────────────────────
Core Resource Set
─────────────────────────────────────────────────────────────────────
Name Default Access
Class Type
─────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────
XmNaccelerators dynamic CSG
XmCAccelerators XtAccelerators
─────────────────────────────────────────────────────────────────────
XmNancestorSensitive dynamic G
XmCSensitive Boolean
─────────────────────────────────────────────────────────────────────
XmNbackground dynamic CSG
XmCBackground Pixel
─────────────────────────────────────────────────────────────────────
XmNbackgroundPixmap XmUNSPECIFIED_PIXMAP CSG
XmCPixmap Pixmap
─────────────────────────────────────────────────────────────────────
XmNborderColor XtDefaultForeground CSG
XmCBorderColor Pixel
─────────────────────────────────────────────────────────────────────
XmNborderPixmap XmUNSPECIFIED_PIXMAP CSG
XmCPixmap Pixmap
─────────────────────────────────────────────────────────────────────
XmNborderWidth 0 CSG
XmCBorderWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNcolormap dynamic CG
XmCColormap Colormap
─────────────────────────────────────────────────────────────────────
XmNdepth dynamic CG
XmCDepth int
─────────────────────────────────────────────────────────────────────
XmNdestroyCallback NULL C
XmCCallback XtCallbackList
─────────────────────────────────────────────────────────────────────
XmNheight dynamic CSG
XmCHeight Dimension
─────────────────────────────────────────────────────────────────────
XmNinitialResourcesPersistent True C
XmCInitialResourcesPersistent Boolean
─────────────────────────────────────────────────────────────────────
XmNmappedWhenManaged True CSG
XmCMappedWhenManaged Boolean
─────────────────────────────────────────────────────────────────────
XmNscreen dynamic CG
XmCScreen Screen *
─────────────────────────────────────────────────────────────────────
XmNsensitive True CSG
XmCSensitive Boolean
─────────────────────────────────────────────────────────────────────
XmNtranslations dynamic CSG
XmCTranslations XtTranslations
─────────────────────────────────────────────────────────────────────
XmNwidth dynamic CSG
XmCWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNx 0 CSG
XmCPosition Position
─────────────────────────────────────────────────────────────────────
XmNy 0 CSG
XmCPosition Position
─────────────────────────────────────────────────────────────────────
Callback Information
A pointer to the following structure is passed to each callback: type‐
def struct { int reason; XEvent * event; } XmAnyCallback‐
Struct; Indicates why the callback was invoked. Points to the XEvent
that triggered the callback or is NULL if this callback was not trig‐
gered due to an XEvent.
Translations
XmCascadeButton includes translations from Primitive. XmCascadeButton
includes the menu traversal translations from XmLabel. These transla‐
tions may not directly correspond to a translation table.
Note that altering translations in #override or #augment mode is unde‐
fined.
The translations for a CascadeButton in a MenuBar are listed below.
These translations may not directly correspond to a translation table.
BSelect Press: MenuBarSelect() BSelect Release:DoSelect() KActi‐
vate: KeySelect() KSelect: KeySelect() KHelp: Help()
MAny KCancel: CleanupMenuBar()
The translations for a CascadeButton in a PullDown or Popup MenuPane
are listed below. In a Popup menu system, BMenu also performs the BSe‐
lect actions. These translations may not directly correspond to a
translation table. BSelect Press: StartDrag() BSelect Release:DoSe‐
lect() KActivate: KeySelect() KSelect: KeySelect()
KHelp: Help() MAny KCancel: CleanupMenuBar()
Action Routines
The XmCascadeButton action routines are described below: In a MenuBar,
disarms the CascadeButton and the menu and, when the shell's keyboard
focus policy is XmEXPLICT, restores keyboard focus to the widget that
had the focus before the menu was entered.
In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu, dis‐
arms the MenuBar CascadeButton and the MenuBar, and, when the shell's
keyboard focus policy is XmEXPLICT, restores keyboard focus to the wid‐
get that had the focus before the MenuBar was entered. In other Pull‐
down MenuPanes, unposts the menu.
In a Popup MenuPane, unposts the menu and, when the shell's keyboard
focus policy is XmEXPLICT, restores keyboard focus to the widget from
which the menu was posted. Calls the callbacks in XmNcascadingCall‐
back, posts the submenu attached to the CascadeButton and enables key‐
board traversal within the menu. If the CascadeButton does not have a
submenu attached, calls the callbacks in XmNactivateCallback, the Cas‐
cadeButton is activated and all posted menus in the cascade are
unposted. Unposts all menus in the menu hierarchy and, when the
shell's keyboard focus policy is XmEXPLICT, restores keyboard focus to
the widget that had the focus before the menu system was entered.
Calls the callbacks for XmNhelpCallback if any exist. If there are no
help callbacks for this widget, this action calls the help callbacks
for the nearest ancestor that has them. Calls the callbacks in XmNcas‐
cadingCallback, and posts the submenu attached to the CascadeButton if
keyboard traversal is enabled in the menu. If the CascadeButton does
not have a submenu attached, calls the callbacks in XmNactivateCall‐
back, the CascadeButton is activated and all posted menus in the cas‐
cade are unposted. Unposts any menus posted by the parent menu. Arms
both the CascadeButton and the MenuBar, posts the associated submenu,
and enables mouse traversal. If the menu is already active, this event
disables keyboard traversal for the menu and returns the menu to mouse
traversal mode. Arms the CascadeButton, posts the associated submenu,
and enables mouse traversal. If the menu is already active, this event
disables keyboard traversal for the menu and returns the menu to mouse
traversal mode.
Additional Behavior
Posting a submenu calls the XmNcascadingCallback callbacks. This wid‐
get has the additional behavior described below: If keyboard traversal
is enabled does nothing. Otherwise, in a MenuBar that is armed,
unposts any MenuPanes associated with another MenuBar entry, arms the
CascadeButton, and posts the associated submenu. In other menus, arms
the CascadeButton and posts the associated submenu after the delay
specified by XmNmappingDelay. If keyboard traversal is enabled does
nothing. Otherwise, in a MenuBar that is armed, disarms the Cascade‐
Button if the submenu associated with the CascadeButton is not cur‐
rently posted or if there is no submenu associated with the CascadeBut‐
ton.
In other menus, if the pointer moves anywhere except into a submenu
associated with the CascadeButton, the CascadeButton is disarmed and
its submenu is unposted.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information
about bindings for virtual buttons and keys, see VirtualBindings(3X).
RELATED INFORMATIONCore(3X), XmCascadeButtonHighlight(3X), XmCreateCascadeBut‐
ton(3X),XmCreateMenuBar(3X), XmCreatePulldownMenu(3X), XmCreatePopup‐
Menu(3X), XmLabel(3X), XmPrimitive(3X), and XmRowColumn(3X).
XmCascadeButton(3X)
