XmMainWindow(Xm) 6 January 1993 XmMainWindow(Xm) Name XmMainWindow - the MainWindow widget class Syntax #include <Xm/MainW.h> Description MainWindow provides a standard layout for the primary window of an appli- cation. 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 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 ``Sepa- rator3''. 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 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 XmNcommandWindow- XmCCommandWindow- unsigned char ABOVE Location Location XmNmainWindow- XmCMainWindow- Dimension 0 CSG MarginHeight MarginHeight XmNmainWindow- XmCMainWindow- Dimension 0 CSG MarginWidth MarginWidth 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. XmCOMMANDABOVE- WORKSPACE locates the command window between the menu bar and the work window. XmCOMMANDBELOWWORKSPACE locates the command win- dow 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 Scrol- ledWindow 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 following super- classes. For a complete description of each resource, refer to the man page for that superclass. XmScrolledWindow resource set ____________________________________________________________________________ Name Class Type Default Access ____________________________________________________________________________ XmNclipWindow XmCClipWindow Widget dynamic G XmNhorizontal- XmCHorizontal- Widget dynamic CSG ScrollBar ScrollBar XmNscrollBar- XmCScrollBar- unsigned char dynamic DisplayPolicy DisplayPolicy XmNscrollBar- XmCScrollBar- unsigned char XmBOTTOM_RIGHT Placement Placement XmNscrolledWindow- XmCScrolledWindow-Dimension 0 N/A MarginHeight MarginHeight XmNscrolledWindow- XmCScrolledWindow-Dimension 0 N/A MarginWidth MarginWidth XmNscrollingPolicy XmCScrollingPolicyunsigned char XmAPPLIC- ATION_DEFINED XmNspacing XmCSpacing Dimension 4 CSG XmNtraverse- XmCCallback XtCallbackList NULL CSG ObscuredCallback XmNvertical- XmCVertical- Widget dynamic CSG ScrollBar ScrollBar XmNvisualPolicy XmCVisualPolicy unsigned char dynamic G XmNworkWindow XmCWorkWindow Widget NULL CSG XmManager resource set ____________________________________________________________________________ Name Class Type Default Access ____________________________________________________________________________ XmNbottom- XmCBottom- Pixel dynamic CSG ShadowColor ShadowColor XmNbottom- XmCBottom- Pixmap XmUNSPEC- CSG ShadowPixmap ShadowPixmap IFIED_PIXMAP 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 XmNnavigationType XmCNavigationType XmNavigationType XmTAB_GROUP CSG 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 XtAcceleratorsdynamic CSG XmNancestor- XmCSensitive Boolean dynamic G Sensitive XmNbackground XmCBackground Pixel dynamic CSG XmNbackground- XmCPixmap Pixmap XmUNSPEC- CSG Pixmap IFIED_PIXMAP XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG XmNborderPixmap XmCPixmap Pixmap XmUNSPEC- CSG IFIED_PIXMAP XmNborderWidth XmCBorderWidth Dimension 0 CSG XmNcolormap XmCColormap Colormap dynamic CG XmNdepth XmCDepth int dynamic CG XmNdestroyCallbackXmCCallback XtCallbackListNULL C XmNheight XmCHeight Dimension dynamic CSG XmNinitial- XmCInitial- Boolean True C Resources- Resources- Persistent Persistent XmNmapped- XmCMapped- Boolean True CSG WhenManaged WhenManaged XmNscreen XmCScreen Screen * dynamic CG XmNsensitive XmCSensitive Boolean True CSG XmNtranslations XmCTranslations XtTranslationsdynamic CSG XmNwidth XmCWidth Dimension dynamic CSG XmNx XmCPosition Position 0 CSG XmNy XmCPosition Position 0 CSG Translations MainWindow inherits translations from ScrolledWindow. See also Composite(Xm), Constraint(Xm), Core(Xm), XmCreateMainWindow(Xm), XmMainWindowSep1(Xm), XmMainWindowSep2(Xm), XmMainWindowSep3(Xm), XmMainWindowSetAreas(Xm), XmManager(Xm) and XmScrolledWindow(Xm).