NAME

resources − common OLIT widget resources

DESCRIPTION

The following section describes the resources common to groups of widgets.  A widget can inherit certain resources from an ancestor class in the widget class tree.  For example, every widget has the XtNbackground resource, because all widgets are descended from coreWidgetClass and this resource is defined there, it is a Core resource.  Likewise, widgets that are descended from primitiveWidgetCalss have additional Primitive resources. 

The groups of common resources detailed here are from: the Core class the Manager class the Primitive class shell classes: BaseWindow, PopupWindow, VendorShell flat widget classes and Application. 

In addition to class resources, there are resources that are application wide, that are also deteiled here. 

HOW TO FIND RESOURCES

The point of having common resources in one place is to make it easier to find a given resource for a given widget. 

Each widget manpage has a summary table listing all the user–accessible resources for that widget.  The description for an individual resource will be in one of two places: if the resource is common to more than one widget, and is used generically by the widget, it is described in this manpage ,resources(3w) and the resource is marked with a dagger, †, in the summary table for the widget.  This is the case when the widget does not do anything unique with the resource and the resource can belong to more than one class of widget.  if the resource is unique to that widget in some way, it is described in the manpage on the widget following the summary table, and is not marked in the summary table.  This is the case if the resource only applies to that one clsss of widget or if the resource hase some unique use or meaning to widgets of that class. 

Summary Tables

The summary tables contain the most commonly sought information about the resource:

(C language) type,
default value (if any),
and the accessibility of the resource.

Accompanying the individual description of a resource is a one line summary of the preceeding information, plus the class name of the resource.  The class name of the resource is not repeated in the summary table, and is only found with the individual description. 

The values in the “Access” column of the summary tables are abbreviated as follows:

openlook

In a few instances, it is necessary to use an abbreviation openlook in the resource tables to indicate a value specified by OPEN LOOK that would not fit into the table. Rather than disfigure the table, this abbreviation is used and more discussion, if any, is provided in the individual resource description.

Resource Files

The value taken by a resource can often be set by a resource file, typically, $HOME/.Xdefaults. 

For example, to set TextField widget coloring, you might enter in the .Xdefaults file something like:

∗textEdit∗Background: skyblue
∗textEdit∗FontColor: yellow
∗input∗FocusColor: green

Or for example, to change the binding of the SCROLLDOWN key from Alt <R15> to, say, F5, add this line to your .Xdefaults:

∗scrollDownKey: n<F5>

Resource File Bindings

Note that, in many cases the C language binding for a resource differs from that used in the resource file.  For example, to displayu keyboard accelerators on controls, a program would set XtNshowAccelerators to OL_DISPLAY.  However, in a resource file, this would be done by a line like

∗showAccelerators: display

To accommodate these differences, the values for this resource would be listed as

OL_DISPLAY/display. 

Application Resources

OLIT uses several resources to determine the state of an OPEN LOOK application. 

XtNbackground         Pixel         XtDefaultBackground G
XtNbeep               XtCBackground OL_BEEP_ALWAYS      G
XtNbeepVolume         int           0                   G
XtNcontrolName        String        "Ctrl"              G
XtNdontCare           OlBitMask     LockMask|Mod2Mask   G
XtNdragRightDistance  Dimension     20(pixels)          G
XtNfontColor          Pixel         XtDefaultForeground G
XtNforeground         Pixel         XtDefaultForeground G
XtNhelpModel          OlDefine      OL_POINTER          G
XtNinputFocusColor    Pixel         XtDefaultForeground G
XtNinputWindowColor   Pixel         Yellow              G
XtNlockName           String        "Lock"              G
XtNmenuMarkRegion     Dimension     10(pixels)          G
XtNmnemonicPrefix     Modifiers     Alt                 G
XtNmod1Name           String        "Alt"               G
XtNmod2Name           String        "Mod2"              G
XtNmod3Name           String        "Mod3"              G
XtNmod4Name           String        "Mod4"              G
XtNmod5Name           String        "Mod5"              G
XtNmouseDampingFactor Cardinal      4(points)           G
XtNmouseStatus        Boolean       True                G
XtNmultiClickTimeout  Cardinal      300(millisec)       G
XtNmultiObjectCount   Cardinal      3                   G
XtNselectDoesPreview  Boolean       TRUE                G
XtNshowMnemonics      OlDefine      OL_UNDERLINE        G
XtNshowAccelerators   OlDefine      OL_DISPLAY          G
XtNtextBackground     Pixel         XtDefaultBackground G
XtNtextFontColor      Pixel         XtDefaultForeground G
XtNthreeD             Boolean       TRUE                G

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

Core Resources

These are the resources of the Core class, of which all widget classes are subclasses. 

XtNancestorSensitive Boolean        G
XtNbackground        Pixel          SGI
XtNbackgroundPixmap  Pixmap         SGI
XtNborderColor       Pixel          SGI
XtNborderPixmap      Pixmap         SGI
XtNborderWidth       Dimension      SGI
XtNdepth             Cardinal       GI
XtNdestroyCallback   XtCallbackList SI
XtNheight            Dimension      SGI
XtNmanaged           Boolean        SGI
XtNmappedWhenManaged Boolean        SGI
XtNsensitive         Boolean        GI∗
XtNtranslations      XtTranslations G
XtNwidth             Dimension      SGI
XtNx                 Position       SGI
XtNy                 Position       SGI

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

Flat Widget Layout

All of the flat containers have the same layout characteristics.  The superclass of all flat widgets is a generic row/column manager.  Though each column has its own width and each row has its own height, all columns can have the same width and all rows can have the same height, if desired. 

As a programming note, the efficiency in both processing steps and data requirements increases as the grid becomes more regular in shape.  For example, a grid specifying that all rows must have the same height and all columns must have the same width is the most efficient configuration. 

The flat row/column manager lays out each managed sub-object in row-major order or in column-major order depending on the attributes of the container, starting with the NorthWest corner of the container. 

Row-major order implies every column in the current row is filled before filling any columns in the next row.  Column-major order implies every row in the current column is filled before filling any rows in the next column. 

Sub-objects of flat containers are placed within the grid.  If the sub-object’s width (or height) is less than the column’s width (or row’s height), the sub-object is positioned in accordance to the XtNitemGravity resource.  The following table lists the layout resources of all flat containers:

See the resource tables for each flat container for a more accurate accounting of the default/allowable values for each layout resource. 

XtNgravity       int          CenterGravity    SGI
XtNhPad          XtCGravity   0                SGI
XtNhSpace        Dimension    0                SGI
XtNitemGravity   int          NorthWestGravity SGI
XtNitemMaxHeight Dimension    OL_IGNORE        SGI
XtNitemMaxWidth  Dimension    OL_IGNORE        SGI
XtNitemMinHeight Dimension    OL_IGNORE        SGI
XtNitemMinWidth  Dimension    OL_IGNORE        SGI
XtNlayoutHeight  OlDefine     OL_MINIMIZE      SGI
XtNlayoutType    OlDefine     OL_FIXEDROWS     SGI
XtNlayoutWidth   OlDefine     OL_MINIMIZE      SGI
XtNmeasure       int          1                SGI
XtNsameHeight    OlDefine     OL_ALL           SGI
XtNsameWidth     OlDefine     OL_COLUMNS       SGI
XtNvPad          XtCSameWidth 0                SGI
XtNvSpace        Dimension    0                SGI

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

