Blob Blame History Raw
'\" t
...\" Compos.sgm /main/11 1996/09/08 21:41:41 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "Composite" "library call"
.SH "NAME"
\fBComposite\fP \(em The Composite widget class
.iX "Composite"
.iX "widget class" "Composite"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
.fi
.SH "DESCRIPTION"
.PP
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:
.IP "   \(bu" 6
Overall management of children from creation to destruction\&.
.IP "   \(bu" 6
Destruction of descendants when the composite widget is destroyed\&.
.IP "   \(bu" 6
Physical arrangement (geometry management) of a displayable subset of
managed children\&.
.IP "   \(bu" 6
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\&.
.SS "Classes"
.PP
Composite inherits behavior and resources from \fBCore\fP\&.
.PP
The class pointer is \fBcompositeWidgetClass\fP\&.
.PP
The class name is \fBComposite\fP\&.
.SS "New Resources"
.PP
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 \fB\&.Xdefaults\fP file, remove the \fBXmN\fP or
\fBXmC\fP prefix and use the remaining letters\&. To specify one of the defined
values for a resource in a \fB\&.Xdefaults\fP file, remove the \fBXm\fP 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 \fBXtSetValues\fP (S),
retrieved by using \fBXtGetValues\fP (G), or is not applicable (N/A)\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBComposite Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNchildrenXmCReadOnlyWidgetListNULLG
_____
XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG
_____
XmNnumChildrenXmCReadOnlyCardinal0G
_____
.TE
.IP "\fBXmNchildren\fP" 10
A read-only list of the children of the widget\&.
.IP "\fBXmNinsertPosition\fP" 10
Points to the \fBXtOrderProc\fP function described below\&.
.IP "\fBXmNnumChildren\fP" 10
A read-only resource specifying the length of the list of children in
\fBXmNchildren\fP\&.
.PP
The following procedure pointer in a composite widget instance is of type
\fBXtOrderProc\fP:
.PP
.nf
Cardinal (* XtOrderProc) (Widget \fIw\fP);
.fi
.IP "\fIw\fP" 10
Specifies the widget\&.
.PP
Composite widgets that allow clients to order their children (usually
homogeneous boxes) can call their widget instance\&'s
\fBXmNinsertPosition\fP
procedure from the class\&'s \fBinsert_child\fP 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
\fBXmNinsertPosition\fP
procedure when it creates each
composite widget instance\&.
.PP
The return value of the
\fBXmNinsertPosition\fP
procedure indicates
how many children
should go before the widget\&. A value of 0 (zero) indicates that the
widget should go before all other children; returning
the value of \fBXmNumChildren\fP
indicates
that it should go after all other children\&.
By default, unless a subclass or an application provides an
\fBXmNinsertPosition\fP procedure, each child is inserted at the end
of the \fBXmNchildren\fP list\&.
The \fBXmNinsertPosition\fP procedure can be overridden by a specific
composite
widget\&'s resource list or by the argument list provided when the composite
widget is created\&.
.SS "Inherited Resources"
.PP
Composite inherits behavior and resources from the superclass described in
the following table\&.
For a complete description of each resource, refer to the reference page for
that superclass\&.
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBCore Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicCSG
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
_____
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderWidthXmCBorderWidthDimension1CSG
_____
XmNcolormapXmCColormapColormapdynamicCG
_____
XmNdepthXmCDepthintdynamicCG
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
_____
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
_____
XmNscreenXmCScreenScreen *dynamicCG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.SS "Translations"
.PP
There are no translations for Composite\&.
.SH "RELATED"
.PP
\fBCore\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:16