1Composite(library call)                                Composite(library call)
2
3
4

NAME

6       Composite — The Composite widget class
7

SYNOPSIS

9       #include <Xm/Xm.h>
10

DESCRIPTION

12       Composite  widgets  are intended to be containers for other widgets and
13       can have  an  arbitrary  number  of  children.  Their  responsibilities
14       (implemented  either  directly  by  the  widget  class or indirectly by
15       Intrinsics functions) include:
16
17          ·  Overall management of children from creation to destruction.
18
19          ·  Destruction  of  descendants  when  the   composite   widget   is
20             destroyed.
21
22          ·  Physical  arrangement (geometry management) of a displayable sub‐
23             set of managed children.
24
25          ·  Mapping and unmapping  of  a  subset  of  the  managed  children.
26             Instances of composite widgets need to specify the order in which
27             their children are kept. For example, an application may  want  a
28             set of command buttons in some logical order grouped by function,
29             and it may want buttons that represent filenames to  be  kept  in
30             alphabetical order.
31
32   Classes
33       Composite inherits behavior and resources from Core.
34
35       The class pointer is compositeWidgetClass.
36
37       The class name is Composite.
38
39   New Resources
40       The  following table defines a set of widget resources used by the pro‐
41       grammer to specify data. The programmer can also set the resource  val‐
42       ues  for  the  inherited  classes to set attributes for this widget. To
43       reference a resource by name or by class in a .Xdefaults  file,  remove
44       the  XmN or XmC prefix and use the remaining letters. To specify one of
45       the defined values for a resource in a .Xdefaults file, remove  the  Xm
46       prefix and use the remaining letters (in either lowercase or uppercase,
47       but include any underscores between words).  The codes  in  the  access
48       column  indicate if the given resource can be set at creation time (C),
49       set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
50       not applicable (N/A).
51
52       ┌───────────────────────────────────────────────────────────────────────┐
53       │                  │     Composite Reso│urce Set      │         │        │
54Name              Class             Type        Default Access 
55       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
56       │XmNchildren       │ XmCReadOnly       │ WidgetList  │ NULL    │ G      │
57       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
58       │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL    │ CSG    │
59       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
60       │XmNnumChildren    │ XmCReadOnly       │ Cardinal    │ 0       │ G      │
61       ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
62       └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
63       XmNchildren
64                 A read-only list of the children of the widget.
65
66       XmNinsertPosition
67                 Points to the XtOrderProc function described below.
68
69       XmNnumChildren
70                 A  read-only  resource  specifying  the length of the list of
71                 children in XmNchildren.
72
73       The following procedure pointer in a composite widget  instance  is  of
74       type XtOrderProc:
75
76       Cardinal (* XtOrderProc) (Widget w);
77
78       w         Specifies the widget.
79
80       Composite  widgets  that allow clients to order their children (usually
81       homogeneous boxes) can call their widget  instance's  XmNinsertPosition
82       procedure  from the class's insert_child procedure to determine where a
83       new child should go in its children array. Thus, a client of a  compos‐
84       ite  class  can apply different sorting criteria to widget instances of
85       the class, passing in a different XmNinsertPosition procedure  when  it
86       creates each composite widget instance.
87
88       The  return value of the XmNinsertPosition procedure indicates how many
89       children should go before the widget. A value  of  0  (zero)  indicates
90       that  the  widget  should  go  before all other children; returning the
91       value of XmNumChildren indicates that it  should  go  after  all  other
92       children.   By default, unless a subclass or an application provides an
93       XmNinsertPosition procedure, each child is inserted at the end  of  the
94       XmNchildren list.  The XmNinsertPosition procedure can be overridden by
95       a specific composite widget's resource list or  by  the  argument  list
96       provided when the composite widget is created.
97
98   Inherited Resources
99       Composite inherits behavior and resources from the superclass described
100       in the following table.  For a complete description of  each  resource,
101       refer to the reference page for that superclass.
102
103       ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
104       │                              │               Core Resource Se│t                │                      │        │
105Name                          Class                         Type           Default              Access 
106       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
107       │XmNaccelerators               │ XmCAccelerators               │ XtAccelerators │ dynamic              │ CSG    │
108       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
109       │XmNancestorSensitive          │ XmCSensitive                  │ Boolean        │ dynamic              │ G      │
110       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
111       │XmNbackground                 │ XmCBackground                 │ Pixel          │ dynamic              │ CSG    │
112       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
113       │XmNbackgroundPixmap           │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
114       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
115       │XmNborderColor                │ XmCBorderColor                │ Pixel          │ XtDefaultForeground  │ CSG    │
116       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
117       │XmNborderPixmap               │ XmCPixmap                     │ Pixmap         │ XmUNSPECIFIED_PIXMAP │ CSG    │
118       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
119       │XmNborderWidth                │ XmCBorderWidth                │ Dimension      │ 1                    │ CSG    │
120       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
121       │XmNcolormap                   │ XmCColormap                   │ Colormap       │ dynamic              │ CG     │
122       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
123       │XmNdepth                      │ XmCDepth                      │ int            │ dynamic              │ CG     │
124       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
125       │XmNdestroyCallback            │ XmCCallback                   │ XtCallbackList │ NULL                 │ C      │
126       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
127       │XmNheight                     │ XmCHeight                     │ Dimension      │ dynamic              │ CSG    │
128       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
129       │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean        │ True                 │ C      │
130       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
131       │XmNmappedWhenManaged          │ XmCMappedWhenManaged          │ Boolean        │ True                 │ CSG    │
132       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
133       │XmNscreen                     │ XmCScreen                     │ Screen *       │ dynamic              │ CG     │
134       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
135       │XmNsensitive                  │ XmCSensitive                  │ Boolean        │ True                 │ CSG    │
136       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
137       │XmNtranslations               │ XmCTranslations               │ XtTranslations │ dynamic              │ CSG    │
138       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
139       │XmNwidth                      │ XmCWidth                      │ Dimension      │ dynamic              │ CSG    │
140       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
141       │XmNx                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
142       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
143       │XmNy                          │ XmCPosition                   │ Position       │ 0                    │ CSG    │
144       ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
145       └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
146   Translations
147       There are no translations for Composite.
148
150       Core(3).
151
152
153
154                                                       Composite(library call)
Impressum