'\"!  tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | eqn | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | tbl | eqn | tbl | mmdoc
'\"macro stdmacro
.if n .pH g3w.olShResourc @(#)olShResourc	40.3 of 1/8/90
.tr ~
.EQ
delim $$
.EN
.ds oS SHELL
.nr oN 0
.nr X
.if \nX=0 .ds x} ""SHELL RESOURCES" 3W "\&"
.if \nX=1 .ds x} ""SHELL RESOURCES" 3W
.if \nX=2 .ds x} ""SHELL RESOURCES" "" "\&"
.if \nX=3 .ds x} ""SHELL "" "" "\&"
.TH \*(x}
.SH "DESCRIPTION"
.P
\f3Resources for Shell Class Widgets\f1
.P
These are resources that are common to all widget classes that
are subclasses of Shell.
They are described here to avoid repeating their descriptions
for each shell widget.
.sp
\f(HBNote:\f1 
.br
The behavior described for many of these resources assume the
OPEN LOOK window manager for the X~Window System is being used.
.in
.sp
\f3Bases Window and Popup Windows\f1
.P
All OPEN LOOK base windows are created using one of the routines:
\f4OlInitialize()\f1
or
\f4XtCreateApplicationShell()\f1.
OPEN LOOK pop-up windows (the \f3PopupWindow\f1, \f3Menu\f1,
and \f3Notice\f1 widgets) are created using
\f4XtCreatePopupShell()\f1.
An application may define other pop-up windows that can be
created using
\f4XtCreatePopupShell()\f1.
.P
The following resources are typical of base windows and generic
pop-up windows,
but not all are available for the pop-up windows defined in
this toolkit.
See the list of resources for the
\f3PopupWindow\f1,
\f3Menu\f1,
and
\f3Notice\f1
widgets to see which are available.
The
\f3Access\f1
column in this table identifies the access for base windows
only.
.TS 
expand,allbox;
cB s s s
l1Bp-2 l1Bp-2 l1Bp-2 l1Bp-2
l1p-2 l1p-2 l1p-2 l1p-2.
Pop-up and Base Window Resource Set
T{
.sp
Name
T}	T{
.sp
Class
T}	T{
.sp
Type
T}	T{
Access
.br
(Base Window)
T}
_
XtNallowShellResize	XtCAllowShellResize	Boolean	SGI
XtNcreatePopupChildProc	XtCCreatePopupChildProc	XtCreatePopupChildProc	SGI
XtNgeometry	XtCGeometry	String	GI
XtNheightInc	XtCHeightInc	int	SGI
XtNinitialState	XtCInitialState	int	GI
XtNinput	XtCInput	Boolean	G
XtNmaxAspectX	XtCMaxAspectX	Position	SGI
XtNmaxAspectY	XtCMaxAspectY	Position	SGI
XtNmaxHeight	XtCMaxHeight	Dimension	SGI
XtNmaxWidth	XtCMaxWidth	Dimension	SGI
XtNminAspectX	XtCMinAspectX	Position	SGI
XtNminAspectY	XtCMinAspectY	Position	SGI
XtNminHeight	XtCMinHeight	Dimension	SGI
XtNminWidth	XtCMinWidth	Dimension	SGI
XtNoverrideRedirect	XtCOverrideRedirect	Boolean	SGI
XtNpopdownCallback	XtCCallback	XtCallbackList	SI
XtNpopupCallback	XtCCallback	XtCallbackList	SI
XtNsaveUnder	XtCSaveUnder	Boolean	SGI
.TE
.sp
.TS
center, allbox;
cB s s s
l1Bp-2 l1Bp-2 l1Bp-2 l1Bp-2
l1p-2w(1i) l1p-2w(1i) l1p-2w(0.75i) l1p-2w(1i).
Pop-up and Base Window Resource Set (cont.)\f1
T{
.sp
Name
T}	T{
.sp
Class
T}	T{
.sp
Type
T}	T{
Access
.br
(Base Window)
T}
_
XtNtitle	XtCTitle	String	SGI
XtNtransient	XtCTransient	Boolean	SGI
XtNwaitForWm	XtCWaitForWm	Boolean	G
XtNwidthInc	XtCWidthInc	int	SGI
XtNwindowGroup	XtCWindowGroup	Window	SGI
XtNwmTimeout	XtCWmTimeout	int	G
.TE
.P
In addition to the resources listed above,
OPEN LOOK base windows have the following resources:
.TS
center, allbox;
cB s s s
l1Bp-2 l1Bp-2 l1Bp-2 l1Bp-2
l1p-2w(1i) l1p-2w(1i) l1p-2w(0.75i) l1p-2w(0.5i).
Base Window Shell Resource Set
Name	Class	Type	Access
_
XtNfocusWidget	XtCFocusWidget	Widget	SG
XtNiconic	XtCIconic	Boolean	GI
XtNiconMask	XtCIconMask	Pixmap	SGI
XtNiconName	XtCIconName	String	SGI
XtNiconPixmap	XtCIconPixmap	Pixmap	SGI
XtNiconWindow	XtCIconWindow	Window	SGI
XtNiconX	XtCIconX	Position	GI
XtNiconY	XtCIconY	Position	GI
.TE
.sp
\f3XtNallowShellResize\f1
.P
Range of Values:
.br
.in +5
.nf
\f4TRUE
FALSE\f1
.in -5
.fi
.PP
This resource controls whether the shell widget is allowed to
resize itself in response to a geometry request from its child.
If set to
\f4TRUE\f1, it will attempt 
to resize itself as requested by the child.
The attempt may be refused by the window manager,
which will cause the shell widget to refuse the geometry
management request of its child.
Otherwise, it accepts the request.
If the
\f4XtNallowShellResize\f1
request is set to
\f4FALSE\f1, the shell widget 
will immediately refuse the geometry
management request.
.sp
\f3XtNcreatePopupChildProc\f1
.P
This resource defines a pointer to a single function
(not a callback list)
that is called during the process of popping up the shell
widget.
It is called after the
\f4XtNpopupCallback\f1
callbacks are issued but before the shell widget is realized
and mapped.
The function is passed a single argument,
the ID of the shell widget.
.bp
\f3XtNfocusWidget\f1
.PP
Default value:  \f(CW(Widget)()\fP
.PP
This resource determines which widget gets input focus when a
window is selected by a user.  If not initialized by the
programmer, it defaults to the first created widget among its
descendants capable of accepting input focus.  Whenever the user
selects a field that can accept input focus, this 
resource is automatically updated to reference the selected
widget.
.sp
\f3XtNgeometry\f1
.PP
Range of Values:
.br
.in +5
(any syntactically correct argument to the \f4XParseGeometry()\f1 function).
.in -5
.PP
This resource can be used to specify the size and position of the
shell widget when it pops up.
.sp
\f3XtNheightInc\f1
.br
.br
\f3XtNwidthInc\f1
.PP
Range of Values:
.br
.in +5
.nf
\f40 \(<= XtNheightInc
0 \(<= XtNwidthInc\f1
.in -5
.fi
.PP
These resources define an arithmetic progression of sizes,
from
\f4XtNminHeight\f1
and
\f4XtNminWidth\f1
to
\f4XtNmaxHeight\f1
and
\f4XtNmaxWidth\f1,
into which the shell widget prefers to be resized by the window
manager.
.sp
\f3XtNiconic\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4TRUE
FALSE\f1
.in -5
.fi
.PP
This resource provides an equivalent method of setting the
\f4XtNinitialState\f1
resource to
\f4IconicState\f1.
.sp
\f3XtNiconMask\f1
.P
This resource defines an image that specifies which pixels of
the
\f4XtNiconPixmap\f1
resource should be used for the base window's icon.
This image must be a single plane pixmap.
.sp 
\f3XtNiconName\f1
.P
This resource defines a name that the window manager will
display in the shell widget's icon.
If the
\f4XtNtitle\f1
resource is not defined or is
\f4NULL\f1,
this resource is used instead.
If this resource is
\f4NULL\f1,
the name of the application is used in its place.
.bp
\f3XtNiconPixmap\f1
.P
This resource defines the image to be used as the base window's
icon.
It must be a single plane pixmap.
.sp
\f3XtNiconWindow\f1
.PP
Range of Values:
.br
.in +5
(ID of any existing window)
.in -5
.PP
This resource defines the ID of a window that the window
manager should use for the base window's icon,
in place of
\f4XtNiconPixmap\f1.
The
\f4XtNiconWindow\f1
takes precedence over the
\f4XtNiconPixmap\f1
resource.
.sp 0.75
\f3XtNiconX\f1
.br
.br
\f3XtNiconY\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4-1 \(<= XtNiconX
-1 \(<= XtNiconY\f1
.in -5
.fi
.PP
These resources define the location where the base window's
icon should appear.
If the value of one of these resources is -1,
the window manager automatically picks a value,
according to its icon placement requirements.
.sp
\f3XtNinitialState\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4NormalState/"1"
IconicState/"3"\f1
.in -5
.fi
.PP
This resource defines how the base window (and associated pop-up
windows) appears when the application starts up.
.IP \f4NormalState\f1 12
When set to this value, the application starts up with its base
window open.
.IP \f4IconicState\f1 12 
When set to this value, the application starts up with its base
window closed into an icon.
.P
\f(HBNote:\f1
.br
Other values are defined by the X\ Window System for this
resource,
but the OPEN LOOK window manager recognizes only the iconic and
normal states.
.sp
\f3XtNinput\f1
.P
This resource controls the type of input focus behavior of the
application.
This resource should not be set by an application.
.bp
\f3XtNmaxAspectX\f1
.br
\f3XtNmaxAspectY\f1
.br
\f3XtNminAspectX\f1
.br
\f3XtNminAspectY\f1
.P
Range of Values:
.br
.in +5
.nf
\f4 -1 = XtNmaxAspectX, 1 \(<= XtNmaxAspectX
 -1 = XtNmaxAspectY, 1 \(<= XtNmaxAspectY
 -1 = XtNminAspectX, 1 \(<= XtNminAspectX
 -1 = XtNminAspectY, 1 \(<= XtNminAspectY\f1
.in -5
.P
.fi
.in +5
.EQ C
"\s-2\f4XtNminAspectX\f1\s+2" over "\s-2\f4XtNminAspectY\f1\s+2"~<=~ "\s-2\f4XtNmaxAspectX\f1\s+2" over "\s-2\f4XtNmaxAspectY\f1\s+2"
.EN
.in -5
.PP
These resources define the range of aspect ratios allowed for
the size of the shell widget's window.
Assuming the width and height of the window are given by
\f2width\f1
and
\f2height\f1,
the following relation shows how the window size is constrained:
.P
.in +5
.EQ C
"\s-2\f4XtNminAspectX\f1\s+2" over "\s-2\f4XtNminAspectY\f1\s+2"~<=~ "\s-2\f2width\f1\s+2" over "\s-2\f2height\f1\s+2" ~<=~ "\s-2\f4XtNmaxAspectX\f1\s+2" over "\s-2\f4XtNmaxAspectY\f1\s+2"
.EN
.in -5
.P
If the end user tries to resize the window to a narrower or
wider aspect ratio than allowed by these resources,
the window manager adjusts the window to the closest allowed
aspect ratio.
If possible, it will do this by increasing the width or height
to compensate.
The
\f4XtNmaxHeight\f1
and
\f4XtNmaxWidth\f1
resources may force the window manager to reduce the width or
height instead.
.P
If the values of these resources are -1,
the window manager does not constrain the size of the window to
any aspect ratio.
.P
\f(HBNote:\f1 
.br
An application should either set all values to -1
(the default)
or should set all to a positive value.
An application should never set a value of zero to any of these
resources.
.in
.sp
\f3XtNmaxHeight\f1
.br
.br
\f3XtNmaxWidth\f1
.br
.br
\f3XtNminHeight\f1
.br
.br
\f3XtNminWidth\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4XtNminHeight \(<= XtNmaxHeight
XtNminWidth \(<= XtNmaxWidth\f1
(or \f(CWOL_IGNORE\f1 for any of these resources)
.in -5
.fi
.PP
These resources define the range allowed for the size of the
shell widget's window.
If the end user tries to resize the window smaller or larger
than these values allow,
the window manager adjusts the width and/or height to
compensate.
.P
The default value of \f(CWOL_IGNORE\f1 keeps the window manager from
constraining the window's size.
.bp
\f3XtNoverrideRedirect\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4TRUE
FALSE\f1
.in -5
.fi
.PP
This resource controls whether the shell widget's window is
managed by the window manager.
Since this OPEN LOOK toolkit is designed to have a certain
pop-up window behavior,
this resource should not be set by an application for the shell
widgets defined in this toolkit
(\f3Menu\f1,
\f3Notice\f1,
and
\f3PopupWindow\f1).
.sp
\f3XtNpopdownCallback\f1
.P
This resource defines callbacks automatically issued right
after the shell widget's window has been unmapped (i.e. popped down.)
.sp
\f3XtNpopupCallback\f1
.P
This resource defines callbacks automatically issued right
before the shell widget is realized and mapped (i.e. popped
up.)
.sp
\f3XtNsaveUnder\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4TRUE
FALSE\f1
.in -5
.fi
.PP
This resource directs the shell widget to instruct the server
to attempt to save the contents of windows obscured by the
shell when it is mapped,
and to restore the contents when the shell widget is unmapped.
.sp
\f3XtNtitle\f1
.P
This resource gives the title to include in the header of the
base or pop-up window.
Widgets of other classes besides
\f3Shell\f1
may have a resource with the same name.
.sp
\f3XtNtransient\f1
.PP
Range of Values:
.br
.in +5
.nf
\f4TRUE
FALSE\f1
.in -5
.fi
.PP
This resource controls whether the shell widget's window is
"transient" and is to be unmapped when the associated base
window is iconified
(see
\f4XtNwindowGroup\f1).
Since this OPEN LOOK toolkit is designed to have a certain
pop-up window behavior,
this resource should not be set by an application for the shell
widgets defined in this toolkit
(\f3Menu\f1,
\f3Notice\f1,
and
\f3PopupWindow\f1).
.sp
\f3XtNwaitForWm\f1
.P
This resource should not be set by an application.
.bp
\f3XtNwindowGroup\f1
.PP
Range of Values:
.br
.in +5
.nf
\f1(ID of any existing window)
.in -5
.fi
.P
This resource identifies the base window associated with this
shell widget's window.
When the end user closes the base window,
all its associated windows are unmapped (pop-up windows or
other shell widget windows with
\f4XtNtransient\f1
set to
\f4TRUE\f1)
or closed
(base windows with
\f4XtNtransient\f1
set to
\f4FALSE\f1).
.sp
\f3XtNwmTimeout\f1
.P
This resource should not be set by an application.
