bionic (3) XmMainWindow.3.gz

Provided by: libmotif-dev_2.3.8-2build1_amd64 bug

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_BARXmCOMMAND_WINDOWXmMESSAGE_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 DescendantClassIdentity                  │
       ├─────────────────┼───────────────────┼───────────────────────────┤
       ├─────────────────┼───────────────────┼───────────────────────────┤
       ├─────────────────┼───────────────────┼───────────────────────────┤
       │HorScrollBarXmScrollBar       │ horizontal scroll bar     │
       ├─────────────────┼───────────────────┼───────────────────────────┤
       │Separator1XmSeparatorGadget │ optional first separator  │
       ├─────────────────┼───────────────────┼───────────────────────────┤
       │Separator2XmSeparatorGadget │ optional second separator │
       ├─────────────────┼───────────────────┼───────────────────────────┤
       │Separator3XmSeparatorGadget │ optional third separator  │
       ├─────────────────┼───────────────────┼───────────────────────────┤
       │VertScrollBarXmScrollBar       │ 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).

       ┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
--
       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).

                                                                                                 XmMainWindow(3)