Manager Resources

The following resources are available to the widgets that are a subclass of the Manager class. 

XtNconsumeEvent    XtCallbackList NULL      SG
XtNinputFocusColor Pixel          Black     SGI
XtNreferenceName   String         NULL      GI
XtNreferenceWidget Widget         NULL      GI
XtNtraversalOn     Boolean        TRUE      SGI
XtNuserData        XtPointer      NULL      SGI

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

Shell Resources

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. 

The behavior described for many of these resources assume the OPEN LOOK window manager for the X~Window System is being used. 

Base Windows and Popup Windows

 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 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 PopupWindow, Menu, and Notice widgets to see which are available.  The “Access” column in this table identifies the access for base windows only. 

XtNallowShellResize Boolean        SGI
XtNgeometry         String         GI
XtNheightInc        int            SGI
XtNinitialState     int            GI
XtNinput            Boolean        G
XtNmaxAspectX       Position       SGI
XtNmaxAspectY       Position       SGI
XtNmaxHeight        Dimension      SGI
XtNmaxWidth         Dimension      SGI
XtNminAspectX       Position       SGI
XtNminAspectY       Position       SGI
XtNminHeight        Dimension      SGI
XtNminWidth         Dimension      SGI
XtNoverrideRedirect Boolean        SGI
XtNpopdownCallback  XtCallbackList SI
XtNpopupCallback    XtCallbackList SI
XtNsaveUnder        Boolean        SGI
XtNtitle            String         SGI
XtNtransient        Boolean        SGI
XtNwaitForWm        Boolean        G
XtNwidthInc         int            SGI
XtNwindowGroup      Window         SGI
XtNwmTimeout        int            G

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

The following table lists generic resources available to the base windows (that is, TopLevelShell and ApplicationShell widgets):

XtNiconic     Boolean  GI
XtNiconMask   Pixmap   SGI
XtNiconName   String   SGI
XtNiconPixmap Pixmap   SGI
XtNiconWindow Window   SGI
XtNiconX      Position GI
XtNiconY      Position GI

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

The previous two tables listed generic resources available to most shells.  The table below, however, lists resources necessary to support the OPEN LOOK look and feel.  These resources are implemented in the VendorShell widget class; and therefore, apply only to shells which are subclasses of the VendorShell widget class (i.e., TransientShell, MenuShell, PopupWindowShell, NoticeShell, TopLevelShell, and ApplicationShell).  Since some of these resources do not apply to all shells (e.g., XtNresizeCorners on menus), see the individual manual pages for a more accurate description of the applicable resources and their default values. 

XtNbusy                 Boolean         SGI
XtNconsumeEvent         XtCallbackList  SGI
XtNfocusWidget          Widget          SGI
XtNmenuButton           Boolean         GI
XtNmenuType             OlDefine        SGI
XtNpushpin              OlDefine        SGI
XtNresizeCorners        Boolean         SGI
XtNuserData             XtPointer       SGI
XtNwindowHeader         Boolean         GI
XtNwmProtocol           XtRCallbackList SGI
XtNwmProtocolInterested int             I

Access:S = XtSetValuesG = XtGetValues
        I = init timeO = other access

XtNaccelerator

 class:XtCAcceleratortype:Stringdefault:NULLNULL’u’access:SGISGI’u’

Group:  Primitive

Action: Defines a single KeyPress event that selects a Primitive widget. 

The format of this string is identical to the translation manager syntax. Virtual Keys can be used in this translation. 

XtNacceleratorText

 class:XtCAcceleratorTexttype:Stringdefault:DynamicDynamic’u’access:SGISGI’u’

Group:  Primitive

Action: Specifies a string describing the associated primitive widget’s accelerator. 

For example, a Help button may set the resource to the string F1 to remind the users that function key 1 is the HELP button.  This text will be displayed to the right of the Primitive label or image if the return from OlQueryAcceleratorDisplay() is OL_DISPLAY. 

This resource defaults to the XtNaccelerator string with + characters inserted between multiple key sequences. 

XtNallowShellResize

 class:XtCAllowShellResizetype:Booleandefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  PopupWindow

Action: Controls whether child’s geometry request causes resize. 

Values: 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.  FALSE – Shell widget immediately refuses the geometry management request. 

XtNancestorSensitive

 class:XtCSenstitivetype:Booleandefault:(n/a)(n/a)’u’access:GG’u’

Group:  Core

Action: Specifies whether the immediate parent of the widget will receive input events. 

Values: TRUE, FALSE

To preserve data integrity, the application should use the XtSetSensitive() routine if it wants to change the resource (see XtNsensitive below). 

XtNbackground

 class:XtCBackgroundtype:Pixeldefault:whitewhite’u’access:SGISGI’u’

Group:  Core, Application

Action: Specifies the background color for the widget. 

Values: any Pixel value valid for the current display, or
any name from the rgb.txt file. 

Note that widgets do not inherit the background color from their parent. 

Note also that any color set by the application when a widget is created or in a later call to XtSetValues() will override the colors set by the user.  Thus applications should consider this and try to allow maximum flexibility for the user. 

XtNbackgroundPixmap

 class:XtCPixmaptype:Pixmapdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Core

Action: Specifies a pixmap to be used for tiling the background. 

The first tile is placed at the upper left hand corner of the widget’s window. 

Note: this resource takes precedence over the XtNbackground resource. 

XtNbeep

 class:XtCBeeptype:OlDefinedefault:OL_BEEP_ALWAYSOL_BEEP_ALWAYS’u’access:GG’u’

Group:  Application

Action: Determines the type of objects that can generate audible warnings to the user. 

Values: OL_BEEP_NEVER/never – no objects should generate audible warnings. 
OL_BEEP_ALWAYS/always – any object can generate audible warnings. 
OL_BEEP_NOTICES/notices – only Notices should generate audible warnings. 

XtNbeepVolume

 class:XtCBeepVolumetype:intdefault:00’u’access:GG’u’

Group:  Application

Action: Specifies a percentage of the keyboard’s normal beep that should be used when generating audible warnings to the user. 

Values: -100 ≤ XtNbeepVolume ≤ 100

See XBell() in "Xlib Reference Manual" from O’Reilly & Associates, Inc. 

XtNborderColor

 class:XtCBorderColortype:Pixeldefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Core

Action: Specifies the color of the border. 

Values: any pixel value valid for the current display or
any name from the rgb.txt file. 

XtNborderPixmap

 class:XtCPixmaptype:Pixmapdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Core

Action: Specifies a pixmap to be used for tiling the border. 

The first tile is placed at the upper left hand corner of the border. 

Note: this resource takes precedence over the XtNborderColor resource. 

XtNborderWidth

 class:XtCBorderWidthtype:Dimensiondefault:00’u’access:SGISGI’u’

Group:  Core

Action: Sets the width of the border for a widget. 

Values: 0 ≤ XtNborderWidth ≤ min(XtNwidth, XtNheight) / 2

Typically the border surrounds the widget’s window on all four sides, but in some widgets it is inside the widget, surrounding a view or control area contained in the widget.  The width is specified in pixels, and a width of zero means no border will show. 

