XmMainWindow(3X) OSF/Motif XmMainWindow(3X)NAMEXmMainWindow - The MainWindow widget class
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 Scrolled‐
Window with an optional MenuBar and optional CommandWindow and Mes‐
sageWindow.
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 is below the work region. Any space remaining
below the MessageWindow is managed in a manner identical to Scrolled‐
Window. 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 vis‐
ual 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".
Classes
MainWindow inherits behavior and resources from Core, Composite, Con‐
straint, XmManager, and ScrolledWindow classes.
The class pointer is xmMainWindowWidgetClass.
The class name is XmMainWindow.
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).
XmMainWindow Resource Set
────────────────────────────────────────────────────────────────
Name Default Access
Class Type
────────────────────────────────────────────────────────────────
────────────────────────────────────────────────────────────────
XmNcommandWindow NULL CSG
XmCCommandWindow Widget
────────────────────────────────────────────────────────────────
XmNcommandWindowLocation ABOVE (See Desc.) CG
XmCCommandWindowLocation unsigned char
────────────────────────────────────────────────────────────────
XmNmainWindowMarginHeight 0 CSG
XmCMainWindowMarginHeight Dimension
────────────────────────────────────────────────────────────────
XmNmainWindowMarginWidth 0 CSG
XmCMainWindowMarginWidth Dimension
────────────────────────────────────────────────────────────────
XmNmenuBar NULL CSG
XmCMenuBar Widget
────────────────────────────────────────────────────────────────
XmNmessageWindow NULL CSG
XmCMessageWindow Widget
────────────────────────────────────────────────────────────────
XmNshowSeparator False CSG
XmCShowSeparator Boolean
────────────────────────────────────────────────────────────────
Specifies the widget to be laid out as the CommandWindow. This widget
must have been previously created and managed as a child of MainWindow.
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. Specifies the margin height on the top
and bottom of MainWindow. This resource overrides any setting of the
ScrolledWindow resource XmNscrolledWindowMarginHeight. Specifies the
margin width on the right and left sides of MainWindow. This resource
overrides any setting of the ScrolledWindow resource XmNscrolledWindow‐
MarginWidth. Specifies the widget to be laid out as the MenuBar. This
widget must have been previously created and managed as a child of
MainWindow. 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 Main‐
Window. If this value is NULL, no message window is included in the
MainWindow. Displays separators between the components of the MainWin‐
dow when set to True. If set to False, no separators are displayed.
Inherited Resources
MainWindow inherits behavior and resources from the following super‐
classes. For a complete description of each resource, refer to the man
page for that superclass.
XmScrolledWindow Resource Set
─────────────────────────────────────────────────────────────────────
Name Default Access
Class Type
─────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────
XmNclipWindow dynamic G
XmCClipWindow Widget
─────────────────────────────────────────────────────────────────────
XmNhorizontalScrollBar dynamic CSG
XmCHorizontalScrollBar Widget
─────────────────────────────────────────────────────────────────────
XmNscrollBarDisplayPolicy dynamic CSG
XmCScrollBarDisplayPolicy unsigned char
─────────────────────────────────────────────────────────────────────
XmNscrollBarPlacement XmBOTTOM_RIGHT CSG
XmCScrollBarPlacement unsigned char
─────────────────────────────────────────────────────────────────────
XmNscrolledWindowMarginHeight 0 N/A
XmCScrolledWindowMarginHeight Dimension
─────────────────────────────────────────────────────────────────────
XmNscrolledWindowMarginWidth 0 N/A
XmCScrolledWindowMarginWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNscrollingPolicy XmAPPLICATION_DEFINED CG
XmCScrollingPolicy unsigned char
─────────────────────────────────────────────────────────────────────
XmNspacing 4 CSG
XmCSpacing Dimension
─────────────────────────────────────────────────────────────────────
XmNtraverseObscuredCallback NULL CSG
XmCCallback XtCallbackList
─────────────────────────────────────────────────────────────────────
XmNverticalScrollBar dynamic CSG
XmCVerticalScrollBar Widget
─────────────────────────────────────────────────────────────────────
XmNvisualPolicy dynamic G
XmCVisualPolicy unsigned char
─────────────────────────────────────────────────────────────────────
XmNworkWindow NULL CSG
XmCWorkWindow Widget
─────────────────────────────────────────────────────────────────────
XmManager 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
────────────────────────────────────────────────────────────────
XmNhighlightPixmap dynamic CSG
XmCHighlightPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNinitialFocus NULL CSG
XmCInitialFocus Widget
────────────────────────────────────────────────────────────────
XmNnavigationType XmTAB_GROUP CSG
XmCNavigationType XmNavigationType
────────────────────────────────────────────────────────────────
XmNshadowThickness 0 CSG
XmCShadowThickness Dimension
────────────────────────────────────────────────────────────────
XmNstringDirection dynamic CG
XmCStringDirection XmStringDirection
────────────────────────────────────────────────────────────────
XmNtopShadowColor dynamic CSG
XmCTopShadowColor Pixel
────────────────────────────────────────────────────────────────
XmNtopShadowPixmap dynamic CSG
XmCTopShadowPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNtraversalOn True CSG
XmCTraversalOn Boolean
────────────────────────────────────────────────────────────────
XmNunitType dynamic CSG
XmCUnitType unsigned char
────────────────────────────────────────────────────────────────
XmNuserData NULL CSG
XmCUserData XtPointer
────────────────────────────────────────────────────────────────
Composite Resource Set
──────────────────────────────────────────────────────
Name Default Access
Class Type
──────────────────────────────────────────────────────
──────────────────────────────────────────────────────
XmNchildren NULL G
XmCReadOnly WidgetList
──────────────────────────────────────────────────────
XmNinsertPosition NULL CSG
XmCInsertPosition XtOrderProc
──────────────────────────────────────────────────────
XmNnumChildren 0 G
XmCReadOnly Cardinal
──────────────────────────────────────────────────────
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
─────────────────────────────────────────────────────────────────────
Translations
MainWindow inherits translations from ScrolledWindow.
RELATED INFORMATIONComposite(3X), Constraint(3X), Core(3X), XmCreateMainWindow(3X),
XmMainWindowSep1(3X), XmMainWindowSep2(3X), XmMainWindowSep3(3X),
XmMainWindowSetAreas(3X), XmManager(3X), and XmScrolledWindow(3X)XmMainWindow(3X)
