SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
DESCRIPTION
Resources for Shell Class Widgets 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.
Note:
The behavior described for many of these resources assume
the OPEN LOOK window manager for the X Window System is
being used.
Bases Window and Popup Windows All OPEN LOOK base windows
are created using one of the routines: OlInitialize() or
XtCreateApplicationShell(). OPEN LOOK pop-up windows (the
PopupWindow, Menu, and Notice widgets) are created using
XtCreatePopupShell(). An application may define other pop-
up windows that can be created using XtCreatePopupShell().
The following resources are typical of base windows and gen-
eric pop-up windows, but not all are available for the pop-
up windows defined in this toolkit. See the list of
resources for the PopupWindow, Menu, and Notice widgets to
see which are available. The Access column in this table
identifies the access for base windows only.
______________________________________________________________________________________
_________________________Pop-up_and_Base_Window_Resource_Set__________________________
Access
Name Class Type (Base Window)
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____________
Amiga Unix Last change: 1
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNpopupCallback XtCCallback XtCallbackList SI
______________________________________________________________________________________
_XtNsaveUnder____________XtCSaveUnder____________Boolean________________SGI___________
| | | | |
| __________________|_______________________|_______ | |
| | ___Pop-up_and_Base|Window_Resource_Set_(con
|t.)__|_ | |
| | | | | | Access | | |
| | Name | Class | Type | (Base Win- | |
| | | | | | dow) | | |
| ||||||| | |
| | XtNtitle | XtCT
|itle | String |SGI | | | |
| |______________|____|_________|________|____|_____| | |
| |_XtNtransient_|_XtCT
|ransient_|_Boolean|SGI_|_____| | |
| | XtNwaitForWm | XtCW
|aitForWm | Boolean|G | | | |
| |______________|____|_________|________|____|_____| | |
| |_XtNwidthInc__|_XtCW
|idthInc__|_int____|SGI_|_____| | |
| | XtNwindowGroup
| XtCW
|indowGroup
| Window |SGI | | | |
| |______________|____|_________|________|____|_____| | |
| |_XtNwmTimeout_|_XtCW
|mTimeout_|_int____|G___|_____| | |
|In addition to the resou
|rces listed above, OPEN
| LOOK base | |
|windows have the followi
|ng resources: | | |
| _________________|_______________________|_____ | |
| |________Base_Windo
|w_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____|
XtNallowShellResize Range of Values:
TRUE
FALSE
This resource controls whether the shell widget is allowed
to resize itself in response to a geometry request from its
child. If set to TRUE, 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 XtNallowShellResize request is
set to FALSE, the shell widget will immediately refuse the
geometry management request.
Amiga Unix Last change: 2
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNcreatePopupChildProc 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 XtNpopupCallback 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.
Amiga Unix Last change: 3
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNfocusWidget
Default value: (Widget)()
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.
XtNgeometry
Range of Values:
(any syntactically correct argument to the XPar-
seGeometry() function).
This resource can be used to specify the size and position
of the shell widget when it pops up.
XtNheightInc
XtNwidthInc
Range of Values:
0 < XtNheightInc
0 < XtNwidthInc
These resources define an arithmetic progression of sizes,
from XtNminHeight and XtNminWidth to XtNmaxHeight and
XtNmaxWidth, into which the shell widget prefers to be
resized by the window manager.
XtNiconic
Range of Values:
TRUE
FALSE
This resource provides an equivalent method of setting the
XtNinitialState resource to IconicState.
XtNiconMask This resource defines an image that specifies
which pixels of the XtNiconPixmap resource should be used
for the base window's icon. This image must be a single
plane pixmap.
XtNiconName This resource defines a name that the window
manager will display in the shell widget's icon. If the
XtNtitle resource is not defined or is NULL, this resource
is used instead. If this resource is NULL, the name of the
application is used in its place.
Amiga Unix Last change: 4
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNiconPixmap This resource defines the image to be used as
the base window's icon. It must be a single plane pixmap.
XtNiconWindow
Range of Values:
(ID of any existing window)
This resource defines the ID of a window that the window
manager should use for the base window's icon, in place of
XtNiconPixmap. The XtNiconWindow takes precedence over the
XtNiconPixmap resource.
XtNiconX
XtNiconY
Range of Values:
-1 < XtNiconX
-1 < XtNiconY
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.
XtNinitialState
Range of Values:
NormalState/"1"
IconicState/"3"
This resource defines how the base window (and associated
pop-up windows) appears when the application starts up.
NormalState When set to this value, the application starts
up with its base window open.
IconicState When set to this value, the application starts
up with its base window closed into an icon.
Note:
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.
XtNinput This resource controls the type of
input focus behavior of the application. This
resource should not be set by an application.
Amiga Unix Last change: 5
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNmaxAspectX
XtNmaxAspectY
XtNminAspectX
XtNminAspectY Range of Values:
-1 = XtNmaxAspectX, 1 < XtNmaxAspectX
-1 = XtNmaxAspectY, 1 < XtNmaxAspectY
-1 = XtNminAspectX, 1 < XtNminAspectX
-1 = XtNminAspectY, 1 < XtNminAspectY
<
XtNminAspectY XtNmaxAspectY
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 width and
height, the following relation shows how the window size is
constrained:
_
< <
If thXtNminAspectYieshe
ti
ogh
re
tsizXtNmaxAspectYto a narrower or
wider aspect ratio than allowed by these resources, the win-
dow 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 XtNmaxHeight and XtNmaxWidth
resources may force the window manager to reduce the width
or height instead. If the values of these resources are -1,
the window manager does not constrain the size of the window
to any aspect ratio. Note:
An application should either set all values to -1 (the
default) or should set all to a positive value. An applica-
tion should never set a value of zero to any of these
resources.
XtNmaxHeight
XtNmaxWidth
XtNminHeight
XtNminWidth
Range of Values:
XtNminHeight < XtNmaxHeight
XtNminWidth < XtNmaxWidth
(or OL_IGNORE for any of these resources)
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. The
default value of OL_IGNORE keeps the window manager from
constraining the window's size.
Amiga Unix Last change: 6
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNoverrideRedirect
Range of Values:
TRUE
FALSE
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 (Menu, Notice, and PopupWin-
dow).
XtNpopdownCallback This resource defines callbacks automati-
cally issued right after the shell widget's window has been
unmapped (i.e. popped down.)
XtNpopupCallback This resource defines callbacks automati-
cally issued right before the shell widget is realized and
mapped (i.e. popped up.)
XtNsaveUnder
Range of Values:
TRUE
FALSE
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.
XtNtitle This resource gives the title to include in the
header of the base or pop-up window. Widgets of other
classes besides Shell may have a resource with the same
name.
XtNtransient
Range of Values:
TRUE
FALSE
This resource controls whether the shell widget's window is
"transient" and is to be unmapped when the associated base
window is iconified (see XtNwindowGroup). 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 (Menu, Notice,
and PopupWindow).
XtNwaitForWm This resource should not be set by an
Amiga Unix Last change: 7
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
application.
Amiga Unix Last change: 8
SHELL RESOURCES(3W)MISC. REFERENCE MANUAL PAGESHELL RESOURCES(3W)
XtNwindowGroup
Range of Values:
(ID of any existing window)
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 XtNtransient set
to TRUE) or closed (base windows with XtNtransient set to
FALSE).
XtNwmTimeout This resource should not be set by an applica-
tion.
Amiga Unix Last change: 9