NAME¶
XmMainWindow — The MainWindow widget class
"XmMainWindow" "widget class" "MainWindow"
SYNOPSIS¶
#include <Xm/MainW.h>
DESCRIPTION¶
MainWindow provides a standard layout for the primary window of an application.
This layout includes a MenuBar, a CommandWindow, a work region, a
MessageWindow, and ScrollBars. Any or all of these areas are optional. The
work region and ScrollBars in the MainWindow behave identically to the work
region and ScrollBars in the ScrolledWindow widget. The user can think of the
MainWindow as an extended ScrolledWindow with an optional MenuBar and optional
CommandWindow and MessageWindow.
In a fully loaded MainWindow, the MenuBar spans the top of the window
horizontally. The CommandWindow spans the MainWindow horizontally just below
the MenuBar, and the work region lies below the CommandWindow. The
MessageWindow is below the work region. Any space remaining below the
MessageWindow is managed in a manner identical to ScrolledWindow. The behavior
of ScrolledWindow can be controlled by the ScrolledWindow resources. To create
a MainWindow, first create the work region elements, a MenuBar, a
CommandWindow, a MessageWindow, a horizontal ScrollBar, and a vertical
ScrollBar widget, and then call
XmMainWindowSetAreas with those widget
IDs.
MainWindow can also create three Separator widgets that provide a visual
separation of MainWindow's four components. The user can specify resources in
a resource file for the automatically created gadgets that contain the
MainWindow separators. The name of the first separator gadget is
Separator1; the second is
Separator2; and the third is
Separator3.
MainWindow also provides the following three child types for layout at creation
time:
- •
- XmMENU_BAR
- •
- XmCOMMAND_WINDOW
- •
- XmMESSAGE_WINDOW
MainWindow can use these child types at creation time instead of their
associated resource values. MainWindow uses the
XmQTmenuSystem trait.
Descendants¶
MainWindow automatically creates the descendants shown in the following table.
An application can use
XtNameToWidget to gain access to the named
descendant. In addition, a user or an application can use the named descendant
when specifying resource values.
Named Descendant |
Class |
Identity |
_ |
_ |
_ |
|
_ |
_ |
_ |
HorScrollBar |
XmScrollBar |
horizontal scroll bar |
_ |
_ |
_ |
Separator1 |
XmSeparatorGadget |
optional first separator |
_ |
_ |
_ |
Separator2 |
XmSeparatorGadget |
optional second separator |
_ |
_ |
_ |
Separator3 |
XmSeparatorGadget |
optional third separator |
_ |
_ |
_ |
VertScrollBar |
XmScrollBar |
vertical scroll bar |
_ |
_ |
_ |
Classes¶
MainWindow inherits behavior and resources from
Core,
Composite,
Constraint,
XmManager, and
XmScrolledWindow.
The class pointer is
xmMainWindowWidgetClass.
The class name is
XmMainWindow.
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).
XmMainWindow Resource Set |
|
|
|
|
Name |
Class |
Type |
Default |
Access |
_ |
_ |
_ |
_ |
_ |
XmNcommandWindow |
XmCCommandWindow |
Widget |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNcommandWindowLocation |
XmCCommandWindowLocation |
unsigned char |
ABOVE (SeeDesc.) |
CG |
_ |
_ |
_ |
_ |
_ |
XmNmainWindowMarginHeight |
XmCMainWindowMarginHeight |
Dimension |
0 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNmainWindowMarginWidth |
XmCMainWindowMarginWidth |
Dimension |
0 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNmenuBar |
XmCMenuBar |
Widget |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNmessageWindow |
XmCMessageWindow |
Widget |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNshowSeparator |
XmCShowSeparator |
Boolean |
False |
CSG |
_ |
_ |
_ |
_ |
_ |
- XmNcommandWindow
- Specifies the widget to be laid out as the CommandWindow. This widget must
have been previously created and managed as a child of MainWindow.
- XmNcommandWindowLocation
- Controls the position of the command window.
XmCOMMAND_ABOVE_WORKSPACE locates the command window between the
menu bar and the work window. XmCOMMAND_BELOW_WORKSPACE locates the
command window between the work window and the message window.
- XmNmainWindowMarginHeight
- Specifies the margin height on the top and bottom of MainWindow. This
resource overrides any setting of the ScrolledWindow resource
XmNscrolledWindowMarginHeight.
- XmNmainWindowMarginWidth
- Specifies the margin width on the right and left sides of MainWindow. This
resource overrides any setting of the ScrolledWindow resource
XmNscrolledWindowMarginWidth.
- XmNmenuBar
- Specifies the widget to be laid out as the MenuBar. This widget must have
been previously created and managed as a child of MainWindow.
- XmNmessageWindow
- Specifies the widget to be laid out as the MessageWindow. This widget must
have been previously created and managed as a child of MainWindow. The
MessageWindow is positioned at the bottom of the MainWindow. If this value
is NULL, no message window is included in the MainWindow.
- XmNshowSeparator
- Displays separators between the components of the MainWindow when set to
True. If set to False, no separators are displayed.
Inherited Resources¶
MainWindow inherits behavior and resources from the superclasses described in
the following table. For a complete description of each resource, refer to the
reference page for that superclass.
XmScrolledWindow Resource Set |
|
|
|
|
Name |
Class |
Type |
Default |
Access |
_ |
_ |
_ |
_ |
_ |
XmNautoDragModel |
XmCAutoDragModel |
XtEnum |
XmAUTO_DRAG_ENABLED |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNclipWindow |
XmCClipWindow |
Widget |
dynamic |
G |
_ |
_ |
_ |
_ |
_ |
XmNhorizontalScrollBar |
XmCHorizontalScrollBar |
Widget |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNscrollBarDisplayPolicy |
XmCScrollBarDisplayPolicy |
unsigned char |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNscrollBarPlacement |
XmCScrollBarPlacement |
unsigned char |
XmBOTTOM_RIGHT |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNscrolledWindowMarginHeight |
XmCScrolledWindowMarginHeight |
Dimension |
0 |
N/A |
_ |
_ |
_ |
_ |
_ |
XmNscrolledWindowMarginWidth |
XmCScrolledWindowMarginWidth |
Dimension |
0 |
N/A |
_ |
_ |
_ |
_ |
_ |
XmNscrollingPolicy |
XmCScrollingPolicy |
unsigned char |
XmAPPLICATION_DEFINED |
CG |
_ |
_ |
_ |
_ |
_ |
XmNspacing |
XmCSpacing |
Dimension |
4 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtraverseObscuredCallback |
XmCCallback |
XtCallbackList |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNverticalScrollBar |
XmCVerticalScrollBar |
Widget |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNvisualPolicy |
XmCVisualPolicy |
unsigned char |
dynamic |
G |
_ |
_ |
_ |
_ |
_ |
XmNworkWindow |
XmCWorkWindow |
Widget |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmManager Resource Set |
|
|
|
|
Name |
Class |
Type |
Default |
Access |
_ |
_ |
_ |
_ |
_ |
XmNbottomShadowColor |
XmCBottomShadowColor |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNbottomShadowPixmap |
XmCBottomShadowPixmap |
Pixmap |
XmUNSPECIFIED_PIXMAP |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNforeground |
XmCForeground |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNhelpCallback |
XmCCallback |
XtCallbackList |
NULL |
C |
_ |
_ |
_ |
_ |
_ |
XmNhighlightColor |
XmCHighlightColor |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNhighlightPixmap |
XmCHighlightPixmap |
Pixmap |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNinitialFocus |
XmCInitialFocus |
Widget |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNlayoutDirection |
XmCLayoutDirection |
XmDirection |
dynamic |
CG |
_ |
_ |
_ |
_ |
_ |
XmNnavigationType |
XmCNavigationType |
XmNavigationType |
XmTAB_GROUP |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNpopupHandlerCallback |
XmCCallback |
XtCallbackList |
NULL |
C |
_ |
_ |
_ |
_ |
_ |
XmNshadowThickness |
XmCShadowThickness |
Dimension |
0 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNstringDirection |
XmCStringDirection |
XmStringDirection |
dynamic |
CG |
_ |
_ |
_ |
_ |
_ |
XmNtopShadowColor |
XmCTopShadowColor |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtopShadowPixmap |
XmCTopShadowPixmap |
Pixmap |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtraversalOn |
XmCTraversalOn |
Boolean |
True |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNunitType |
XmCUnitType |
unsigned char |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNuserData |
XmCUserData |
XtPointer |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
Composite Resource Set |
|
|
|
|
Name |
Class |
Type |
Default |
Access |
_ |
_ |
_ |
_ |
_ |
XmNchildren |
XmCReadOnly |
WidgetList |
NULL |
G |
_ |
_ |
_ |
_ |
_ |
XmNinsertPosition |
XmCInsertPosition |
XtOrderProc |
NULL |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNnumChildren |
XmCReadOnly |
Cardinal |
0 |
G |
_ |
_ |
_ |
_ |
_ |
Core Resource Set |
|
|
|
|
Name |
Class |
Type |
Default |
Access |
_ |
_ |
_ |
_ |
_ |
XmNaccelerators |
XmCAccelerators |
XtAccelerators |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNancestorSensitive |
XmCSensitive |
Boolean |
dynamic |
G |
_ |
_ |
_ |
_ |
_ |
XmNbackground |
XmCBackground |
Pixel |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNbackgroundPixmap |
XmCPixmap |
Pixmap |
XmUNSPECIFIED_PIXMAP |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNborderColor |
XmCBorderColor |
Pixel |
XtDefaultForeground |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNborderPixmap |
XmCPixmap |
Pixmap |
XmUNSPECIFIED_PIXMAP |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNborderWidth |
XmCBorderWidth |
Dimension |
0 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNcolormap |
XmCColormap |
Colormap |
dynamic |
CG |
_ |
_ |
_ |
_ |
_ |
XmNdepth |
XmCDepth |
int |
dynamic |
CG |
_ |
_ |
_ |
_ |
_ |
XmNdestroyCallback |
XmCCallback |
XtCallbackList |
NULL |
C |
_ |
_ |
_ |
_ |
_ |
XmNheight |
XmCHeight |
Dimension |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNinitialResourcesPersistent |
XmCInitialResourcesPersistent |
Boolean |
True |
C |
_ |
_ |
_ |
_ |
_ |
XmNmappedWhenManaged |
XmCMappedWhenManaged |
Boolean |
True |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNscreen |
XmCScreen |
Screen * |
dynamic |
CG |
_ |
_ |
_ |
_ |
_ |
XmNsensitive |
XmCSensitive |
Boolean |
True |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNtranslations |
XmCTranslations |
XtTranslations |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNwidth |
XmCWidth |
Dimension |
dynamic |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNx |
XmCPosition |
Position |
0 |
CSG |
_ |
_ |
_ |
_ |
_ |
XmNy |
XmCPosition |
Position |
0 |
CSG |
_ |
_ |
_ |
_ |
_ |
Translations¶
MainWindow inherits translations from ScrolledWindow.
Composite(3),
Constraint(3),
Core(3),
XmCreateMainWindow(3),
XmMainWindowSep1(3),
XmMainWindowSep2(3),
XmMainWindowSep3(3),
XmMainWindowSetAreas(3),
XmManager(3),
XmScrolledWindow(3) XmVaCreateMainWindow(3), and
XmVaCreateManagedMainWindow(3).