← Back to branch summary

~ubuntu-branches/ubuntu/quantal/openmotif/quantal

« back to all changes in this revision

Viewing changes to doc/man/man3/XmIconBox.3

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Bauer
  • Date: 2010-06-23 12:12:31 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100623121231-u89gxdp51sg9wjj2
Tags: 2.3.0-1
http://bugs.debian.org/379258
http://bugs.debian.org/494375
http://bugs.debian.org/288537
* New Maintainer (Closes: #379258) 
* Acknowledge NMU changes
* New upstream release (Closes: #494375)
* Get rid of security patches as they are already part of new upstream
  release (00-xpmvuln.openmotif.patch, 342092-CVE-2005-3964.patch)
* Bump Standards to 3.8.4
* Added {misc:Depends} to make the package lintian cleaner
* Fix weak-library-dev-dependency by adding ${binary:Version}) for the
  -dev Package of openmotif
* Let package depend on autotools-dev to use newer autotools-helper-files
* Work around an autoconf-bug (Gentoo-Bug #1475)
* Added Client-side anti-aliased fonts support via XFT
* Added UTF-8 and UTF8_STRING atom support
* Ability to show text and pixmaps in Label, LabelGadget and all
  derived widgets
* Support of PNG/JPEG image formats in the same way as XPM is supported
* Increase FILE_OFFSET_BITS to 64 to show files >2GB in file-selector
  Idea taken from Magne Oestlyngen (Closes: #288537)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/XmIconBox.3
 
1
.DT
 
2
.TH XmIconBox 3X ""
 
3
.SH NAME
 
4
\fBXmIconBox\fP \(em The IconBox widget class
 
5
.SH SYNOPSIS
 
6
.nf
 
7
#include <Xm/IconBox.h>
 
8
.fi
 
9
.SH DESCRIPTION
 
10
.PP
 
11
The Icon Box widget lays out its children on a grid with each child forced
 
12
to be the same size and with the location of each child specified as an X
 
13
and Y location on the grid.
 
14
.PP
 
15
The size of the Icon Box, its children, and the number of cells displayed
 
16
are calculated as described below. The general idea is that all children
 
17
are always be shown and should be given their desired size whenever possible.
 
18
The user may add or delete cells by resizing this window using the window
 
19
manager widget.
 
20
.PP
 
21
The preferred size is calculated by using the maximum desired child height
 
22
or width and making sure that these are no smaller than the minimum sizes.
 
23
This size is multiplied by the number of cells along the axis and properly
 
24
padded to come up with a preferred size. The number of cells is the maximum
 
25
of the largest cellX or cellY value and the minimum number of horizontal or
 
26
vertical cells\&.
 
27
.PP
 
28
If the Icon box is forced larger than its preferred size more cells are
 
29
added at the bottom-right of the widget while the children all remain at
 
30
their preferred sizes\&.
 
31
.PP
 
32
If the Icon box is forced smaller than its preferred size each cell is
 
33
forced to be smaller in order to allow all children to fit within the
 
34
Icon Box. All children will be forced to the same smaller size.
 
35
.SS "Classes"
 
36
.PP
 
37
Icon Box inherits behavior, resources, and traits from \fBCore\fP,
 
38
\fBComposite\fP, \fBConstraint\fP, and
 
39
\fBXmManager\fP\&.
 
40
.PP
 
41
The class pointer is \fBxmIconBoxWidgetClass\fP\&.
 
42
.PP
 
43
The class name is \fBXmIconBox\fP\&.
 
44
.SS "New Resources"
 
45
.PP
 
46
The following table defines a set of widget resources used by the
 
47
programmer to specify data\&. The programmer can also set the resource
 
48
values for the inherited classes to set attributes for this widget\&.
 
49
To reference a resource by name or by class in a \fB\&.Xdefaults\fP file,
 
50
remove the \fBXmN\fP or \fBXmC\fP prefix and use the remaining letters\&.
 
51
To specify one of the defined values for a resource in a \fB\&.Xdefaults\fP
 
52
file, remove the \fBXm\fP prefix and use the remaining letters (in
 
53
either lowercase or uppercase, but include any underscores between
 
54
words)\&. The codes in the access column indicate if the given resource
 
55
can be set at creation time (C), set by using \fBXtSetValues\fP
 
56
(S), retrieved by using \fBXtGetValues\fP (G), or is not
 
57
applicable (N/A)\&.
 
58
.PP
 
59
.TS
 
60
tab() box;
 
61
c s s s s
 
62
l| l| l| l| l.
 
63
\fBXmIconBox Resource Set\fP
 
64
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
65
_____
 
66
XmNhorizontalMarginXmCMarginDimension4CSG
 
67
_____
 
68
XmNminimumHorizontalCellsXmCDefaultCellsint8CSG
 
69
_____
 
70
XmNminimumVerticalCellsXmCDefaultCellsint4CSG
 
71
_____
 
72
XmNminimumCellHeightXmCMinimumCellSizeDimension10CSG
 
73
_____
 
74
XmNminimumCellWidthXmCMinimumCellSizeDimension20CSG
 
75
_____
 
76
XmNverticalMarginXmCMarginDimension4CSG
 
77
_____
 
78
.TE
 
79
.IP "\fBXmNhorizontalMargin\fP" 10
 
80
.IP "\fBXmNverticalMargin\fP" 10
 
81
The amount of space between each cell and its neighbor or the edge of the Icon 
 
82
Box.
 
83
.IP "\fBXmNminimumHorizontalCells\fP" 10
 
84
.IP "\fBXmNminimumVerticalCells\fP" 10
 
85
The minimum number of cells to display in the horizontal and vertical directions. 
 
86
This number of cells will always be displayed.
 
87
.IP "\fBXmNminimumCellWidth\fP" 10
 
88
.IP "\fBXmNminimumCellHeight\fP" 10
 
89
The smallest size the cells are allowed to be in the direction specified.
 
90
.PP
 
91
.SS "Constraint Resources"
 
92
.PP
 
93
.TS
 
94
tab() box;
 
95
c s s s s
 
96
l| l| l| l| l.
 
97
\fBXmIconBox Constraint Resource Set\fP
 
98
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
99
_____
 
100
XmNcellXXmCCellXShortXmIconBoxAnyCellCSG
 
101
_____
 
102
XmNcellYXmCCellYShortXmIconBoxAnyCellCSG
 
103
_____
 
104
.TE
 
105
.IP "\fBXmNcellX\fP" 10
 
106
.IP "\fBXmNcellY\fP" 10
 
107
The location of this cell in cell space. These coordinates may be any positive 
 
108
integer. They determine where this widget will be placed relative to its neighbors. 
 
109
Having two children at the same cell X and cell Y location will result in undefined 
 
110
behavior. To place a cell at any empty cell, set cell X and cell Y to the value 
 
111
XmIconBoxAnyCell.
 
112
.SS "Inherited Resources"
 
113
.PP
 
114
Icon Box inherits behavior and resources from the
 
115
superclasses described in the following tables\&.
 
116
For a complete description of each resource, refer to the
 
117
reference page for that superclass\&.
 
118
.PP
 
119
.TS
 
120
tab() box;
 
121
c s s s s
 
122
l| l| l| l| l.
 
123
\fBXmManager Resource Set\fP
 
124
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
125
_____
 
126
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
 
127
_____
 
128
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
 
129
_____
 
130
XmNforegroundXmCForegroundPixeldynamicCSG
 
131
_____
 
132
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
 
133
_____
 
134
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
 
135
_____
 
136
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
 
137
_____
 
138
XmNinitialFocusXmCInitialFocusWidgetdynamicCSG
 
139
_____
 
140
XmNlayoutDirectionXmCLayoutDirectionXmDirectiondynamicCG
 
141
_____
 
142
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmTAB_GROUPCSG
 
143
_____
 
144
XmNpopupHandlerCallbackXmCCallbackXtCallbackListNULLC
 
145
_____
 
146
XmNshadowThicknessXmCShadowThicknessDimensiondynamicCSG
 
147
_____
 
148
XmNstringDirectionXmCStringDirectionXmStringDirectiondynamicCG
 
149
_____
 
150
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
 
151
_____
 
152
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
 
153
_____
 
154
XmNtraversalOnXmCTraversalOnBooleanTrueCSG
 
155
_____
 
156
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
 
157
_____
 
158
XmNuserDataXmCUserDataXtPointerNULLCSG
 
159
_____
 
160
.TE
 
161
.PP
 
162
.TS
 
163
tab() box;
 
164
c s s s s
 
165
l| l| l| l| l.
 
166
\fBComposite Resource Set\fP
 
167
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
168
_____
 
169
XmNchildrenXmCReadOnlyWidgetListNULLG
 
170
_____
 
171
XmNinsertPositionXmCInsertPositionXtOrderProcNULLCSG
 
172
_____
 
173
XmNnumChildrenXmCReadOnlyCardinal0G
 
174
_____
 
175
.TE
 
176
.PP
 
177
.TS
 
178
tab() box;
 
179
c s s s s
 
180
l| l| l| l| l.
 
181
\fBCore Resource Set\fP
 
182
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
 
183
_____
 
184
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicN/A
 
185
_____
 
186
XmNancestorSensitiveXmCSensitiveBooleandynamicG
 
187
_____
 
188
XmNbackgroundXmCBackgroundPixeldynamicCSG
 
189
_____
 
190
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
 
191
_____
 
192
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
 
193
_____
 
194
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
 
195
_____
 
196
XmNborderWidthXmCBorderWidthDimension0CSG
 
197
_____
 
198
XmNcolormapXmCColormapColormapdynamicCG
 
199
_____
 
200
XmNdepthXmCDepthintdynamicCG
 
201
_____
 
202
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
 
203
_____
 
204
XmNheightXmCHeightDimensiondynamicCSG
 
205
_____
 
206
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
 
207
_____
 
208
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
 
209
_____
 
210
XmNscreenXmCScreenScreen *dynamicCG
 
211
_____
 
212
XmNsensitiveXmCSensitiveBooleanTrueCSG
 
213
_____
 
214
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
 
215
_____
 
216
XmNwidthXmCWidthDimensiondynamicCSG
 
217
_____
 
218
XmNxXmCPositionPosition0CSG
 
219
_____
 
220
XmNyXmCPositionPosition0CSG
 
221
_____
 
222
.TE
 
223
.SS "Translations"
 
224
.PP
 
225
XmIconBox inherits translations from XmManager\&.
 
226
.PP
 
227
.SH "RELATED"
 
228
.PP
 
229
\fBComposite\fP(3), \fBConstraint\fP(3),
 
230
\fBCore\fP(3),
 
231
\fBXmCreateIconBox\fP(3),
 
232
\fBXmIconBoxIsCellEmpty\fP(3),
 
233
\fBXmManager\fP(3),
 
234
\fBXmVaCreateIconBox\fP(3), and
 
235
\fBXmVaCreateManagedIconBox\fP(3)\&.
 
236
 
 
237
.PP
 
238
.SH COPYRIGHT
 
239
.PP
 
240
Copyright (c) 1992 by Integrated Computer Solutions, Inc.