TopLevelShell(X3mot)

TopLevelShell -- the TopLevelShell widget class

Synopsis

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

Description

TopLevelShell is used for normal top-level windows such as any additional top-level widgets an application needs.

Classes

TopLevelShell inherits behavior and resources from Core, Composite, Shell, WMShell, and VendorShell.

The class pointer is topLevelShellWidgetClass.

The class name is TopLevelShell.

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

TopLevelShell resource set

Name Class Type Default Access
XmNiconic XmCIconic Boolean False CSG
XmNiconName XmCIconName String NULL CSG
XmNiconNameEncoding XmCIconNameEncoding Atom dynamic CSG 

 +--------------------+---------------------+---------+---------+--------+
 |Name                | Class               | Type    | Default | Access |
 +--------------------+---------------------+---------+---------+--------+
 |XmNiconic           | XmCIconic           | Boolean | False   | CSG    |
 +--------------------+---------------------+---------+---------+--------+
 |XmNiconName         | XmCIconName         | String  | NULL    | CSG    |
 +--------------------+---------------------+---------+---------+--------+
 |XmNiconNameEncoding | XmCIconNameEncoding | Atom    | dynamic | CSG    |
 +--------------------+---------------------+---------+---------+--------+

XmNiconic
Specifies that if this is True when the widget instance is realized, the widget instance indicates to the window manager that the application wishes to start as an icon, irrespective of the XmNinitialState resource.

XmNiconName
Specifies the short form of the application name to be displayed by the window manager when the application is iconified.

XmNiconNameEncoding
Specifies a property type that represents the encoding of the XmNiconName string. If a language procedure has been set, the default is None; otherwise, the default is XA_STRING. When the widget is realized, if the value is None, the corresponding name is assumed to be in the current locale. The name is passed to XmbTextListToTextProperty with an encoding style of XStdICCTextStyle. The resulting encoding is STRING if the name is fully convertible to STRING, otherwise COMPOUND_TEXT. The values of the encoding resources are not changed; they remain None.

Inherited resources

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

VendorShell resource set

Name Class Type Default Access
XmNaudibleWarning XmCAudibleWarning unsigned char XmBELL CSG
XmNbuttonFontList XmCButtonFontList XmFontList dynamic CSG
XmNdefaultFontList XmCDefaultFontList XmFontList dynamic CG
XmNdeleteResponse XmCDeleteResponse unsigned char XmDESTROY CSG
XmNinputMethod XmCInputMethod String NULL CSG
XmNkeyboardFocusPolicy XmCKeyboardFocusPolicy unsigned char XmEXPLICIT
CSG        
XmNlabelFontList XmCLabelFontList XmFontList dynamic CSG
XmNmwmDecorations XmCMwmDecorations int -1 CSG
XmNmwmFunctions XmCMwmFunctions int -1 CSG
XmNmwmInputMode XmCMwmInputMode int -1 CSG
XmNmwmMenu XmCMwmMenu String NULL CSG
XmNpreeditType XmCPreeditType String dynamic CSG
XmNshellUnitType XmCShellUnitType unsigned char XmPIXELS CSG
XmNtextFontList XmCTextFontList XmFontList dynamic CSG
XmNuseAsyncGeometry XmCUseAsyncGeometry Boolean False CSG 

 +-----------------------+------------------------+---------------+-----------+------------+
 |Name                   | Class                  | Type          | Default   | Access     |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNaudibleWarning      | XmCAudibleWarning      | unsigned char | XmBELL    | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNbuttonFontList      | XmCButtonFontList      | XmFontList    | dynamic   | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNdefaultFontList     | XmCDefaultFontList     | XmFontList    | dynamic   | CG         |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNdeleteResponse      | XmCDeleteResponse      | unsigned char | XmDESTROY | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNinputMethod         | XmCInputMethod         | String        | NULL      | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNkeyboardFocusPolicy | XmCKeyboardFocusPolicy | unsigned      | char      | XmEXPLICIT |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNlabelFontList       | XmCLabelFontList       | XmFontList    | dynamic   | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNmwmDecorations      | XmCMwmDecorations      | int           | -1        | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNmwmFunctions        | XmCMwmFunctions        | int           | -1        | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNmwmInputMode        | XmCMwmInputMode        | int           | -1        | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNmwmMenu             | XmCMwmMenu             | String        | NULL      | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNpreeditType         | XmCPreeditType         | String        | dynamic   | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNshellUnitType       | XmCShellUnitType       | unsigned char | XmPIXELS  | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNtextFontList        | XmCTextFontList        | XmFontList    | dynamic   | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+
 |XmNuseAsyncGeometry    | XmCUseAsyncGeometry    | Boolean       | False     | CSG        |
 +-----------------------+------------------------+---------------+-----------+------------+

WMShell resource set

