Composite(3X) UNIX System V Composite(3X)
NAME
Composite - the Composite widget class.
SYNOPSIS
#include <Xm/Xm.h>
DESCRIPTION
Composite widgets are intended to be containers for other widgets and can
have an arbitrary number of children. Their responsibilities
(implemented either directly by the widget class or indirectly by
Intrinsics functions) include:
⊕ Overall management of children from creation to destruction.
⊕ Destruction of descendants when the composite widget is destroyed.
⊕ Physical arrangement (geometry management) of a displayable subset of
managed children.
⊕ Mapping and unmapping of a subset of the managed children. Instances
of composite widgets need to specify the order in which their children
are kept. For example, an application may want a set of command
buttons in some logical order grouped by function, and it may want
buttons that represent filenames to be kept in alphabetical order.
Classes
Composite inherits behavior and resources from Core.
The class pointer is compositeWidgetClass.
The class name is Composite.
New Resources
The following table defines a set of widget resources used by the
programmer to specify data. The programmer can also set the resource
values for the inherited classes to set attributes for this widget. To
reference a resource by name or by class in a .Xdefaults file, remove the
XmN or XmC prefix and use the remaining letters. To specify one of the
defined values for a resource in a .Xdefaults file, remove the Xm prefix
and use the remaining letters (in either lowercase or uppercase, but
include any underscores between words). The codes in the access column
indicate if the given resource can be set at creation time (C), set by
using XtSetValues (S), retrieved by using XtGetValues (G), or is not
applicable (N/A).
10/89 Page 1
Composite(3X) UNIX System V Composite(3X)
_______________________________________________________________________
| Composite Resource Set |
|__________________|___________________|____________|_________|________|
| Name | Class | Type | Default| Access|
|__________________|___________________|____________|_________|________|
|__________________|___________________|____________|_________|________|
| XmNchildren | XmCReadOnly | WidgetList| NULL | G |
|__________________|___________________|____________|_________|________|
| XmNinsertPosition| XmCInsertPosition| (*)() | NULL | CSG |
|__________________|___________________|____________|_________|________|
| XmNnumChildren | XmCReadOnly | Cardinal | 0 | G |
|__________________|___________________|____________|_________|________|
XmNchildren
A read-only list of the children of the widget.
XmNinsertPosition
Points to the XtOrderProc function described below.
XmNnumChildren
A read-only resource specifying the length of the list of children
in XmNchildren.
The following procedure pointer in a composite widget instance is of type
XtOrderProc:
Cardinal (* XtOrderProc) (widget)
Widget w;
w Specifies the widget.
Composite widgets that allow clients to order their children (usually
homogeneous boxes) can call their widget instance's insert_position
procedure from the class's insert_child procedure to determine where a
new child should go in its children array. Thus, a client of a composite
class can apply different sorting criteria to widget instances of the
class, passing in a different insert_position procedure when it creates
each composite widget instance.
The return value of the insert_position procedure indicates how many
children should go before the widget. Returning zero indicates that the
widget should go before all other children; returning num_children
indicates that it should go after all other children. The default
insert_position function returns num_children and can be overridden by a
specific composite widget's resource list or by the argument list
provided when the composite widget is created.
Page 2 10/89
Composite(3X) UNIX System V Composite(3X)
Inherited Resources
Composite inherits behavior and resources from the following superclass.
For a complete description of each resource, refer to the manual page for
that superclass.
________________________________________________________________________________________________________________
| Core Resource Set |
|_____________________________|_______________________________|________________|______________________|________|
|Name | Class | Type | Default | Access|
|_____________________________|_______________________________|________________|______________________|________|
|_____________________________|_______________________________|________________|______________________|________|
|XmNaccelerators | XmCAccelerators | XtAccelerators| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNancestorSensitive | XmCSensitive | Boolean | dynamic | G |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackground | XmCBackground | Pixel | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNbackgroundPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderColor | XmCBorderColor | Pixel | XtDefaultForeground | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderPixmap | XmCPixmap | Pixmap | XmUNSPECIFIED_PIXMAP| CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNborderWidth | XmCBorderWidth | Dimension | 1 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNcolormap | XmCColormap | Colormap | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdepth | XmCDepth | int | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNdestroyCallback | XmCCallback | XtCallbackList| NULL | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNheight | XmCHeight | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNinitialResourcesPersistent| XmCInitialResourcesPersistent| Boolean | True | C |
|_____________________________|_______________________________|________________|______________________|________|
|XmNmappedWhenManaged | XmCMappedWhenManaged | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNscreen | XmCScreen | Screen * | dynamic | CG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNsensitive | XmCSensitive | Boolean | True | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNtranslations | XmCTranslations | XtTranslations| dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNwidth | XmCWidth | Dimension | dynamic | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNx | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
|XmNy | XmCPosition | Position | 0 | CSG |
|_____________________________|_______________________________|________________|______________________|________|
10/89 Page 3
Composite(3X) UNIX System V Composite(3X)
Translations
There are no translations for Composite.
RELATED INFORMATION
Core(3X).
Page 4 10/89