XtNbusy

 class:XtNBusytype:Booleandefault:FALSEFALSE’u’access:SGISGI’u’

Group:  VendorShell

Action: Marks the shell’s window busy. 

Values: TRUE – makes the application window associated with this shell busy.  When a window becomes busy, the window manager grays the window header (if there is one).  FALSE – causes the window to return to its normal appearance and event processing.  Neither the window manager or the toolkit grabs mouse or keyboard events when an application window becomes busy. 

XtNcolormap

 class:XtCColormaptype:Colormapdefault:(parent´s)(parent´s)’u’access:SGISGI’u’

Group:  Shell

Action: Determines the colormap used to interpret pixels drawn in the widget’s window. 

Values: Any colormap supported by the current display and compatible with the widget’s visual resource. 

If not initialized, Shell and DrawArea widgets use their visual resource to find (share or create) the widget’s colormap. 

Only widgets have a colormap resource.  To get the colormap associated with any object use the function OlColormapOfObject(). 

XtNcolorTupleList

 class:XtCColorTupleListtype:OlColorTupledefault:NULLNULL’u’access:OO’u’

Group:  Application

Action: specifies alternative background colors for 3D rendering

Values: Any valid color value for the display. 

The emphasis colors are defined as:

BG0 highlight color, for emphasis

BG1 normal background

BG2 invoked background, for indented and menu choices

BG3 shadow color, used with highlight for 3D effect

These colors would be specified in a defaults file as tuples (BG0, BG1, BG2, BG3) of either numeric or character color values. 

