XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
NAME
XmCascadeButtonGadget - The CascadeButtonGadget widget class.
SYNOPSIS
#include <Xm/CascadeBG.h>
DESCRIPTION
CascadeButtonGadget links two MenuPanes, a MenuBar to a MenuPane, or an
OptionMenu 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,
XmMENU_PULLDOWN, or XmMENU_OPTION.
It is the only gadget that can have a Pulldown MenuPane attached to it as
a submenu. The submenu is displayed when this gadget is activated within
a PopupMenu, a PulldownMenu, or an OptionMenu. 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 an OptionMenu.
The default behavior associated with a CascadeButtonGadget depends on the
type of menu system in which it resides. By default, BSelect controls
the behavior of the CascadeButtonGadget. In addition, BMenu controls the
behavior of the CascadeButtonGadget if it resides in a PopupMenu system.
The actual mouse button used is determined by its RowColumn parent.
A CascadeButtonGadget'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 CascadeButtonGadget within a Pulldown or Popup MenuPane is armed
as the result of the user moving the mouse pointer into the gadget, it
does not immediately display its submenu. Instead, it waits a short time
to see if the arming was temporary (that is, the user was simply passing
through the gadget), or the user really wanted the submenu posted. This
delay is configurable via XmNmappingDelay.
CascadeButtonGadget provides a single mechanism for activating the gadget
from the keyboard. This mechanism is referred to as a keyboard mnemonic.
If a mnemonic has been specified for the gadget, the user may activate it
by simply typing the mnemonic while the CascadeButtonGadget is visible.
If the CascadeButtonGadget 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.
If a CascadeButtonGadget is in a Pulldown or Popup MenuPane and there is
a submenu attached, the XmNmarginBottom, XmNmarginLeft, XmNmarginRight,
and XmNmarginTop resources may enlarge to accommodate XmNcascadePixmap.
10/89 Page 1
XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
XmNmarginWidth defaults to 6 if this resource is in a MenuBar; otherwise,
it takes LabelGadget's default, which is 2.
Classes
CascadeButtonGadget inherits behavior and resources from Object, RectObj,
XmGadget, and XmLabelGadget classes.
The class pointer is xmCascadeButtonGadgetClass.
The class name is XmCascadeButtonGadget.
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).
____________________________________________________________________________
| XmCascadeButtonGadget |
|_____________________|_________________|________________|_________|________|
| Name | Class | Type | Default| Access|
|_____________________|_________________|________________|_________|________|
|_____________________|_________________|________________|_________|________|
| XmNactivateCallback | XmCCallback | XtCallbackList| NULL | C |
|_____________________|_________________|________________|_________|________|
| XmNcascadePixmap | XmCPixmap | Pixmap | dynamic| CSG |
|_____________________|_________________|________________|_________|________|
| XmNcascadingCallback| XmCCallback | XtCallbackList| NULL | C |
|_____________________|_________________|________________|_________|________|
| XmNmappingDelay | XmCMappingDelay| int | 180 ms | CSG |
|_____________________|_________________|________________|_________|________|
| XmNsubMenuId | XmCMenuWidget | Widget | NULL | CSG |
|_____________________|_________________|________________|_________|________|
XmNactivateCallback
Specifies the list of callbacks that is called when the user
activates the CascadeButtonGadget, 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 gadget. The specific mouse
button depends on information in the RowColumn parent. The reason
sent by the callback is XmCR_ACTIVATE.
Page 2 10/89
XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
XmNcascadePixmap
Specifies the cascade pixmap displayed on one end of the gadget
when a CascadeButtonGadget is used within a Popup or Pulldown
MenuPane and a submenu is attached. The LabelGadget class
resources XmNmarginBottom, XmNmarginLeft, XmNmarginRight, and
XmNmarginTop may be modified to ensure that room is left for the
cascade pixmap. The default cascade pixmap in menus other than
option menus is an arrow pointing to the side of the menu where the
submenu will appear. The default for the CascadeButtonGadget in an
option menu is XmUNSPECIFIED_PIXMAP.
XmNcascadingCallback
Specifies the list of callbacks that is called just prior to the
mapping of the submenu associated with the CascadeButtonGadget.
The reason sent by the callback is XmCR_CASCADING.
XmNmappingDelay
Specifies the amount of time, in milliseconds, between when a
CascadeButtonGadget becomes armed and when it maps its submenu.
This delay is used only when the gadget is within a Popup or
Pulldown MenuPane. The value must not be negative.
XmNsubMenuId
Specifies the widget ID for the Pulldown MenuPane to be associated
with this CascadeButtonGadget. The specified MenuPane is displayed
when the CascadeButtonGadget becomes armed. The MenuPane must have
been created with the appropriate parentage depending on the type
of menu used. See XmCreatePulldownMenu(3X), XmCreatePopupMenu(3X),
and XmCreateOptionMenu(3X) for more information on the menu
systems.
Inherited Resources
CascadeButtonGadget inherits behavior and resources from the following
superclasses. For a complete description of each resource, refer to the
man page for that superclass.
10/89 Page 3
XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
___________________________________________________________________________________________________________
| XmLabelGadget Resource Set |
|_________________________|___________________________|___________________|______________________|________|
|Name | Class | Type | Default | Access|
|_________________________|___________________________|___________________|______________________|________|
|_________________________|___________________________|___________________|______________________|________|
|XmNaccelerator | XmCAccelerator | String | NULL | N/A |
|_________________________|___________________________|___________________|______________________|________|
|XmNacceleratorText | XmCAcceleratorText | XmString | NULL | N/A |
|_________________________|___________________________|___________________|______________________|________|
|XmNalignment | XmCAlignment | unsigned char | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNfontList | XmCFontList | XmFontList | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelInsensitivePixmap| XmCLabelInsensitivePixmap| Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelPixmap | XmCLabelPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelString | XmCXmString | XmString | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNlabelType | XmCLabelType | unsigned char | XmSTRING | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginBottom | XmCMarginBottom | Dimension | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginHeight | XmCMarginHeight | Dimension | 2 | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginLeft | XmCMarginLeft | Dimension | 0 | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginRight | XmCMarginRight | Dimension | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginTop | XmCMarginTop | Dimension | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmarginWidth | XmCMarginWidth | Dimension | 2 | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmnemonic | XmCMnemonic | KeySym | NULL | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNmnemonicCharSet | XmCMnemonicCharSet | String | dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNrecomputeSize | XmCRecomputeSize | Boolean | True | CSG |
|_________________________|___________________________|___________________|______________________|________|
|XmNstringDirection | XmCStringDirection | XmStringDirection| dynamic | CSG |
|_________________________|___________________________|___________________|______________________|________|
Page 4 10/89
XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
_____________________________________________________________________________________
| XmGadget Resource Set |
|_____________________|_______________________|__________________|_________|________|
|Name | Class | Type | Default| Access|
|_____________________|_______________________|__________________|_________|________|
|_____________________|_______________________|__________________|_________|________|
|XmNhelpCallback | XmCCallback | XtCallbackList | NULL | C |
|_____________________|_______________________|__________________|_________|________|
|XmNhighlightOnEnter | XmCHighlightOnEnter | Boolean | False | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNhighlightThickness| XmCHighlightThickness| Dimension | 2 | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNnavigationType | XmCNavigationType | XmNavigationType| XmNONE | G |
|_____________________|_______________________|__________________|_________|________|
|XmNshadowThickness | XmCShadowThickness | Dimension | 2 | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNtraversalOn | XmCTraversalOn | Boolean | True | CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNunitType | XmCUnitType | unsigned char | dynamic| CSG |
|_____________________|_______________________|__________________|_________|________|
|XmNuserData | XmCUserData | Pointer | NULL | CSG |
|_____________________|_______________________|__________________|_________|________|
______________________________________________________________________
| RectObj Resource Set |
|_____________________|________________|___________|_________|________|
| Name | Class | Type | Default| Access|
|_____________________|________________|___________|_________|________|
|_____________________|________________|___________|_________|________|
| XmNancestorSensitive| XmCSensitive | Boolean | dynamic| G |
|_____________________|________________|___________|_________|________|
| XmNborderWidth | XmCBorderWidth| Dimension| 0 | CSG |
|_____________________|________________|___________|_________|________|
| XmNheight | XmCHeight | Dimension| dynamic| CSG |
|_____________________|________________|___________|_________|________|
| XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________|________________|___________|_________|________|
| XmNwidth | XmCWidth | Dimension| dynamic| CSG |
|_____________________|________________|___________|_________|________|
| XmNx | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
| XmNy | XmCPosition | Position | 0 | CSG |
|_____________________|________________|___________|_________|________|
______________________________________________________________________
Object Resource Set
______________________________________________________________________
Name Class Type Default Access
______________________________________________________________________
______________________________________________________________________
XmNdestroyCallback XmCCallback XtCallbackList NULL C
______________________________________________________________________
10/89 Page 5
XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
| | | | | |
| | | | | |
C
|allback Information| | | | |
| A pointer to the f
|ollowing struc
|ture is passed to
| each call
|back: |
| | | | | |
| typedef struct | | | | |
| { | | | | |
| int reason;
| | | | |
| XEvent * event
|; | | | |
| } XmAnyCallbackStr
|uct; | | | |
| | | | | |
| | | | | |
| reason Indicates wh
|y the callback
| was invoked. | | |
| | | | | |
| event Points to th
|e XEvent that|triggered the cal
|lback or i
|s NULL if
| this
| callback wa
|s not triggere
|d by an XEvent. | | |
| | | | | |
| | | | | |
B
|ehavior | | | | |
| XmCascadeButtonGad
|get includes b
|ehavior from XmGa
|dget. XmC
|ascadeBut
|ton
| includes the menu|traversal beha
|vior from XmLabel
|. Additio
|nal |
| XmCascadeButtonGad
|get behavior i
|s described below
| (in a Pop
|up menu s
|ytem,
| BMenu also perform
|s the BSelect|actions): | | |
| | | | | |
| BSelect Press: | | | | |
| Unposts any|menus posted b
|y the parent menu
|. Arms th
|e |
| CascadeButto
|nGadget, posts
| the associated s
|ubmenu, en
|ables mou
|se
| traversal, a
|nd, in a MenuB
|ar, arms the Menu
|Bar. If t
|he menu i
|s
| already acti
|ve, this event
| disables keyboar
|d traversa
|l for the
| menu
| and returns|the menu to mo
|use traversal mod
|e. | |
| | | | | |
| BSelect Release: | | | | |
| Posts the su
|bmenu attached
| to the CascadeBu
|ttonGadget
| and enab
|les
| keyboard tra
|versal within|the menu. If the
| CascadeBu
|ttonGadge
|t
| does not ha↓e a submenu at
|tached, the Casca
|deButtonGa
|dget is |
| activated an
|d all posted m
|enus in the casca
|de are unp
|osted. |
| | | | | |
| KActivate or KSele
|ct: | | | |
| Posts the su
|bmenu attached
| to the CascadeBu
|ttonGadget
| if keybo
|ard
| traversal is
| enabled in th
|e menu. If the C
|ascadeButt
|onGadget|does
| not have a s
|ubmenu attache
|d, the CascadeBut
|tonGadget|is activa
|ted
| and all post
|ed menus in th
|e cascade are unp
|osted. | |
| | | | | |
| KHelp: | | | | |
Unposts all|menus in the m
|enu hierarchy and
| restores|keyboard focus
to the tab group 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.
Page 6 10/89
XmCascadeButtonGadget(3X) UNIX System V XmCascadeButtonGadget(3X)
MAny KCancel:
In a MenuBar, disarms the CascadeButtonGadget and the menu and
restores keyboard focus to the tab group that had the focus before
the menu was entered.
In a toplevel Pulldown MenuPane from a MenuBar, unposts the menu,
disarms the MenuBar CascadeButton and the MenuBar, and restores
keyboard focus to the tab group that had the focus before the
MenuBar was entered. In other Pulldown MenuPanes, unposts the
menu.
In a Popup MenuPane, unposts the menu and restores keyboard focus
to the widget from which the menu was posted.
<Enter>:
If keyboard traversal is enabled does nothing. Otherwise, in a
MenuBar, unposts any MenuPanes associated with another MenuBar
entry, arms the CascadeButtonGadget, and posts the associated
submenu. In other menus, arms the CascadeButtonGadget and posts
the associated submenu after the delay specified by
XmNmappingDelay.
<Leave>:
If keyboard traversal is enabled does nothing. Otherwise, in a
MenuBar, disarms the CascadeButtonGadget if the submenu associated
with the CascadeButtonGadget is not currently posted or if there is
no submenu associated with the CascadeButtonGadget.
In other menus, if the pointer moves anywhere except into a submenu
associated with the CascadeButtonGadget, the CascadeButtonGadget 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 INFORMATION
Object(3X), RectObj(3X), XmCascadeButtonHighlight(3),
XmCreateCascadeButtonGadget(3X), XmCreatePulldownMenu(3X),
XmCreatePopupMenu(3X), XmCreateOptionMenu(3X), XmGadget(3X),
XmLabelGadget(3X), and XmRowColumn(3X).
10/89 Page 7