1XmIconBox(3X) XmIconBox(3X)
2
6 XmIconBox — The IconBox widget class
7
9 #include <Xm/IconBox.h>
10
12 The Icon Box widget lays out its children on a grid with each child
13 forced to be the same size and with the location of each child speci‐
14 fied as an X and Y location on the grid.
15 The size of the Icon Box, its children, and the number of cells dis‐
17 played are calculated as described below. The general idea is that all
18 children are always be shown and should be given their desired size
19 whenever possible. The user may add or delete cells by resizing this
20 window using the window manager widget.
21 The preferred size is calculated by using the maximum desired child
23 height or width and making sure that these are no smaller than the min‐
24 imum sizes. This size is multiplied by the number of cells along the
25 axis and properly padded to come up with a preferred size. The number
26 of cells is the maximum of the largest cellX or cellY value and the
27 minimum number of horizontal or vertical cells.
28 If the Icon box is forced larger than its preferred size more cells are
30 added at the bottom-right of the widget while the children all remain
31 at their preferred sizes.
32 If the Icon box is forced smaller than its preferred size each cell is
34 forced to be smaller in order to allow all children to fit within the
35 Icon Box. All children will be forced to the same smaller size.
36 Classes
38 Icon Box inherits behavior, resources, and traits from Core, Composite,
39 Constraint, and XmManager.
40 The class pointer is xmIconBoxWidgetClass.
42 The class name is XmIconBox.
44 New Resources
46 The following table defines a set of widget resources used by the pro‐
47 grammer to specify data. The programmer can also set the resource val‐
48 ues for the inherited classes to set attributes for this widget. To
49 reference a resource by name or by class in a .Xdefaults file, remove
50 the XmN or XmC prefix and use the remaining letters. To specify one of
51 the defined values for a resource in a .Xdefaults file, remove the Xm
52 prefix and use the remaining letters (in either lowercase or uppercase,
53 but include any underscores between words). The codes in the access
54 column indicate if the given resource can be set at creation time (C),
55 set by using XtSetValues (S), retrieved by using XtGetValues (G), or is
56 not applicable (N/A).
57 ┌──────────────────────────────────────────────────────────────────────────────┐
59 │ │XmIconBox Resource S│et │ │ │
60 │Name │ Class │ Type │ Default │ Access │
61 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
62 │XmNhorizontalMargin │ XmCMargin │ Dimension │ 4 │ CSG │
63 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
64 │XmNminimumHorizontalCells │ XmCDefaultCells │ int │ 8 │ CSG │
65 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
66 │XmNminimumVerticalCells │ XmCDefaultCells │ int │ 4 │ CSG │
67 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
68 │XmNminimumCellHeight │ XmCMinimumCellSize │ Dimension │ 10 │ CSG │
69 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
70 │XmNminimumCellWidth │ XmCMinimumCellSize │ Dimension │ 20 │ CSG │
71 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
72 │XmNverticalMargin │ XmCMargin │ Dimension │ 4 │ CSG │
73 ├──────────────────────────┼────────────────────┼───────────┼─────────┼────────┤
74 └──────────────────────────┴────────────────────┴───────────┴─────────┴────────┘
75 XmNhorizontalMargin
76 XmNverticalMargin
78 The amount of space between each cell and its neighbor or the
79 edge of the Icon Box.
80 XmNminimumHorizontalCells
82 XmNminimumVerticalCells
84 The minimum number of cells to display in the horizontal and
85 vertical directions. This number of cells will always be
86 displayed.
87 XmNminimumCellWidth
89 XmNminimumCellHeight
91 The smallest size the cells are allowed to be in the direc‐
92 tion specified.
93 Constraint Resources
95 ┌────────────────────────────────────────────────────────┐
96 │ │ XmIconBox│Constra│int Resource Set │ │
97 │Name │ Class │ Type │ Default │ Access │
98 ├─────────┼──────────┼───────┼──────────────────┼────────┤
99 │XmNcellX │ XmCCellX │ Short │ XmIconBoxAnyCell │ CSG │
100 ├─────────┼──────────┼───────┼──────────────────┼────────┤
101 │XmNcellY │ XmCCellY │ Short │ XmIconBoxAnyCell │ CSG │
102 ├─────────┼──────────┼───────┼──────────────────┼────────┤
103 └─────────┴──────────┴───────┴──────────────────┴────────┘
104 XmNcellX
105 XmNcellY The location of this cell in cell space. These coordinates
107 may be any positive integer. They determine where this widget
108 will be placed relative to its neighbors. Having two chil‐
109 dren at the same cell X and cell Y location will result in
110 undefined behavior. To place a cell at any empty cell, set
111 cell X and cell Y to the value XmIconBoxAnyCell.
112 Inherited Resources
114 Icon Box inherits behavior and resources from the superclasses
115 described in the following tables. For a complete description of each
116 resource, refer to the reference page for that superclass.
117 ┌────────────────────────────────────────────────────────────────────────────────────────────────────┐
119 │ │ XmManager │Resource Set │ │ │
120 │Name │ Class │ Type │ Default │ Access │
121 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
122 │XmNbottomShadowColor │ XmCBottomShadowColor │ Pixel │ dynamic │ CSG │
123 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
124 │XmNbottomShadowPixmap │ XmCBottomShadowPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
125 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
126 │XmNforeground │ XmCForeground │ Pixel │ dynamic │ CSG │
127 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
128 │XmNhelpCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
129 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
130 │XmNhighlightColor │ XmCHighlightColor │ Pixel │ dynamic │ CSG │
131 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
132 │XmNhighlightPixmap │ XmCHighlightPixmap │ Pixmap │ dynamic │ CSG │
133 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
134 │XmNinitialFocus │ XmCInitialFocus │ Widget │ dynamic │ CSG │
135 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
136 │XmNlayoutDirection │ XmCLayoutDirection │ XmDirection │ dynamic │ CG │
137 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
138 │XmNnavigationType │ XmCNavigationType │ XmNavigationType │ XmTAB_GROUP │ CSG │
139 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
140 │XmNpopupHandlerCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
141 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
142 │XmNshadowThickness │ XmCShadowThickness │ Dimension │ dynamic │ CSG │
143 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
144 │XmNstringDirection │ XmCStringDirection │ XmStringDirection │ dynamic │ CG │
145 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
146 │XmNtopShadowColor │ XmCTopShadowColor │ Pixel │ dynamic │ CSG │
147 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
148 │XmNtopShadowPixmap │ XmCTopShadowPixmap │ Pixmap │ dynamic │ CSG │
149 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
150 │XmNtraversalOn │ XmCTraversalOn │ Boolean │ True │ CSG │
151 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
152 │XmNunitType │ XmCUnitType │ unsigned char │ dynamic │ CSG │
153 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
154 │XmNuserData │ XmCUserData │ XtPointer │ NULL │ CSG │
155 ├────────────────────────┼───────────────────────┼───────────────────┼──────────────────────┼────────┤
156 └────────────────────────┴───────────────────────┴───────────────────┴──────────────────────┴────────┘
157 ┌───────────────────────────────────────────────────────────────────────┐
158 │ │ Composite Reso│urce Set │ │ │
159 │Name │ Class │ Type │ Default │ Access │
160 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
161 │XmNchildren │ XmCReadOnly │ WidgetList │ NULL │ G │
162 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
163 │XmNinsertPosition │ XmCInsertPosition │ XtOrderProc │ NULL │ CSG │
164 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
165 │XmNnumChildren │ XmCReadOnly │ Cardinal │ 0 │ G │
166 ├──────────────────┼───────────────────┼─────────────┼─────────┼────────┤
167 └──────────────────┴───────────────────┴─────────────┴─────────┴────────┘
168 ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
169 │ │ Core Resource Se│t │ │ │
170 │Name │ Class │ Type │ Default │ Access │
171 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
172 │XmNaccelerators │ XmCAccelerators │ XtAccelerators │ dynamic │ N/A │
173 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
174 │XmNancestorSensitive │ XmCSensitive │ Boolean │ dynamic │ G │
175 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
176 │XmNbackground │ XmCBackground │ Pixel │ dynamic │ CSG │
177 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
178 │XmNbackgroundPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
179 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
180 │XmNborderColor │ XmCBorderColor │ Pixel │ XtDefaultForeground │ CSG │
181 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
182 │XmNborderPixmap │ XmCPixmap │ Pixmap │ XmUNSPECIFIED_PIXMAP │ CSG │
183 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
184 │XmNborderWidth │ XmCBorderWidth │ Dimension │ 0 │ CSG │
185 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
186 │XmNcolormap │ XmCColormap │ Colormap │ dynamic │ CG │
187 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
188 │XmNdepth │ XmCDepth │ int │ dynamic │ CG │
189 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
190 │XmNdestroyCallback │ XmCCallback │ XtCallbackList │ NULL │ C │
191 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
192 │XmNheight │ XmCHeight │ Dimension │ dynamic │ CSG │
193 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
194 │XmNinitialResourcesPersistent │ XmCInitialResourcesPersistent │ Boolean │ True │ C │
195 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
196 │XmNmappedWhenManaged │ XmCMappedWhenManaged │ Boolean │ True │ CSG │
197 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
198 │XmNscreen │ XmCScreen │ Screen * │ dynamic │ CG │
199 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
200 │XmNsensitive │ XmCSensitive │ Boolean │ True │ CSG │
201 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
202 │XmNtranslations │ XmCTranslations │ XtTranslations │ dynamic │ CSG │
203 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
204 │XmNwidth │ XmCWidth │ Dimension │ dynamic │ CSG │
205 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
206 │XmNx │ XmCPosition │ Position │ 0 │ CSG │
207 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
208 │XmNy │ XmCPosition │ Position │ 0 │ CSG │
209 ├──────────────────────────────┼───────────────────────────────┼────────────────┼──────────────────────┼────────┤
210 └──────────────────────────────┴───────────────────────────────┴────────────────┴──────────────────────┴────────┘
211 Translations
212 XmIconBox inherits translations from XmManager.
213
215 Composite(3), Constraint(3), Core(3), XmCreateIconBox(3), XmIconBoxIs‐
216 CellEmpty(3), XmManager(3), XmVaCreateIconBox(3), and XmVaCreateMan‐
217 agedIconBox(3).
218
221 Copyright (c) 1992 by Integrated Computer Solutions, Inc.
222 XmIconBox(3X)