NAME

Shell—The Shell widget class

SYNOPSIS

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

DESCRIPTION

Shell is a top-level widget (with only one managed child) that encapsulates 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 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). 

Shell Resource Set

NameClassTypeDefaultAccess


XmNallowShellResizeXmCAllowShellResizeBooleanFalseCG

XmNcreatePopupChildProcXmCCreatePopupChildProcXtCreatePopupChildProcNULLCSG

XmNgeometryXmCGeometryStringNULLCSG

XmNoverrideRedirectXmCOverrideRedirectBooleanFalseCSG

XmNpopdownCallbackXmCCallbackXtCallbackListNULLC

XmNpopupCallbackXmCCallbackXtCallbackListNULLC

XmNsaveUnderXmCSaveUnderBooleanFalseCSG

XmNvisualXmCVisualVisual ∗CopyFromParentCSG

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

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 window 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 implementation may save contents whenever it desires, including always or never.

XmNvisualSpecifies 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

NameClassTypeDefaultAccess


XmNchildrenXmCReadOnlyWidgetListNULLG

XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG

XmNnumChildrenXmCReadOnlyCardinal0G

Core Resource Set

NameClassTypeDefaultAccess


XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicCSG

XmNancestorSensitiveXmCSensitiveBooleandynamicG

XmNbackgroundXmCBackgroundPixeldynamicCSG

XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG

XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG

XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG

XmNborderWidthXmCBorderWidthDimension1CSG

XmNcolormapXmCColormapColormapdynamicCG

XmNdepthXmCDepthintdynamicCG

XmNdestroyCallbackXmCCallbackXtCallbackListNULLC

XmNheightXmCHeightDimensiondynamicCSG

XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC

XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG

XmNscreenXmCScreenScreen ∗dynamicCG

XmNsensitiveXmCSensitiveBooleanTrueCSG

XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG

XmNwidthXmCWidthDimensiondynamicCSG

XmNxXmCPositionPosition0CSG

XmNyXmCPositionPosition0CSG

Translations

There are no translations for Shell. 

RELATED INFORMATION

Composite(3X) and Core(3X). 

Sun Release 4.0  —  Last change: