XmIconBox(3X)

✨ NAME ✨

XmIconBox — The IconBox widget class. bestie, this is the XmIconBox(3X) manual, and we're doing it in parts, so buckle up 💅

---

🌸 SYNOPSIS 🌸

#include <Xm/IconBox.h>

---

🦋 DESCRIPTION 🦋

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.

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 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.

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.

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.

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.

👑 Classes 👑

Icon Box inherits behavior, resources, and traits from Core, Composite, Constraint, and XmManager.

The class pointer is xmIconBoxWidgetClass.

The class name is XmIconBox.

---

💖 New Resources 💖

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 .Xdefaults file, remove the XmN or XmC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the Xm 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 XtSetValues (S), retrieved by using XtGetValues (G), or is not applicable (N/A).

🌈 XmIconBox Resource Set 🌈

• XmNhorizontalMargin — class XmCMargin, type Dimension, default 4, access CSG
• XmNminimumHorizontalCells — class XmCDefaultCells, type int, default 8, access CSG
• XmNminimumVerticalCells — class XmCDefaultCells, type int, default 4, access CSG
• XmNminimumCellHeight — class XmCMinimumCellSize, type Dimension, default 10, access CSG
• XmNminimumCellWidth — class XmCMinimumCellSize, type Dimension, default 20, access CSG
• XmNverticalMargin — class XmCMargin, type Dimension, default 4, access CSG
• XmNhorizontalMargin, XmNverticalMargin — The amount of space between each cell and its neighbor or the edge of the Icon Box. spacing is self-care, fr fr ✨
• XmNminimumHorizontalCells, XmNminimumVerticalCells — The minimum number of cells to display in the horizontal and vertical directions. This number of cells will always be displayed. they're not going anywhere, bestie
• XmNminimumCellWidth, XmNminimumCellHeight — The smallest size the cells are allowed to be in the direction specified. tiny but mighty, but not too tiny

---

💜 Constraint Resources 💜

✨ XmIconBox Constraint Resource Set ✨

• XmNcellX — class XmCCellX, type Short, default XmIconBoxAnyCell, access CSG
• XmNcellY — class XmCCellY, type Short, default XmIconBoxAnyCell, access CSG
• XmNcellX, XmNcellY — 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. do not put two kiddos in the same spot, that's chaos 😭

---

🌈 Inherited Resources 🌈

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.

✨ XmManager Resource Set ✨

okay bestie, these are the XmManager resources that come with XmIconBox. every single one, no cap. 💖

• XmNbottomShadowColor — class XmCBottomShadowColor, type Pixel, default dynamic, access CSG
• XmNbottomShadowPixmap — class XmCBottomShadowPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG
• XmNforeground — class XmCForeground, type Pixel, default dynamic, access CSG
• XmNhelpCallback — class XmCCallback, type XtCallbackList, default NULL, access C
• XmNhighlightColor — class XmCHighlightColor, type Pixel, default dynamic, access CSG
• XmNhighlightPixmap — class XmCHighlightPixmap, type Pixmap, default dynamic, access CSG
• XmNinitialFocus — class XmCInitialFocus, type Widget, default dynamic, access CSG
• XmNlayoutDirection — class XmCLayoutDirection, type XmDirection, default dynamic, access CG
• XmNnavigationType — class XmCNavigationType, type XmNavigationType, default XmTAB_GROUP, access CSG
• XmNpopupHandlerCallback — class XmCCallback, type XtCallbackList, default NULL, access C
• XmNshadowThickness — class XmCShadowThickness, type Dimension, default dynamic, access CSG
• XmNstringDirection — class XmCStringDirection, type XmStringDirection, default dynamic, access CG
• XmNtopShadowColor — class XmCTopShadowColor, type Pixel, default dynamic, access CSG
• XmNtopShadowPixmap — class XmCTopShadowPixmap, type Pixmap, default dynamic, access CSG
• XmNtraversalOn — class XmCTraversalOn, type Boolean, default True, access CSG
• XmNunitType — class XmCUnitType, type unsigned char, default dynamic, access CSG
• XmNuserData — class XmCUserData, type XtPointer, default NULL, access CSG

and that's the whole XmManager set, periodt. 💅

---

🌈 Composite Resource Set 🌈

next up, the Composite resources. these are lowkey iconic too. 🦋

• XmNchildren — class XmCReadOnly, type WidgetList, default NULL, access G
• XmNinsertPosition — class XmCInsertPosition, type XtOrderProc, default NULL, access CSG
• XmNnumChildren — class XmCReadOnly, type Cardinal, default 0, access G

---

✨ Core Resource Set ✨

okay so the original lays this out as a big table and we can't do tables in here, so bestie it's a list now — every single resource, class, type, default and access value is still right here, no cap 💖

• XmNaccelerators — class XmCAccelerators, type XtAccelerators, default dynamic, access N/A
• XmNancestorSensitive — class XmCSensitive, type Boolean, default dynamic, access G
• XmNbackground — class XmCBackground, type Pixel, default dynamic, access CSG
• XmNbackgroundPixmap — class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG
• XmNborderColor — class XmCBorderColor, type Pixel, default XtDefaultForeground, access CSG
• XmNborderPixmap — class XmCPixmap, type Pixmap, default XmUNSPECIFIED_PIXMAP, access CSG
• XmNborderWidth — class XmCBorderWidth, type Dimension, default 0, access CSG
• XmNcolormap — class XmCColormap, type Colormap, default dynamic, access CG
• XmNdepth — class XmCDepth, type int, default dynamic, access CG
• XmNdestroyCallback — class XmCCallback, type XtCallbackList, default NULL, access C
• XmNheight — class XmCHeight, type Dimension, default dynamic, access CSG
• XmNinitialResourcesPersistent — class XmCInitialResourcesPersistent, type Boolean, default True, access C
• XmNmappedWhenManaged — class XmCMappedWhenManaged, type Boolean, default True, access CSG
• XmNscreen — class XmCScreen, type Screen *, default dynamic, access CG
• XmNsensitive — class XmCSensitive, type Boolean, default True, access CSG
• XmNtranslations — class XmCTranslations, type XtTranslations, default dynamic, access CSG
• XmNwidth — class XmCWidth, type Dimension, default dynamic, access CSG
• XmNx — class XmCPosition, type Position, default 0, access CSG
• XmNy — class XmCPosition, type Position, default 0, access CSG

that's the whole set, all nineteen of them, untouched 💅

---

🦋 Translations 🦋

XmIconBox inherits translations from XmManager. that's it, that's the whole vibe — she's not doing her own translations, she's borrowing mom's 🫶

---

💖 RELATED 💖

the little "go read these next" stack, and honestly the girls are all serving:

• Composite(3)
• Constraint(3)
• Core(3)
• XmCreateIconBox(3)
• XmIconBoxIsCellEmpty(3)
• XmManager(3)
• XmVaCreateIconBox(3)
• XmVaCreateManagedIconBox(3)

---

👑 COPYRIGHT 👑

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

periodt. intellectual property stays intellectual property, we don't touch it, we just respect it 🌸

---

and that's a wrap on the whole page, bestie!! the lil footer at the very bottom just says XmIconBox(3X) — that's the source/version tag for this manual page, no date on it, that's all she wrote 💜✨