Name Class Type Default Access
XmNbaseHeight XmCBaseHeight int XtUnspecifiedShellInt CSG
XmNbaseWidth XmCBaseWidth int XtUnspecifiedShellInt CSG
XmNheightInc XmCHeightInc int XtUnspecifiedShellInt CSG
XmNiconMask XmCIconMask Pixmap NULL CSG
XmNiconPixmap XmCIconPixmap Pixmap NULL CSG
XmNiconWindow XmCIconWindow Window NULL CSG
XmNiconX XmCIconX int -1 CSG
XmNiconY XmCIconY int -1 CSG
XmNinitialState XmCInitialState int NormalState CSG
XmNinput XmCInput Boolean True CSG
XmNmaxAspectX XmCMaxAspectX int XtUnspecifiedShellInt CSG
XmNmaxAspectY XmCMaxAspectY int XtUnspecifiedShellInt CSG
XmNmaxHeight XmCMaxHeight int XtUnspecifiedShellInt CSG
XmNmaxWidth XmCMaxWidth int XtUnspecifiedShellInt CSG
XmNminAspectX XmCMinAspectX int XtUnspecifiedShellInt CSG
XmNminAspectY XmCMinAspectY int XtUnspecifiedShellInt CSG
XmNminHeight XmCMinHeight int XtUnspecifiedShellInt CSG
XmNminWidth XmCMinWidth int XtUnspecifiedShellInt CSG
XmNtitle XmCTitle String dynamic CSG
XmNtitleEncoding XmCTitleEncoding Atom dynamic CSG
XmNtransient XmCTransient Boolean False CSG
XmNwaitForWm XmCWaitForWm Boolean True CSG
XmNwidthInc XmCWidthInc int XtUnspecifiedShellInt CSG
XmNwindowGroup XmCWindowGroup Window dynamic CSG
XmNwinGravity XmCWinGravity int dynamic CSG
XmNwmTimeout XmCWmTimeout int 5000 ms CSG 

 +-----------------+------------------+---------+-----------------------+--------+
 |Name             | Class            | Type    | Default               | Access |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNbaseHeight    | XmCBaseHeight    | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNbaseWidth     | XmCBaseWidth     | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNheightInc     | XmCHeightInc     | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNiconMask      | XmCIconMask      | Pixmap  | NULL                  | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNiconPixmap    | XmCIconPixmap    | Pixmap  | NULL                  | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNiconWindow    | XmCIconWindow    | Window  | NULL                  | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNiconX         | XmCIconX         | int     | -1                    | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNiconY         | XmCIconY         | int     | -1                    | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNinitialState  | XmCInitialState  | int     | NormalState           | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNinput         | XmCInput         | Boolean | True                  | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNmaxAspectX    | XmCMaxAspectX    | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNmaxAspectY    | XmCMaxAspectY    | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNmaxHeight     | XmCMaxHeight     | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNmaxWidth      | XmCMaxWidth      | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNminAspectX    | XmCMinAspectX    | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNminAspectY    | XmCMinAspectY    | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNminHeight     | XmCMinHeight     | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNminWidth      | XmCMinWidth      | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNtitle         | XmCTitle         | String  | dynamic               | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNtitleEncoding | XmCTitleEncoding | Atom    | dynamic               | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNtransient     | XmCTransient     | Boolean | False                 | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNwaitForWm     | XmCWaitForWm     | Boolean | True                  | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNwidthInc      | XmCWidthInc      | int     | XtUnspecifiedShellInt | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNwindowGroup   | XmCWindowGroup   | Window  | dynamic               | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNwinGravity    | XmCWinGravity    | int     | dynamic               | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+
 |XmNwmTimeout     | XmCWmTimeout     | int     | 5000 ms               | CSG    |
 +-----------------+------------------+---------+-----------------------+--------+

Shell resource set

Name Class Type Default Access
XmNallowShellResize XmCAllowShellResize Boolean False CG
XmNcreatePopupChildProc XmCCreatePopupChildProc XtCreatePopupChildProc NULL CSG
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 

 +------------------------+-------------------------+------------------------+----------------+--------+
 |Name                    | Class                   | Type                   | Default        | Access |
 +------------------------+-------------------------+------------------------+----------------+--------+
 |XmNallowShellResize     | XmCAllowShellResize     | Boolean                | False          | CG     |
 +------------------------+-------------------------+------------------------+----------------+--------+
 |XmNcreatePopupChildProc | XmCCreatePopupChildProc | XtCreatePopupChildProc | NULL           | CSG    |
 +------------------------+-------------------------+------------------------+----------------+--------+
 |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    |
 +------------------------+-------------------------+------------------------+----------------+--------+

Composite resource set

Name Class Type Default Access
XmNchildren XmCReadOnly WidgetList NULL G
XmNinsertPosition XmCInsertPosition XtOrderProc NULL CSG
XmNnumChildren XmCReadOnly Cardinal 0 G 

 +------------------+-------------------+-------------+---------+--------+
 |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
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 1 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 

 +------------------------------+-------------------------------+----------------+----------------------+--------+
 |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      | 1                    | 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

There are no translations for TopLevelShell.

References

Composite(X3mot), Core(X3mot), Shell(X3mot), WMShell(X3mot) and VendorShell(X3mot).
25 April 2004
© 2004 The SCO Group, Inc. All rights reserved.
UnixWare 7 Release 7.1.4 - 25 April 2004