.DT
.TH XmIconBox 3X ""
.SH NAME
\fBXmIconBox\fP \(em The IconBox widget class
.SH SYNOPSIS
.nf
#include <Xm/IconBox.h>
.fi
.SH DESCRIPTION
.PP
The Icon Box widget lays out its children on a grid with each child forced
to be the same size and with the location of each child specified as an X
and Y location on the grid.
.PP
The size of the Icon Box, its children, and the number of cells displayed
are calculated as described below. The general idea is that all children
are always be shown and should be given their desired size whenever possible.
The user may add or delete cells by resizing this window using the window
manager widget.
.PP
The preferred size is calculated by using the maximum desired child height
or width and making sure that these are no smaller than the minimum sizes.
This size is multiplied by the number of cells along the axis and properly
padded to come up with a preferred size. The number of cells is the maximum
of the largest cellX or cellY value and the minimum number of horizontal or
vertical cells\&.
.PP
If the Icon box is forced larger than its preferred size more cells are
added at the bottom-right of the widget while the children all remain at
their preferred sizes\&.
.PP
If the Icon box is forced smaller than its preferred size each cell is
forced to be smaller in order to allow all children to fit within the
Icon Box. All children will be forced to the same smaller size.
.SS "Classes"
.PP
Icon Box inherits behavior, resources, and traits from \fBCore\fP,
\fBComposite\fP, \fBConstraint\fP, and
\fBXmManager\fP\&.
.PP
The class pointer is \fBxmIconBoxWidgetClass\fP\&.
.PP
The class name is \fBXmIconBox\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.
\fBXmIconBox Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNhorizontalMarginXmCMarginDimension4CSG
_____
XmNminimumHorizontalCellsXmCDefaultCellsint8CSG
_____
XmNminimumVerticalCellsXmCDefaultCellsint4CSG
_____
XmNminimumCellHeightXmCMinimumCellSizeDimension10CSG
_____
XmNminimumCellWidthXmCMinimumCellSizeDimension20CSG
_____
XmNverticalMarginXmCMarginDimension4CSG
_____
.TE
.IP "\fBXmNhorizontalMargin\fP" 10
.IP "\fBXmNverticalMargin\fP" 10
The amount of space between each cell and its neighbor or the edge of the Icon 
Box.
.IP "\fBXmNminimumHorizontalCells\fP" 10
.IP "\fBXmNminimumVerticalCells\fP" 10
The minimum number of cells to display in the horizontal and vertical directions. 
This number of cells will always be displayed.
.IP "\fBXmNminimumCellWidth\fP" 10
.IP "\fBXmNminimumCellHeight\fP" 10
The smallest size the cells are allowed to be in the direction specified.
.PP
.SS "Constraint Resources"
.PP
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmIconBox Constraint Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNcellXXmCCellXShortXmIconBoxAnyCellCSG
_____
XmNcellYXmCCellYShortXmIconBoxAnyCellCSG
_____
.TE
.IP "\fBXmNcellX\fP" 10
.IP "\fBXmNcellY\fP" 10
The location of this cell in cell space. These coordinates may be any positive 
integer. They determine where this widget will be placed relative to its neighbors. 
Having two children at the same cell X and cell Y location will result in undefined 
behavior. To place a cell at any empty cell, set cell X and cell Y to the value 
XmIconBoxAnyCell.
.SS "Inherited Resources"
.PP
Icon Box inherits behavior and resources from the
superclasses described in the following tables\&.
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.
\fBXmManager Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
_____
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNforegroundXmCForegroundPixeldynamicCSG
_____
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
_____
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
_____
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
_____
XmNinitialFocusXmCInitialFocusWidgetdynamicCSG
_____
XmNlayoutDirectionXmCLayoutDirectionXmDirectiondynamicCG
_____
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmTAB_GROUPCSG
_____
XmNpopupHandlerCallbackXmCCallbackXtCallbackListNULLC
_____
XmNshadowThicknessXmCShadowThicknessDimensiondynamicCSG
_____
XmNstringDirectionXmCStringDirectionXmStringDirectiondynamicCG
_____
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
_____
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
_____
XmNtraversalOnXmCTraversalOnBooleanTrueCSG
_____
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
_____
XmNuserDataXmCUserDataXtPointerNULLCSG
_____
.TE
.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
.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
_____
XmNacceleratorsXmCAcceleratorsXtAcceleratorsdynamicN/A
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderColorXmCBorderColorPixelXtDefaultForegroundCSG
_____
XmNborderPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNborderWidthXmCBorderWidthDimension0CSG
_____
XmNcolormapXmCColormapColormapdynamicCG
_____
XmNdepthXmCDepthintdynamicCG
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNinitialResourcesPersistentXmCInitialResourcesPersistentBooleanTrueC
_____
XmNmappedWhenManagedXmCMappedWhenManagedBooleanTrueCSG
_____
XmNscreenXmCScreenScreen *dynamicCG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNtranslationsXmCTranslationsXtTranslationsdynamicCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.SS "Translations"
.PP
XmIconBox inherits translations from XmManager\&.
.PP
.SH "RELATED"
.PP
\fBComposite\fP(3), \fBConstraint\fP(3),
\fBCore\fP(3),
\fBXmCreateIconBox\fP(3),
\fBXmIconBoxIsCellEmpty\fP(3),
\fBXmManager\fP(3),
\fBXmVaCreateIconBox\fP(3), and
\fBXmVaCreateManagedIconBox\fP(3)\&.

.PP
.SH COPYRIGHT
.PP
Copyright (c) 1992 by Integrated Computer Solutions, Inc.