Blob Blame History Raw
'\" t
...\" Shell.sgm /main/10 1996/09/08 21:42:25 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "Shell" "library call"
.SH "NAME"
\fBShell\fP \(em The Shell widget class
.iX "Shell"
.iX "widget class" "Shell"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
#include <X11/Shell\&.h>
.fi
.SH "DESCRIPTION"
.PP
Shell is a top-level widget (with only one managed child) that encapsulates
the interaction with the window manager\&.
.PP
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\&.
.SS "Classes"
.PP
Shell inherits behavior and resources from \fBComposite\fP and \fBCore\fP\&.
.PP
The class pointer is \fBshellWidgetClass\fP\&.
.PP
The class name is \fBShell\fP\&.
.SS "New Resources"
.PP
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 \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or
\fBXmC\fP prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP 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 \fBXtSetValues\fP (S),
retrieved by using \fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBShell Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNallowShellResizeXmCAllowShellResizeBooleanFalseCG
_____
XmNcreatePopupChildProcXmCCreatePopupChildProcXtCreatePopupChildProcNULLCSG
_____
XmNgeometryXmCGeometryStringNULLCSG
_____
XmNoverrideRedirectXmCOverrideRedirectBooleanFalseCSG
_____
XmNpopdownCallbackXmCCallbackXtCallbackListNULLC
_____
XmNpopupCallbackXmCCallbackXtCallbackListNULLC
_____
XmNsaveUnderXmCSaveUnderBooleanFalseCSG
_____
XmNvisualXmCVisualVisual *CopyFromParentCSG
_____
.TE
.IP "\fBXmNallowShellResize\fP" 10
Specifies that if this resource is False, the Shell widget instance
returns \fBXtGeometryNo\fP to all geometry requests from its children\&.
All Motif convenience create dialog functions override this default
value and set \fBXmNallowShellResize\fP to True\&.
.IP "\fBXmNcreatePopupChildProc\fP" 10
Specifies the pointer to a function that is called when the Shell
widget instance is popped up by \fBXtPopup\fP\&.
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
\fBXmNpopupCallback\fP\&.
.IP "\fBXmNgeometry\fP" 10
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 \fBXmNx\fP, \fBXmNy\fP, \fBXmNwidth\fP, and \fBXmNheight\fP
resources\&.
When \fBXtGetValues\fP 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 \fBXtSetValues\fP\&. The application must ensure that
the string remains valid until the shell is realized\&.
.IP "\fBXmNoverrideRedirect\fP" 10
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\&.
.IP "\fBXmNpopdownCallback\fP" 10
Specifies a list of callbacks that is called when the widget instance
is popped down by \fBXtPopdown\fP\&.
.IP "\fBXmNpopupCallback\fP" 10
Specifies a list of callbacks that is called when the widget instance
is popped up by \fBXtPopup\fP\&.
The second argument to \fBXtPopup\fP must be \fBXtGrabNone\fP\&.
.IP "\fBXmNsaveUnder\fP" 10
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\&.
.IP "\fBXmNvisual\fP" 10
Specifies the visual used in creating the widget\&.
.SS "Inherited Resources"
.PP
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\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBComposite Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNchildrenXmCReadOnlyWidgetListNULLG
_____
XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG
_____
XmNnumChildrenXmCReadOnlyCardinal0G
_____
.TE
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBCore Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicCSG
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
_____
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderWidthXmCBorderWidthDimension0CSG
_____
XmNcolormapXmCColormapColormapdynamicCG
_____
XmNdepthXmCDepthintdynamicCG
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
_____
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
_____
XmNscreenXmCScreenScreen *dynamicCG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.SS "Translations"
.PP
There are no translations for Shell\&.
.SH "RELATED"
.PP
\fBComposite\fP(3) and \fBCore\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:16