Composite(3Xm) Composite(3Xm)
NAME
Composite - the Composite widget class.
AES SUPPORT LEVEL
full-use
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 (either implemented
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 about 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
file names 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
- 1 -
Composite(3Xm) Composite(3Xm)
values for a resource in a .Xdefaults file, remove the
Xm prefix and use the remaining letters (in either
lower case or upper case, 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).
Composite Resource Set
Name Class Type Default Access
______________________________________________________________________
XmNinsertPosition XmCInsertPosition XmRFunction NULL CSG
XmNinsertPosition
Points to the XtOrderProc function described
below.
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.
- 2 -
Composite(3Xm) Composite(3Xm)
Inherited Resources
Composite inherits behavior and resources from the
following superclass. For a complete description of
these resources, refer to the man page for that
superclass.
Core Resource Set
Name Class Type Default Access
____________________________________________________________________________________________
XmNaccelerators XmCAccelerators XtTranslations NULL CSG
XmNancestorSensitive XmCSensitive Boolean True G
XmNbackground XmCBackground Pixel White CSG
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderColor XmCBorderColor Pixel Black CSG
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderWidth XmCBorderWidth Dimension 1 CSG
XmNcolormap XmCColormap Colormap XtCopyFromParent CG
XmNdepth XmCDepth int XtCopyFromParent CG
XmNdestroyCallback XmCCallback XtCallbackList NULL C
XmNheight XmCHeight Dimension 0 CSG
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
XmNscreen XmCScreen Pointer XtCopyScreen CG
XmNsensitive XmCSensitive Boolean True CSG
XmNtranslations XmCTranslations XtTranslations NULL CSG
XmNwidth XmCWidth Dimension 0 CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
RELATED INFORMATION
Core(3X).
- 3 -