Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ Shell(Xm) — OpenDesktop Software Development System 3.0.0

Media Vault

Software Library

Restoration Projects

Artifacts Sought


 Shell(Xm)                      6 January 1993                      Shell(Xm)


 Name

    Shell - the Shell widget class

 Syntax


    #include <Xm/Xm.h>
    #include <X11/Shell.h>


 Description

    Shell is a top-level widget (with only one managed child) that encapsu-
    lates the interaction with the window manager.

    At the time the shell's child is managed, the child's width is used for
    both widgets if the shell is unrealized and no width has been specified
    for the shell. Otherwise, the shell's width is used for both widgets. The
    same relations hold for the height of the shell and its child.

    Classes

    Shell inherits behavior and resources from Composite and Core.

    The class pointer is shellWidgetClass.

    The class name is Shell.

    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).

 Shell resource set

 ____________________________________________________________________________
 Name                Class               Type           Default        Access
 ____________________________________________________________________________
 XmNallowShellResize XmCAllowShellResize Boolean        False          CG
 XmNcreatePopup-     XmCCreatePopup-     XtCreatePopup- NULL           CSG
 ChildProc           ChildProc           ChildProc
 XmNgeometry         XmCGeometry         String         NULL           CSG
 XmNoverrideRedirect XmCOverrideRedirect Boolean        False          CSG
 XmNpopdownCallback  XmCCallback         XtCallbackList NULL           C
 XmNpopupCallback    XmCCallback         XtCallbackList NULL           C
 XmNsaveUnder        XmCSaveUnder        Boolean        False          CSG
 XmNvisual           XmCVisual           Visual *       CopyFromParent CSG

    XmNallowShellResize
            Specifies that if this resource is False, the Shell widget
            instance returns XtGeometryNo to all geometry requests from its
            children.

    XmNcreatePopupChildProc
            Specifies the pointer to a function that is called when the Shell
            widget instance is popped up by XtPopup.  The function creates
            the child widget when the shell is popped up instead of when the
            application starts up.  This can be used if the child needs to be
            reconfigured each time the shell is popped up.  The function
            takes one argument, the popup shell, and returns no result.  It
            is called after the popup callbacks specified by XmNpopupCall-
            back.

    XmNgeometry
            Specifies the desired geometry for the widget instance. This
            resource is examined only when the widget instance is unrealized
            and the number of its managed children is changed. It is to
            change the values of the XmNx, XmNy, XmNwidth, and XmNheight
            resources.

    XmNoverrideRedirect
            Specifies this is True if the widget instance is a temporary win-
            dow which should be ignored by the window manager. Applications
            and users should not normally alter this resource.

    XmNpopdownCallback
            Specifies a list of callbacks that is called when the widget
            instance is popped down by XtPopdown.

    XmNpopupCallback
            Specifies a list of callbacks that is called when the widget
            instance is popped up by XtPopup.

    XmNsaveUnder
            Specifies a True value if it is desirable to save the contents of
            the screen beneath this widget instance, avoiding expose events
            when the instance is unmapped. This is a hint, and an implementa-
            tion may save contents whenever it desires, including always or
            never.

    XmNvisual
            Specifies the visual used in creating the widget.

    Inherited resources

    Shell inherits behavior and resources from the following superclass. For
    a complete description of each resource, refer to the man page for that
    superclass.

 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
 XmNancestorSensi-   XmCSensitive         Boolean        dynamic       G
 tive
 XmNbackground       XmCBackground        Pixel          dynamic       CSG
 XmNbackground-      XmCPixmap            Pixmap         XmUNSPEC-     CSG
 Pixmap                                                  IFIED_PIXMAP
 XmNborderColor      XmCBorderColor       Pixel          XtDefault-    CSG
                                                         Foreground
 XmNborderPixmap     XmCPixmap            Pixmap         XmUNSPEC-     CSG
                                                         IFIED_PIXMAP
 XmNborderWidth      XmCBorderWidth       Dimension      1             CSG
 XmNcolormap         XmCColormap          Colormap       dynamic       CG
 XmNdepth            XmCDepth             int            dynamic       CG
 XmNdestroyCallback  XmCCallback          XtCallbackList NULL          C
 XmNheight           XmCHeight            Dimension      dynamic       CSG
 XmNinitial-         XmCInitial-          Boolean        True          C
 ResourcesPersistent ResourcesPersistent
 XmNmappedWhen-      XmCMappedWhen-       Boolean        True          CSG
 Managed             Managed
 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

    There are no translations for Shell.

 See also

    Composite(Xm) and Core(Xm).


Typewritten Software • bear@typewritten.org • Edmonds, WA 98026