TopLevelShell

library call

`TopLevelShell`

The TopLevelShell widget class

    &npzwc;#include <Xm/Xm.h>
    &npzwc;#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

`XmNiconic`

- If True when the widget is created, specifies that the widget should start as an icon when it is realized. A value of False indicates that the widget is not to be realized as an icon. This resource will only override the `XmNinitialState` resource when specified in the call that creates the widget.

`XmNiconName`

- Specifies the short form of the application name to be displayed by the window manager when the application is iconified. When `XtGetValues` is called on this resource, the returned value is a pointer to the actual resource value and should not be freed.

`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 reference page for that superclass.

`VendorShell Resource Set`
`Name` | `Class` | `Type` | `Default` | `Access`
XmNaudibleWarning | XmCAudibleWarning | unsigned char | XmBELL | CSG
XmNbuttonFontList | XmCButtonFontList | XmFontList | dynamic | CSG
XmNbuttonRenderTable | XmCButtonRenderTable | XmRenderTable | dynamic | CSG
XmNdefaultFontList | XmCDefaultFontList | XmFontList | dynamic | CG
XmNdeleteResponse | XmCDeleteResponse | unsigned char | XmDESTROY | CSG
XmNinputMethod | XmCInputMethod | String | NULL | CSG
XmNinputPolicy | XmCInputPolicy | XmInputPolicy | XmPER_SHELL | CSG
XmNkeyboardFocusPolicy | XmCKeyboardFocusPolicy | unsigned char | XmEXPLICIT | CSG
XmNlabelFontList | XmCLabelFontList | XmFontList | dynamic | CSG
XmNlabelRenderTable | XmCLabelRenderTabel | XmRenderTable | dynamic | CSG
XmNlayoutDirection | XmCLayoutDirection | XmDirection | XmLEFT_TO_RIGHT | CG
XmNmwmDecorations | XmCMwmDecorations | int | -1 | CG
XmNmwmFunctions | XmCMwmFunctions | int | -1 | CG
XmNmwmInputMode | XmCMwmInputMode | int | -1 | CG
XmNmwmMenu | XmCMwmMenu | String | NULL | CG
XmNpreeditType | XmCPreeditType | String | dynamic | CSG
XmNshellUnitType | XmCShellUnitType | unsigned char | XmPIXELS | CSG
XmNtextFontList | XmCTextFontList | XmFontList | dynamic | CSG
XmNtextRenderTable | XmCTextRenderTable | XmRenderTable | dynamic | CSG
XmNunitType | XmCUnitType | unsigned char | XmPIXELS | 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 | XtUnspecifiedShellInt | CSG
XmNiconY | XmCIconY | int | XtUnspecifiedShellInt | 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

`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
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

There are no translations for TopLevelShell.

## RELATED

&cdeman.Composite;, &cdeman.Core;, &cdeman.Shell;, &cdeman.WMShell;, and &cdeman.VendorShell;.