This page describes the format and contents of each reference page in Section 5, covering the Athena Widget Classes.

NAME

Name − brief description of the widget class. 

SYNOPSIS

The Synopsis section presents the required include files, Class name, and the widget class pointer to be specified in calls to XtCreateWidget().  For example:

Public Headers:<X11/StringDefs.h> <X11/Xaw/Box.h>

Private Header:<X11/Xaw/BoxP.h>

Class Name:Box

Class Pointer:boxWidgetClass

Instantiation:widget = XtCreateWidget(name, boxWidgetClass, ...) 

CLASS HIERARCHY

This section shows the hierarchy from which this widget inherits functionality and resources. 

AVAILABILITY

The Availability section specifies that a given function is only available in Release 5 and later releases.  If there is no Availability section, the function is available in Release 4 and Release 5, and later releases. 

DESCRIPTION

The Description section describes what the widget does.  It also contains miscellaneous information such as examples of usage, special notes, and pointers to related information in this manual. 

RESOURCES

The Resources section provides a table listing all resources defined by this widget and all its superclasses, along with their types, default values, and a brief description.  If the resource is new in Release 5, the first column will begin with (R5).  The description column may begin with the following code letters denoting special restrictions placed upon individual resources:

(A)This resource may be automatically adjusted when another resource is changed. 

(C)This resource is only settable at widget creation time, and may not be modified with XtSetValues(). 

(D)Do not modify this resource.  While setting this resource will work, it can cause unexpected behavior.  When this symbol appears, there is another preferred interface provided by the Intrinsics. 

(R)This resource is READ-ONLY, and may not be modified. 

After the table is a detailed description of each new resource defined by this widget (but not those defined by superclasses).  To see the detailed description of superclass resources, see the reference page for the superclass. 

CONSTRAINT RESOURCES

For subclasses of Constraint, this section describes any Constraint Resources that can be set on children but that are interpreted by this widget. 

LAYOUT SEMANTICS

For subclasses of Composite and Constraint, this section describes any aspects of layout policy not covered in the sections on Resources or Constraint Resources. 

TRANSLATIONS AND ACTIONS

The Translations and Actions section lists and describes the actions defined by this widget, and shows the default translation table.  You can use this information to modify or replace the translation table for an instance of this widget. 

CALLBACK STRUCTURES

The Callback Structures section shows the structures the widget uses to pass data to client-supplied callback functions. 

PUBLIC FUNCTIONS

The Public Functions section describes all public functions defined by the widget.  These normally provide interfaces for getting information from or putting information into the widget. 

SEE ALSO

The See Also section lists widgets related to Name.