XmMainWindow(library call) XmMainWindow(library call)
NAME [Toc] [Back]
XmMainWindow - The MainWindow widget class
SYNOPSIS [Toc] [Back]
#include <Xm/MainW.h>
DESCRIPTION [Toc] [Back]
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 [Toc] [Back]
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.
- 1 - Formatted: January 24, 2005
XmMainWindow(library call) XmMainWindow(library call)
__________________________________________________________________
|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 [Toc] [Back]
MainWindow inherits behavior and resources from Core, Composite,
Constraint, XmManager, and XmScrolledWindow.
The class pointer is xmMainWindowWidgetClass.
The class name is XmMainWindow.
New Resources [Toc] [Back]
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).
- 2 - Formatted: January 24, 2005
XmMainWindow(library call) XmMainWindow(library call)
___________________________________________________________________________________________________
| 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 [Toc] [Back]
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 [Toc] [Back]
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 [Toc] [Back]
Specifies the margin height on the top and bottom of
MainWindow. This resource overrides any setting of the
ScrolledWindow resource XmNscrolledWindowMarginHeight.
XmNmainWindowMarginWidth [Toc] [Back]
Specifies the margin width on the right and left sides of
MainWindow. This resource overrides any setting of the
ScrolledWindow resource XmNscrolledWindowMarginWidth.
XmNmenuBar [Toc] [Back]
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 [Toc] [Back]
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
- 3 - Formatted: January 24, 2005
XmMainWindow(library call) XmMainWindow(library call)
the bottom of the MainWindow. If this value is NULL, no
message window is included in the MainWindow.
XmNshowSeparator [Toc] [Back]
Displays separators between the components of the MainWindow
when set to True. If set to False, no separators are
displayed.
Inherited Resources [Toc] [Back]
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 |
|______________________________|_______________________________|________________|_______________________|________|
|______________________________|_______________________________|________________|_______________________|________|
- 4 - Formatted: January 24, 2005
XmMainWindow(library call) XmMainWindow(library call)
_____________________________________________________________________________________________________
| 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
________________________________________________________________________
________________________________________________________________________
- 5 - Formatted: January 24, 2005
XmMainWindow(library call) XmMainWindow(library call)
| | | | | |
________________________________________________________________________________________________________________
| | | 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 [Toc] [Back]
MainWindow inherits translations from ScrolledWindow.
RELATED [Toc] [Back]
- 6 - Formatted: January 24, 2005
XmMainWindow(library call) XmMainWindow(library call)
Composite(3), Constraint(3), Core(3), XmCreateMainWindow(3),
XmMainWindowSep1(3), XmMainWindowSep2(3), XmMainWindowSep3(3),
XmMainWindowSetAreas(3), XmManager(3), and XmScrolledWindow(3)
- 7 - Formatted: January 24, 2005 [ Back ] |