∗colorTupleList:        (#FFFFFF,#000000,#000000,#AAAAAA),\
(pink,gray,green,blue)

The effect of the resource is to make the BG0, BG2, and BG3 colors the highlight, indent, and shadow colors for those widgets whose background color matches BG1. 

Note that this color scheme is slightly different from OPENLOOK in that BG2 and BG3 are not necessarily derived from BG1 by the addition of gray.  This scheme is intended to provide an alternative to the OPEN LOOK arrangement. 

Note that the color tuples cannot be manipulated from a program by ordinary XtGetValues and XtSetValues means.  Instead, the program must use XrmQGetResource and XrmQPutResource. 

XtNconsumeEvent

 class:XtCConsumeEventtype:XtCallbackListdefault:NULLNULL’u’access:SGISGI’u’

Group:  Manager, VendorShell, Primitive

Action: Overrides OLIT’s handling of events. 

Whenever an event is processed by the standard OLIT translation table, the XtNconsumeEvent list is called for the widget in question allowing the application to consume the XEvent. 

The call_data for this resource use data structures of type OlVirtualEventRec.  (See OlLookupInputEvent for more detail of this data structure.) 

To consume an event, the application should turn on (set to TRUE) the consumed field in the call_data argument when a given event is processed. OlAddCallback() must be used instead of XtAddCallback() when adding callbacks to the XtNconsumeEvent callback list. 

XtNcontrolName

 class:XtCControlNametype:Stringdefault:NCtrlNCtrl’u’access:GG’u’

Group:  Application

Action: Specifies the accelerator name of the Control Key. 

See XtNmod1Name below for details. 

XtNcreatePopupChildProc

 class:XtCCreatePopupChildProctype:XtCreatePopupChildProcdefault:NULLNULL’u’access:SGISGI’u’

Group:  PopupShell

Action: Defines a pointer to a single function called during popup (not a callback list). 

The function indicated by this resource 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. 

XtNdepth

 class:XtCDepthtype:intdefault:(parent´s)(parent´s)’u’access:GIGI’u’ Group:  Core

Action: Determines how many bits should be used for each pixel in the widget’s window. 

Values: Any depth supported by the current display. 

The value of this resource is used to set the depth of the widget’s window when the widget is created. 

Only widgets have a depth resource.  To get the depth associated with any object use the function OlDepthOfObject(). 

XtNdestroyCallback

 class:XtCCallbacktype:XtCallbackListdefault:(n/a)(n/a)’u’access:SISI’u’

Group:  Core

Action: Points to callback list for widget destruction. 

XtNdontCare

 class:XtCDontCaretype:OlBitMaskdefault:LockMask|Mod2MaskLockMask|Mod2Mask’u’access:GG’u’

Group:  Application

Action: Specifies modifier bits for mouse button events. 

Values: are determined by ORing the following bit masks:

LockMask – typically the mask associated with the CapsLock key
Mod1Mask
Mod2Mask – typically the mask associated with the NumLock key
Mod3Mask
Mod4Mask
Mod5Mask
ShiftMask
ControlMask

This resource specifies the modifier bits that are ignored when processing mouse button events.  For example, assume the Mod2Mask bit is in the XtNdontCare bits.  Now if the NumLock key is in a set state and the user presses the SELECT mouse button, the press is interpreted as a SELECT button press because the Mod2Mask bit is ignored.  But if the Mod2Mask bit is not in the XtNdontCare bits, the press is not interpreted as a SELECT button press because the internal event handling routine honors the Mod2Mask bit in the XEvent.

XtNdragRightDistance

 class:XtCDragRightDistancetype:Dimensiondefault:20(pixels)20(pixels)’u’access:GG’u’

Group:  Application

Action: Number of pixels the pointer must be dragged to post the MenuButton’s submenu. 

This resource specifies how far, in pixels, the pointer must be dragged over a MenuButton with the MENU button depressed to post the MenuButton’s submenu.  The direction of the drag is to the right.  This resource only applies to MenuButton’s on press-drag-release menus .

XtNfocusWidget

 class:XtCFocusWidgettype:Widgetdefault:(n/a)(n/a)’u’access:SGSG’u’

Group:  VendorShell

Action: Determines which widget gets input focus when user selects window. 

If not initialized by the programmer, this resource defaults to the first created widget among its descendants capable of accepting input focus. 

As focus changes within the shell, this resource is updated to reflect the last widget with focus. 

A resource converter will translate widget names specified in a resource file to a widget id for this resource. 

XtNfontColor

 class:XtCFontColortype:Pixeldefault:XtDefaultForegroundXtDefaultForeground’u’access:SGISGI’u’

Group:  Application

Action: Default font color used by objects which are not scrolling lists or textEdit widgets. 

Values: any pixel value valid for the current display, or
any name from the rgb.txt file

XtNforeground

 class:XtCForegroundtype:Pixeldefault:XtDefaultForegroundXtDefaultForeground’u’access:SGISGI’u’

Group:  Application

Action: Default foreground color used by objects which are not scrolling lists or textEdit widgets. 

Values: any pixel value valid for the current display, or
any name from the rgb.txt file

XtNgeometry

 class:XtCGeometrytype:Stringdefault:(n/a)(n/a)’u’access:GIGI’u’

Group:  PopupWindow

Action: Can be used to specify the size and position of the shell widget when it pops up. 

Values: any syntactically correct argument to the XParseGeometry() function. 

XtNgravity

 class:XtCGravitytype:intdefault:CenterGravityCenterGravity’u’access:SGISGI’u’

Group:  Flat layout

Action: Specifies the collective position of sub-objects. 

Values: WestGravity/
CenterGravity/
NorthGravity/
NorthEastGravity/
NorthWestGravity/
SouthGravity/
SouthEastGravity/
SouthWestGravity/

The gravity resource specifies the position of all sub-objects (i.e., as a group) whenever a tight-fitting bounding box that surrounds the sub-objects has a width, or height, less than the container’s width or height, respectively.  Essentially, this resource specifies how the sub-objects, as a group, float within its container. 

XtNhPad

 class:XtCHPadtype:Dimensiondefault:00’u’access:SGISGI’u’

Group:  Flat layout

Action: Minimum horizontal space to leave around the edges of the container. 

Values: 0 ≤ XtNhPad

XtNhSpace

 class:XtCHSpacetype:Dimensiondefault:00’u’access:SGISGI’u’

Group:  Flat layout

Action: Specify the amount of horizontal space to leave between sub-objects. 

Values: 0 ≤ XtNhSpace

If the sub-objects are of different sizes in a row or column, the spacing applies to the widest or tallest dimension all sub-objects in the row or column. 

XtNheight

 class:XtCHeighttype:Dimensiondefault:(Calculated)(Calculated)’u’access:SGISGI’u’

Group: Core

Action: Contains height of widget’s window, in pixels, not including border. 

Values: 0 ≤ XtNheight

Programs may request a value at creation or through later calls to XtSetValues(), but the request may not succeed because of layout requirements of the parent widget.  The visual representations for some widgets have a fixed height for a given scale.  For these widgets, the XtNheight resource gives the height of the space that contains the widget’s representation; the representation is centered vertically in this space unless otherwise specified. 

XtNheightInc

 class:XtCHeightInctype:intdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  PopupShell

Action: Defines resizing increment for shell. 

Values: 0 ≤ XtNheightInc

This resource defines an arithmetic progression of sizes, from XtNminHeight to XtNmaxHeight into which the shell widget prefers to be resized by the window manager. 

XtNhelpModel

 class:XtCHelpModeltype:OlDefinedefault:OL_POINTEROL_POINTER’u’access:GG’u’

Group: Application

Values: OL_POINTER/ OL_INPUTFOCUS/

The OLIT help model defaults to follow the mouse pointer.  So, when the HELP key is pressed, the item under the pointer is the subject of the help message.  When this resource is set to OL_INPUT_FOCUS, the subject of the help message follows input focus. 

XtNiconMask

 class:XtCIconMasktype:Pixmapdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Base window

Action: Masks XtNiconPixmap to give the base window’s icon. 

This image must be a single plane pixmap. 

XtNiconName

 class:XtCIconNametype:Stringdefault:(n/a)(n/a)’u’access:SGISGI’u’ Group:  Base window

Action: Defines name that window manager displays in 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. 

XtNiconPixmap

 class:XtCIconPixmaptype:Pixmapdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Base window

Action: Defines the image to be used as the base window’s.  icon. 

The image must be a single plane pixmap. 

XtNiconWindow

 class:XtCIconWindowtype:Windowdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Base window

Action: Gives ID of window that replaces XtNiconPixmap as the base window’s icon. 

Value:  ID of existing window. 

The XtNiconWindow takes precedence over the XtNiconPixmap resource. 

XtNiconX

 class:XtCIconXtype:Positiondefault:(n/a)(n/a)’u’access:GIGI’u’

Group:  Base window

Action: Defines the location where the base window’s icon should appear. 

Values: -1 ≤ XtNiconX

If the value of this resource is -1, the window manager automatically picks a value, according to its icon placement requirements. 

XtNiconY

 class:XtCIconYtype:Positiondefault:(n/a)(n/a)’u’access:GIGI’u’

Group:  Base window

Action: Defines the location where the base window’s icon should appear. 

Values: -1 ≤ XtNiconY

If the value of this resource is -1, the window manager automatically picks a value, according to its icon placement requirements. 

XtNiconic

 class:XtCIconictype:Booleandefault:(n/a)(n/a)’u’access:GIGI’u’

Group:  Base window

Action: Provides equivalent way to XtNinitialState to IconicState. 

Values: TRUE, FALSE

XtNinitialState

 class:XtCInitialStatetype:intdefault:(n/a)(n/a)’u’access:GIGI’u’

Group:  PopupWindow

Action: Defines how the base window (and associated pop-up windows) appears when the application starts up. 

Values: NormalState/ the application starts up with its base window open.  IconicState/ the application starts up with its base window closed into an icon. 

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

 class:XtCInputtype:Booleandefault:(n/a)(n/a)’u’access:GG’u’

Group:  PopupWindow

Action: Controls application’s input focus behavior. 

This resource should not be set by an application. 

XtNinputFocusColor

 class:XtCInputFocusColortype:Pixeldefault:RedRed’u’access:SGISGI’u’

Group:  Manager, Primitive

Action: Color used to show that the widget has input focus

Values: valid pixel value for the display, or valid color name

Normally, the color used to show input focus is derived from the value of the XtNinputFocusColor resource and is dynamically maintained.  This dynamic behavior is abandoned if the application explicitly sets this resource either at initialization or through a call to XtSetValues(). 

XtNinputWindowColor

 class:XtCInputWindowColortype:Pixeldefault:YellowYellow’u’access:GG’u’

Group:  Application

Action: Color of window header when focus in window. 

XtNitemGravity

 class:XtCItemGravitytype:intdefault:NorthWestGravityNorthWestGravity’u’access:SGISGI’u’

Group: Flat layout

Action: Specifies how an undersized item fits into its row or column. 

Values: WestGravity/
CenterGravity/
NorthGravity/
NorthEastGravity/
NorthWestGravity/
SouthGravity/
SouthEastGravity/
SouthWestGravity/

This resource is used whenever the item’s width or height is less than the column width or the row height of the place it is to occupy.  The values of XtNsameWidth and XtNsameHeight govern the column’s width and the row’s height. 

XtNitemMaxHeight

 class:XtCItemMaxHeighttype:Dimensiondefault:OL_IGNOREOL_IGNORE’u’access:SGISGI’u’

Group:  Flat layout

Action: Maximum allowable height of sub-objects. 

Values: XtNitemMaxHeight != OL_IGNORE If either this resources or XtNitemMaxWidth has the value OL_IGNORE, the maximum size constraint is ignored. 

XtNitemMaxWidth

 class:XtCItemMaxWidthtype:Dimensiondefault:OL_IGNOREOL_IGNORE’u’access:SGISGI’u’

Group:  Flat layout

Action: Maximum allowable height of sub-objects. 

Values: XtNitemMaxWidth  != OL_IGNORE

If either this resource or XtNitemMaxHeight has the value OL_IGNORE, the maximum size constraint is ignored. 

XtNitemMinHeight

 class:XtCItemMinHeighttype:Dimensiondefault:OL_IGNOREOL_IGNORE’u’access:SGISGI’u’

Group:  Flat layout

Action: Minimum allowable height of sub-objects. 

Values: XtNitemMinHeight != OL_IGNORE

If either this resources or XtNitemMinWidth has the value OL_IGNORE, the minimum size constraint is ignored. 

XtNitemMinWidth

 class:XtCItemMinWidthtype:Dimensiondefault:OL_IGNOREOL_IGNORE’u’access:SGISGI’u’

Group:  Flat layout

Action: Minimum allowable width of sub-objects. 

Values: XtNitemMinWidth != OL_IGNORE

If this resource has a value of OL_IGNORE, the minimum size constraint is ignored. 

XtNlayoutType

 class:XtCLayoutTypetype:OlDefinedefault:OL_FIXEDROWSOL_FIXEDROWS’u’access:SGISGI’u’

Group:  Flat layout

Action: Controls number of rows and columns used to layout sub-object. 

Values: OL_FIXEDCOLS/ fixedcols – The layout should have a maximum number of columns equal to the value specified by the XtNmeasure resource, and there will be enough rows to hold all sub-objects.  Sub-objects are placed in row-major order, i.e., the columns of the current row are filled before filling any columns in the next row.  OL_FIXEDROWS/ fixedrows – The layout should have a maximum number of rows equal to the value specified by the XtNmeasure resource, and there will be enough columns to hold all sub-objects.  Sub-objects are placed in column-major order, i.e., the rows of the current column are filled before filling any rows in the next column. 

XtNlayoutWidth

 class:XtCLayoutWidthtype:OlDefinedefault:OL_MINIMIZEOL_MINIMIZE’u’access:SGISGI’u’

Group:  Flat layout

Action: Specify resize policy of flat containers when sub-objects change. 

Values: OL_MINIMIZE/ minimize – The container will modify its width (or height) to be just large enough to tightly wrap around its sub-objects regardless of its current width (or height).  Thus the container will grow and shrink depending on the size needs of its sub-objects.  OL_MAXIMIZE/ maximize – The container will increase its width (or height) to be just large enough to tightly wrap around its sub-objects regardless of its current width (or height), but will not give up extra space.  Thus the container will grow but never shrink depending on the size needs of its sub-objects.  OL_IGNORE/ ignore – The container will honor its own width and height, i.e., it will not grow or shrink in response to the addition, deletion or altering of its sub-objects. 

These resources are used in resizing when a sub-object is added, removed, or altered.  These resources have no effect when an external force applies a size change to the container, for example, if the application resizes a container. 

XtNlockName

 class:XtCLockNametype:Stringdefault:NLockNLock’u’access:GG’u’

Group:  Application

Action: Specifies the mapping of the CapsLock Key. 

See XtnMod1Name below for details. 

XtNmanaged

 class:XtCManagedtype:Booleandefault:(n/a)(n/a)’u’access:SGISGI’u’ Group:  Core

Action: Determines whether parent does geometry calculations. 

Values: TRUE – the widget is included in the geometry calculations of its parent.  FALSE – the widget is ignored by its parent and is not included in the parent’s geometry calculations. 

XtNmappedWhenManaged

 class:XtCMappedWhenManagedtype:Booleandefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Core

Action: Controls responsibility for mapping and managing widget. 

Values: TRUE – the widget will be mapped as soon as it is both realized and managed.  FALSE – the program is responsible for mapping and unmapping the widget. 

If the value is changed from TRUE to FALSE after the widget has been realized and managed, the widget is unmapped. 

XtNmaxAspectX

 class:XtCMaxAspectXtype:Positiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: define the range of aspect ratios allowed for the size of the shell widget’s window. 

Values:

 -1 = XtNmaxAspectX  or  1 ≤ XtNmaxAspectX
 -1 = XtNmaxAspectY  or  1 ≤ XtNmaxAspectY
 -1 = XtNminAspectX  or  1 ≤ XtNminAspectX
 -1 = XtNminAspectY  or  1 ≤ XtNminAspectY
XtNminAspectX over XtNminAspectY ≤ XtNmaxAspectX over XtNmaxAspectY

Assuming the width and height of the window are given by width and height the following relation shows how the window size is constrained: XtNminAspectX over XtNminAspectY ≤ width over height ≤ XtNmaxAspectX over XtNmaxAspectY

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 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 application should never set a value of zero to any of these resources. 

XtNmaxAspectY

 class:XtCMaxAspectYtype:Positiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: define the range of aspect ratios allowed for the size of the shell widget’s window. 

Values:

 -1 = XtNmaxAspectX  or  1 ≤ XtNmaxAspectX
 -1 = XtNmaxAspectY  or  1 ≤ XtNmaxAspectY
 -1 = XtNminAspectX  or  1 ≤ XtNminAspectX
 -1 = XtNminAspectY  or  1 ≤ XtNminAspectY
XtNminAspectX over XtNminAspectY ≤ XtNmaxAspectX over XtNmaxAspectY

Assuming the width and height of the window are given by width and height the following relation shows how the window size is constrained: XtNminAspectX over XtNminAspectY ≤ width over height ≤ XtNmaxAspectX over XtNmaxAspectY

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 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 application should never set a value of zero to any of these resources. 

XtNmaxHeight

 class:XtCMaxHeighttype:Dimensiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: Defines the range allowed for the size of the shell widget’s window.  If the end user tries to resize the window larger than this value allows, the window manager adjusts the width height to compensate. 

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. 

XtNmaxWidth

 class:XtCMaxWidthtype:Dimensiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  PopupWindow

Action: Defines the range allowed for the width of the shell widget’s window. If the end user tries to resize the window larger than the value allowa, the window manager adjusts the width compensate. 

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. 

XtNmeasure

 class:XtCMeasuretype:intdefault:11’u’access:SGISGI’u’ Group: Flat layout

Action: Gives the number of rows or columns requested from XtNlayoutType.

Values: 0 < XtNmeasure

XtNmenuButton

 class:XtCMenuButtontype:Booleandefault:FALSEFALSE’u’access:GIGI’u’

Group: VendorShell

Values: Determines if the menu button decoration should be drawn in the upper left corner of the shell window’s header The default, TRUE indicates that it should be drawn.  If the XtNpushpin resource is not OL_NONE this resource is ignored. 

XtNmenuMarkRegion

 class:XtCMenuMarkRegiontype:Dimensiondefault:10(pixels)10(pixels)’u’access:GG’u’

Group: Application

This resource represents the width (in pixels) of the MenuButton’s menu mark region. If the pointer is moved into this region with the MENU mouse button depressed, the MenuButton’s submenu is posted.

XtNmenuType

 class:XtCMenuTypetype:OlDefinedefault:(n/a)(n/a)’u’access:SGISGI’u’ Group:  VendorShell
Range of Values:

OL_MENU_FULL/full
OL_MENU_LIMITED/limited"
OL_MENU_CANCEL/cancel
OL_NONE/none

This resource provides the application access to the type of window menu that the  window manager creates. The default value is OL_MENU_FULL for a base shell.  This full menu contains the following entries: Close, Full Size,  Properties, Back, Refresh, and Quit.  Setting this resource to OL_MENU_LIMITED results in a window menu with the following buttons: Dismiss (a MenuButton), Back, Refresh, and Owner?.  PopupWindow and Help shells set this resource to OL_MENU_LIMITED The menu type OL_MENU_CANCEL provides the same menu as the OL_MENU_LIMITED with the exception that the Dismiss button is replaced with a Cancel button.  When the XtNmenuType resource is OL_NONE, the window manager does not create a menu or a menu mark. 

XtNminAspectX

 class:XtCMinAspectXtype:Positiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: define the range of aspect ratios allowed for the size of the shell widget’s window. 

Values:

 -1 = XtNmaxAspectX  or  1 ≤ XtNmaxAspectX
 -1 = XtNmaxAspectY  or  1 ≤ XtNmaxAspectY
 -1 = XtNminAspectX  or  1 ≤ XtNminAspectX
 -1 = XtNminAspectY  or  1 ≤ XtNminAspectY
XtNminAspectX over XtNminAspectY ≤ XtNmaxAspectX over XtNmaxAspectY

Assuming the width and height of the window are given by width and height the following relation shows how the window size is constrained: XtNminAspectX over XtNminAspectY ≤ width over height ≤ XtNmaxAspectX over XtNmaxAspectY

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 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 application should never set a value of zero to any of these resources. 

XtNminAspectY

 class:XtCMinAspectYtype:Positiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: define the range of aspect ratios allowed for the size of the shell widget’s window. 

Values:

 -1 = XtNmaxAspectX  or  1 ≤ XtNmaxAspectX
 -1 = XtNmaxAspectY  or  1 ≤ XtNmaxAspectY
 -1 = XtNminAspectX  or  1 ≤ XtNminAspectX
 -1 = XtNminAspectY  or  1 ≤ XtNminAspectY
XtNminAspectX over XtNminAspectY ≤ XtNmaxAspectX over XtNmaxAspectY

Assuming the width and height of the window are given by width and height the following relation shows how the window size is constrained: XtNminAspectX over XtNminAspectY ≤ width over height ≤ XtNmaxAspectX over XtNmaxAspectY

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 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 application should never set a value of zero to any of these resources. 

Action: define the range of aspect ratios allowed for the size of the shell widget’s window. 

Values:

 -1 = XtNmaxAspectX  or  1 ≤ XtNmaxAspectX
 -1 = XtNmaxAspectY  or  1 ≤ XtNmaxAspectY
 -1 = XtNminAspectX  or  1 ≤ XtNminAspectX
 -1 = XtNminAspectY  or  1 ≤ XtNminAspectY
XtNminAspectX over XtNminAspectY ≤ XtNmaxAspectX over XtNmaxAspectY

Assuming the width and height of the window are given by width and height the following relation shows how the window size is constrained: XtNminAspectX over XtNminAspectY ≤ width over height ≤ XtNmaxAspectX over XtNmaxAspectY

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 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 application should never set a value of zero to any of these resources. 

XtNminHeight

 class:XtCMinHeighttype:Dimensiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

XtNminWidth

 class:XtCMinWidthtype:Dimensiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: Define the range allowed for the size of the shell widget’s window. 

Values: XtNminHeight ≤ XtNmaxHeight
XtNminWidth ≤ XtNmaxWidth
or OL_IGNORE for any of these resources. 

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. 

XtNmnemonic

 class:XtCMnemonictype:unsigned chardefault:NULLNULL’u’access:SGISGI’u’

Group: Primitive

This resource is a single character that is used as a mnemonic accelerator for keyboard operation.  Typing this character modified with the XtNmnemonicPrefix will be equivalent to clicking select on the Primitive widget.  Note that in a Menu shell, the mnemonicPrefix modifier is not needed.  The Primitive widget may visually display this character. 

XtNmnemonicPrefix

 class:XtCMnemonicPrefixtype:Modifiersdefault:AltAlt’u’access:GG’u’

Group: Application

This resource specifies the modifier key that must accompany the mnemonic character when activating an object from the keyboard if that object is not on a menu.  Note: this value is not settable. 

XtNmod1Name

 class:XtCMod1Nametype:Stringdefault:AltAlt’u’access:GG’u’

Group:  Application

Action: Define name of modifier1 key. 

Values: usually Alt, but on some keyboards it may be labeled Meta. 

XtNmod2Name

 class:XtCMod2Nametype:Stringdefault:Mod2Mod2’u’access:GG’u’

Group:  Application

Action: Define name of modifier2 key. 

XtNmod3Name

 class:XtCMod3Nametype:Stringdefault:Mod2Mod2’u’access:GG’u’

Group:  Application

Action: Define name of modifier3 key. 

XtNmod4Name

 class:XtCMod4Nametype:Stringdefault:Mod4Mod4’u’access:GG’u’

Group:  Application

Action: Define name of modifier4 key. 

XtNmod5Name

 class:XtCMod5Nametype:Stringdefault:Mod5Mod5’u’access:GG’u’

Group:  Application

Action: Define name of modifier5 key. 

XtNmouseDampingFactor

 class:XtNmouseDampingFactortype:Cardinaldefault:4(points)4(points)’u’access:GG’u’

Group:  Application

Action: Number of pixels the pointer can be moved before a drag operation is initiated. 

XtNmouseStatus

 class:XtCMouseStatustype:Booleandefault:TrueTrue’u’access:GG’u’

Group:  Application

Action: Indicates whether there is a mouse on the server. 

Values: TRUE, FALSE

XtNmultiClickTimeout

 class:XtCMultiClickTimeouttype:Cardinaldefault:300(millisec)300(millisec)’u’access:GG’u’

Group:  Application

Action: Specifies the number of milliseconds that determines a multi-click. 

This resource sets the time interval between which two mouse button clicks is considered a multi-click, provided the pointer does not move beyond the XtNmouseDampingFactor value. 

XtNmultiObjectCount

 class:XtCMultiObjectCounttype:Cardinaldefault:33’u’access:GG’u’

Group:  Application

Action: Determines repeat count for OL_MOVE direction. keys

This resource determines the number of times the OL_MULTIRIGHT.  OL_MULTILEFT, OL_MULTIUP, OL_MULTIDOWN keys repeat the OL_MOVERIGHT, OL_MOVELEFT, OL_MOVEUP, OL_MOVEDOWN keys, respectively. 

XtNoverrideRedirect

 class:XtCOverrideRedirecttype:Booleandefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: Controls whether shell widget’s window is managed by window manager. 

Values: TRUE, FALSE

No application should set this resource for any OLIT shell widgets: Menu, Notice, or PopupWindow. 

XtNpopdownCallback

 class:XtCCallbacktype:XtCallbackListdefault:(n/a)(n/a)’u’access:SISI’u’

Group:  PopupWindow

Action: Defines callbacks issued just after the shell widget’s window pops down. 

XtNpopupCallback

 class:XtCCallbacktype:XtCallbackListdefault:(n/a)(n/a)’u’access:SISI’u’

Group:  PopupWindow

Action: Defines callbacks issued just before the shell widget is popped up. 

XtNpushpin

 class:XtCPushpintype:OlDefinedefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  VendorShell

Action: Controls whether the pushpin is included in the window’s decorations. 

Values: OL_NONE/none – pushpin is not included in the window’s decorations.  This is the default for base window shells.  OL_OUT/out – adds pushpin to the window’s decorations, and sets its state to be unpinned. This is the default for PopupWindow shells OL_IN/in – adds pushpin to the window’s decorations, and sets its state to be pinned. the default value for this resource in Help shells

Applications can query the state of the pushpin by getting the value of this resource, since it is updated when the pushpin’s state changes. 

If the shell does not have an OPEN LOOK header ( XtNwindowHeader set to FALSE), then XtNpushpin is always OL_NONE, and attempts to change the value are ignored. 

XtNreferenceName

 class:XtCReferenceNametype:Stringdefault:NULLNULL’u’access:SGISGI’u’

Group:  Manager, Primitive

Action: Specifies a position for inserting this widget in its managing ancestor’s traversal list. 

Values: name of a widget already created in the traversal list. 

If the named widget exists in the managing ancestor’s traversal list, this widget will be inserted in front of it.  Otherwise, this widget will be inserted at the end of the list. 

If both the XtNreferenceName and XtNreferenceWidget resources are set, they must refer to the same widget.  If not, a warning is issued and the  widget referred to by name is used. 

XtNreferenceWidget

 class:XtCReferenceWidgettype:Widgetdefault:NULLNULL’u’access:SGISGI’u’

Group:  Manager, Primitive

Action: Specifies position for inserting this widget in its managing ancestor’s traversal list. 

If the reference widget is non-null and exists in the managing ancestor’s traversal list, this widget will be inserted in front of it.  Otherwise, this widget will be inserted at the end of the list. 

If both the XtNreferenceName and XtNreferenceWidget resources are set, they must refer to the same widget.  If not, a warning is issued and the  widget referred to by name is used. 

XtNresizeCorners

 class:XtCResizeCornerstype:Booleandefault:TRUETRUE’u’access:SGISGI’u’

Group:  VendorShell

Action: Determines if the resize corners should be part of the window decorations. 

Values: TRUE – default for the base shell and PopupWindow shell; resize corners are present.  FALSE – for Notice, Help and Menu shells. 

XtNsameHeight

 class:XtCSameHeighttype:OlDefinedefault:OL_ALLOL_ALL’u’access:SGISGI’u’

Group:  Flat layout

Action: Defines which sub-objects are forced to be the same height within the container. 

Values: OL_ALL/ – all sub-objects are to be the same height.  OL_ROWS/rows – all sub-objects appearing in the same row should be the same height.  OL_NONE/none – sub-objects are placed in fixed-height rows but the height of each item is left alone.  The height of each row is the height of the tallest sub-object. 

XtNsameWidth

 class:XtCSameWidthtype:OlDefinedefault:OL_COLUMNSOL_COLUMNS’u’access:SGISGI’u’

Group:  Flat layout

Action: Defines that sub-objects are forced to be the same width within the container. 

Values: OL_ALL/all – all sub-objects are to be the same width.  OL_COLUMNS/columns – All sub-objects appearing in the same column should be the same width.  OL_NONE/none – sub-objects are placed in fixed-width columns but the width of each item is not touched.  The width of each column is the width of the widest sub-object. 

XtNsaveUnder

 class:XtCSaveUndertype:Booleandefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  PopupWindow

Action: 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. 

Values: TRUE, FALSE

XtNselectDoesPreview

 class:XtNSelectDoesPreviewtype:Booleandefault:TRUETRUE’u’access:GG’u’

Group:  Application

Action: Shows behavior of SELECT mouse button

Values: TRUE – pressing SELECT will cause the MenuButton to preview the submenu’s default item and releasing the SELECT button will activate the default item.  FALSE – pressing SELECT will post the submenu. 

This resource reflects the behavior of the SELECT mouse button when it is pressed over a MenuButton or an Abbreviated MenuButton. 

XtNsensitive

 class:XtCSensitivetype:Booleandefault:(n/a)(n/a)’u’access:GIOGIO’u’

Group:  Core

Action: Determines whether a widget will receive input events. 

If a widget is sensitive, the X Toolkit Intrinsic’s event manager will dispatch to the widget all keyboard, mouse button, motion, window enter/leave, and focus events.

Insensitive widgets do not receive these events, Also, insensitive widgets that appear on the screen are stippled with a 50% gray pattern to show that they are inactive.  The 50% gray pattern makes every other pixel of the widget the background color, in a checkerboard pattern. 

An application should use the XtSetSensitive() routine if it wants to change this resource.  That way it ensures that if a parent widget has XtNsensitive set to FALSE, the XtNancestorSensitive flag of all its descendants will be appropriately set. 

Note that for Caption and StaticText widgets, if XtNsensitive is set to FALSE, the label will appear grayed out to indicate this. 

XtNshiftName

 class:XtNshiftNametype:OlDefinedefault:NShiftNShift’u’access:GG’u’

Group: Shell

Action:

These resources define the names used to display the accelerator in buttons and labels.  They are provided as resources so that they can be easily changed for a particular keyboard.  For example, the mod1Name is usually "Alt", but on some keyboards it may be labeled "Meta". 

XtNshowAccelerators

 class:XtCShowAcceleratorstype:OlDefinedefault:OL_DISPLAYOL_DISPLAY’u’access:GG’u’

Group:  Application

Action: Determines if keyboard accelerators on controls should be displayed. 

Values: OL_DISPLAY/display – the keyboard accelerators on the controls will be displayed.  OL_INACTIVE/inactive – keyboard accelerators are not displayed and controls ignore the accelerator action.  OL_NONE/none – the keyboard accelerators on the controls will not be displayed. 

XtNshowMnemonics

 class:XtCShowMnemonicstype:OlDefinedefault:OL_UNDERLINEOL_UNDERLINE’u’access:GG’u’

Group:  Application

Action: Determines if keyboard mnemonics on controls should be displayed. 

Values: OL_DISPLAY/display – the mnemonic character on the controls are displayed.  OL_HIGHLIGHT/highlight – display mnemonic character with  background and foreground colors reversed.  When highlighting a character that is displayed on a pixmap background, the mnemonic character will be drawn in a solid color.  OL_INACTIVE/inactive – turns off the mnemonic display as well as making the mnemonic key inactive.  OL_NONE/none – mnemonic accelerator will not be displayed.  OL_UNDERLINE/underline – mnemonics are displayed in the Primitive children by drawing a line under the character in the font color. 

XtNtextBackground

 class:XtCTextBackgroundtype:Pixeldefault:XtDefaultBackgroundXtDefaultBackground’u’access:GG’u’

Group:  Application

Action: Default color used in ScrollingList and TextEdit widgets. 

XtNtextFontColor

 class:XtTextFontColortype:Pixeldefault:XtDefaultForegroundXtDefaultForeground’u’access:SGISGI’u’

Group:  Application

Action: Default font color used in ScrollingList and TextEdit widgets. 

XtNthreeD

 class:XtCThreeDtype:Booleandefault:TRUETRUE’u’access:GG’u’

Group:  Application

Action: Determines how visuals are rendered. 

Values: TRUE – displays the visuals with a three dimensional look.  FALSE – visuals have a two dimensional appearance. 

XtNtitle

 class:XtCTitletype:Stringdefault:(n/a)(n/a)’u’access:SGISGI’u’ Group: PopupWindow

Action: Gives the title to include in the header of the base or pop-up window. 

Note: Widgets of other classes besides Shell may have a resource with this name. 

XtNtransient

 class:XtCTransienttype:Booleandefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  PopupWindow

Action: controls whether shell widget’s window is unmapped when associated base window is iconified. 

Values: TRUE, FALSE

A transient window is one that is unmapped when its associated base window is iconified.  This resource controls the transience of a shell widget. 

No application should set this resource for any OLIT shell widgets: Menu, Notice, or PopupWindow.  See XtNwindowGroup.

XtNtranslations

 class:XtCTranslationstype:XtTranslationsdefault:(n/a)(n/a)’u’access:GG’u’

Group:  Core

This resource should not be set by an application. 

XtNtraversalOn

 class:XtCTraversalOntype:Booleandefault:TRUETRUE’u’access:SGISGI’u’

Group:  Manager, Primitive

Action: Whether this widget is accessible through keyboard traversal. 

Values: TRUE, FALSE Note that this resource affects only an individual widget.  Setting ∗traversalOn: false in a resource control file is not quite equivalent to turning off mouseless operation. 

XtNuserData

 class:XtCUserDatatype:XtPointerdefault:NULLNULL’u’access:SGISGI’u’

Group:  Manager, VendorShell

Action: Storage for application-specific data. 

The storage allocated by this resource is not used or set by the widget.  The resource’s default value is NULL. 

XtNvisual

 class:XtCVisualtype:Visual∗default:(parent´s)(parent´s)’u’access:GIGI’u’

Action: Determines the visual used to create the widget’s window. 

Values: A pointer to any visual structure supported by the current display and compatible with the widget’s depth and colormap. 

Only Shell and DrawArea Widgets have a visual resource.  All other widgets are created using their parent’s visual. 

If not initialized, Shell and DrawArea widgets use their depth resource and parent’s visual class to find the widget’s visual. 

The prefered method of setting a Shell or DrawArea widget’s visual resource is to use the Intrinsics typed args interface.  A string containing the desired Visual Class Name should be passed to the String to Visual resource converter. 

To get the visual associated with any object use the function OlVisualOfObject(). 

XtNvPad

 class:XtCVPadtype:Dimensiondefault:00’u’access:SGISGI’u’

Group:  Flat layout

Action: Vertical padding to leave between sub-objects and the border. 

Values: 0 ≤ XtNvSpace

This resource specifies the amount of vertical padding to leave between sub-objects and the border.  If the sub-objects are of different sizes in a row or column, the spacing applies to the tallest sub-object in the row or column. 

XtNvSpace

 class:XtCVSpacetype:Dimensiondefault:00’u’access:SGISGI’u’

Group:  Flat layout

Action: Vertical space to leave between sub-objects. 

Values: 0 ≤ XtNvSpace

This resource specifies the amount of vertical space to leave between sub-objects.  If the sub-objects are of different sizes in a row or column, the spacing applies to the tallest sub-object in the row or column. 

XtNwaitForWm

 class:XtCWaitForWmtype:Booleandefault:(n/a)(n/a)’u’access:GG’u’ Group: PopupWindow

Action: This resource should not be set by an application. 

XtNwidth

 class:XtCWidthtype:Dimensiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  Core

Action: Contains width of widget’s window in pixels, not including border. 

Values: 0 ≤ XtNwidth

Programs may request a value at creation or through later calls to XtSetValues(), but the request may not succeed because of layout requirements of the parent widget.  The visual representations for some widgets have a fixed width for a given scale.  For these widgets, the XtNwidth resource gives the width of the space that contains the widget’s representation; the representation is centered horizontally in this space unless otherwise specified. 

XtNwidthInc

 class:XtCWidthInctype:intdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: PopupWindow

Action: Resize width increment. 

Values: 0 ≤ XtNwidthInc

This resource defines the increment in an arithmetic progression of sizes, from XtNminWidth to XtNmaxWidth, into which the shell widget prefers to be resized by the window manager. 

XtNwindowGroup

 class:XtCWindowGrouptype:Windowdefault:(n/a)(n/a)’u’access:SGISGI’u’ Group: PopupWindow

Action: Identifies the base window associated with this shell widget’s window. 

Values: ID of existing 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). 

