XmButtonBox(3X)

πŸ“¦
version 2.5.2 Β· 2 versions
, in alpine 3.24, arch rolling, centos-stream 9, epel 10, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

πŸ’… XmButtonBox(3X) πŸ’…

okay bestie, welcome to the XmButtonBox(3X) manual page. This is the Button Box class, and it's lowkey iconic for making rows or columns of buttons behave. Periodt. ✨

✨ NAME ✨

XmButtonBox β€” The Button Box class

✨ SYNOPSIS ✨

#include <Xm/ButtonBox.h>

✨ DESCRIPTION ✨

The Button Box widget manages children (usually buttons) in a single row or single column layout. No cap, it's giving group-chat organizer energy: everyone lined up, nobody crowding anyone. πŸ’…

The Button Box maintains equal spacing between its children at all times and attempts to adjust its height and width as necessary so that all children will fit. If this is not possible, due to parent or application programmer constraints, the Button Box will resize its children as necessary to fit within the available space. Highkey it's doing the most so everything fits. 🫢

Note: in what follows, major direction refers to the direction of orientation, and minor direction refers to the perpendicular direction. iykyk 🧚

πŸŽ€ Classes πŸŽ€

Button Box inherits behavior, resources, and traits from Core, Composite, Constraint, and XmManager. iykyk πŸ’–

The class pointer is xmButtonBoxWidgetClass.

The class name is XmButtonBox.


πŸ¦‹ 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).

  • XmNequalSize β€” Name: XmNequalSize Β· Class: XmCEqualSize Β· Type: Boolean Β· Default: False Β· Access: CSG
  • XmNfillOption β€” Name: XmNfillOption Β· Class: XmCFillOption Β· Type: unsigned char Β· Default: XmFillNone Β· Access: CSG
  • XmNmarginHeight β€” Name: XmNmarginHeight Β· Class: XmCMargin Β· Type: VerticalDimension Β· Default: 0 Β· Access: CSG
  • XmNmarginWidth β€” Name: XmNmarginWidth Β· Class: XmCMargin Β· Type: HorizontalDimension Β· Default: 0 Β· Access: CSG
  • XmNorientation β€” Name: XmNorientation Β· Class: XmCOrientation Β· Type: unsigned char Β· Default: XmHORIZONTAL Β· Access: CSG
  • XmNdefaultButton β€” Name: XmNdefaultButton Β· Class: XmCWidget Β· Type: Widget Β· Default: NULL Β· Access: SG

πŸ’– XmNequalSize πŸ’–

Specifies whether the children are to be maintained with equal sized heights and widths. The chosen height and width for the children is found by asking each child for its preferred size and taking the largest value in each direction. So demure, so mindful. ✨

πŸ’– XmNfillOption πŸ’–

Specifies how to use any extra space left over once all children have been sized according to either their preference or equalSize. There are four options:

  • XmFillNone β€” No automatic filling is performed. Center the children in the minor direction and place the children with equal padding between them in the major direction.
  • XmFillMinor β€” Place the children with equal padding between them in the major direction, but force all the children to take on the Button Box minor dimension as their minor direction.
  • XmFillMajor β€” Center the children in the minor direction, but expand all the children in their major direction so that there is no padding between them. Expand the children such that their relative sizes remain constant.
  • XmFillAll β€” This option combines the placement actions and sizing actions of XmFillMinor and XmFillMajor.

Regardless of the fill mode, the ButtonBox widget will always leave the specified margin between its edge and the nearest child. A new String to fillOption resource converter has been registered to convert the following strings to fill options: "none", "major", "minor", "all." This resource can therefore be set in an application defaults file. Obsessed. 🌈

πŸ’– XmNmarginHeight and XmNmarginWidth πŸ’–

Specifies the number of pixels to use as a margin around the entire group of children. The marginHeight value applies to both the top and bottom margins, while the marginWidth applies to the left and right margins. Personal space matters, fr fr. πŸ’…

πŸ’– XmNorientation πŸ’–

Specifies whether children are to be placed in a row or a column. The orientation may be either XmHORIZONTAL or XmVERTICAL. If the orientation is XmHORIZONTAL, the children are placed in a row with the major dimension being width and the minor dimension being height. If the value is XmVERTICAL, the children are placed in a column with the major dimension being height and the minor dimension being width. The default value is XmHORIZONTAL. Main character energy, honestly. πŸ‘‘


🌈 Inherited Resources 🌈

Button 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 🌸

Every XmButtonBox inherits this whole stack from XmManager, bestie. Name, class, type, default, access β€” all of it, right here, no skips. πŸ’–

  • 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

πŸ¦‹ Composite Resource Set πŸ¦‹

And because XmButtonBox is also a Composite widget, you get this little trio on top of everything else. Three (3) resources, no more, no less, and yes the third one is genuinely just a count. πŸ’…

  • 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
Ngl, those access codes are doing a lot of heavy lifting and the page just hands them to you raw β€” CSG, CG, C, G. It's giving "iykyk" energy. Take them exactly as written, bestie, don't go improvising. πŸ™ˆ

✨ Core Resource Set ✨

okay bestie, here's every single knob, dial, and vibe setting on this thing. no skipping, no summarizing β€” all of them, periodt. πŸ’–

  • 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

Translations πŸ’…

XmButtonBox inherits translations from XmManager. that's the whole tea, bestie. ✨



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


XmButtonBox(3X) β€” that's the source/version, and the date is whatever your local manpage footer says, bestie. mwah. πŸ’–βœ¨