Shell(library call) Shell(library call)
NAME [Toc] [Back]
Shell - The Shell widget class
SYNOPSIS [Toc] [Back]
#include <Xm/Xm.h>
#include <X11/Shell.h>
DESCRIPTION [Toc] [Back]
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 [Toc] [Back]
Shell inherits behavior and resources from Composite and Core.
The class pointer is shellWidgetClass.
The class name is Shell.
New Resources [Toc] [Back]
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).
- 1 - Formatted: January 24, 2005
Shell(library call) Shell(library call)
______________________________________________________________________________________________________
| 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 |
|________________________|_________________________|________________________|________________|________|
|________________________|_________________________|________________________|________________|________|
XmNallowShellResize [Toc] [Back]
Specifies that if this resource is False, the Shell widget
instance returns XtGeometryNo to all geometry requests from
its children. All Motif convenience create dialog functions
override this default value and set XmNallowShellResize to
True.
XmNcreatePopupChildProc [Toc] [Back]
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 [Toc] [Back]
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 used to change the values of the XmNx, XmNy,
XmNwidth, and XmNheight resources. When XtGetValues is
called on this resource, the returned value is a pointer to
the actual resource value and should not be freed. In
addition, this resource is not copied on creation or by
XtSetValues. The application must ensure that the string
remains valid until the shell is realized.
- 2 - Formatted: January 24, 2005
Shell(library call) Shell(library call)
XmNoverrideRedirect [Toc] [Back]
If True, specifies that the widget instance is a temporary
window that should be ignored by the window manager.
Applications and users should not normally alter this
resource.
XmNpopdownCallback [Toc] [Back]
Specifies a list of callbacks that is called when the widget
instance is popped down by XtPopdown.
XmNpopupCallback [Toc] [Back]
Specifies a list of callbacks that is called when the widget
instance is popped up by XtPopup. The second argument to
XtPopup must be XtGrabNone.
XmNsaveUnder [Toc] [Back]
If True, specifies that 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.
XmNvisual Specifies the visual used in creating the widget.
Inherited Resources [Toc] [Back]
Shell inherits behavior and resources from the superclass described in
the following table. For a complete description of each resource,
refer to the reference 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 |
|__________________|___________________|_____________|_________|________|
|__________________|___________________|_____________|_________|________|
- 3 - Formatted: January 24, 2005
Shell(library call) Shell(library call)
________________________________________________________________________________________________________________
| 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 [Toc] [Back]
There are no translations for Shell.
RELATED [Toc] [Back]
Composite [ Back ] |