XtNwindowHeader

 class:XtCWindowHeadertype:Booleandefault:(n/a)(n/a)’u’access:GIGI’u’

Group: VendorShell

Action: Determines if the window manager should provide a header for the window. 

Values: TRUE – default for base windows, PopupWindows and Help shells, indicating the window has a header.  FALSE – default for Notice shell. 

The header is the area of the window that contains the pushpin, title, and window mark. 

Note: This resource can only be set at initialization. 

XtNwmProtocol

 class:XtCWMProtocoltype:XtRCallbackListdefault:(n/a)(n/a)’u’access:SGISGI’u’

Group:  VendorShell

Action: Controls action taken whenever a vendor shell widget receives WM_PROTOCOL messages

Values: OL_WM_TAKE_FOCUS
OL_WM_SAVE_YOURSELF
OL_WM_DELETE_WINDOW

This resource controls the action that is taken whenever a shell widget (which is a subclass of a VendorShell widget class) receives WM_PROTOCOL messages.  If no callback list is specified, the shell performs its default action(s).  If a callback list is specified, it is invoked and no default action(s) is taken.  The application can, however, simulate the default action(s) at its convenience by calling OlWMProtocolAction() with the action parameter set to OL_DEFAULTACTION.  (See OlWMProtocolAction(3w) for more information on this routine.) 

When the application’s callback procedure is invoked, the call_data field is a pointer to the following structure:

    typedef struct {
        int        msgtype;        /∗ type of WM msg ∗/
        XEvent ∗   xevent;
    } OlWMProtocolVerify;

The field msgtype is an integer constant indicating the type of protocol message which invoked the callback and has a range of values of:

     OL_WM_TAKE_FOCUS
     OL_WM_SAVE_YOURSELF
     OL_WM_DELETE_WINDOW

OlAddCallback() must be used instead of XtAddCallback() when adding callbacks to the XtNwmProtocol callback list. 

XtNwmProtocolInterested

 class:XtCWMProtocolInterestedtype:intdefault:n/an/a’u’access:II’u’

Group:  VendorShell

Action: Specifies the types of protocol messages that interest the application. 

Values: OL_WM_DELETE_WINDOW – permanently turned on OL_WM_TAKE_FOCUS – permanently turned on OL_WM_SAVE_YOURSELF – user selectable

XtNwmTimeout

 class:XtCWmTimeouttype:intdefault:(n/a)(n/a)’u’access:GG’u’

Group: PopupWindow

Action: This resource should not be set by an application. 

XtNx

 class:XtCPositiontype:Positiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: Core

Action: X-coordinate of the widget’s upper left hand corner. 

Values: 0 ≤ XtNx

This resource contains the x-coordinate of the widget’s upper left hand corner (excluding the border) relative to its parent widget.  Programs may request a value at creation or through later calls to XtSetValues(), but the request may not succeed because of layout requirements of the parent widget. 

XtNy

 class:XtCPositiontype:Positiondefault:(n/a)(n/a)’u’access:SGISGI’u’

Group: Core

Action: Y-coordinate of the widget’s upper left hand corner. 

Values: 0 ≤ XtNy

This resource contains the y-coordinate of the widget’s upper left hand corner (excluding the border) relative to its parent widget. 

Programs may request a value at creation or through later calls to XtSetValues(), but the request may not succeed because of layout requirements of the parent widget. 
 

Sun Release 4.1  —  Last change: July 19,1991