Blob Blame History Raw
.DT
.TH XmButtonBox 3X ""
.SH NAME
\fBXmButtonBox\fP \(em The Button Box class
.SH SYNOPSIS
.nf
#include <Xm/ButtonBox.h>
.fi
.SH DESCRIPTION
.PP
The Button Box widget manages children (usually buttons) in a single row or single 
column layout.
.PP
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.
.PP
Note: in what follows, major direction refers to the direction of orientation, and minor 
direction refers to the perpendicular direction.
.SS "Classes"
.PP
Button Box inherits behavior, resources, and traits from \fBCore\fP,
\fBComposite\fP, \fBConstraint\fP, and
\fBXmManager\fP\&.
.PP
The class pointer is \fBxmButtonBoxWidgetClass\fP\&.
.PP
The class name is \fBXmButtonBox\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.
\fBXmButtonBox Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNequalSizeXmCEqualSizeBooleanFalseCSG
_____
XmNfillOptionXmCFillOptionunsigned charXmFillNoneCSG
_____
XmNmarginHeightXmCMarginVerticalDimension0CSG
_____
XmNmarginWidthXmCMarginHorizontalDimension0CSG
_____
XmNorientationXmCOrientationunsigned charXmHORIZONTALCSG
_____
XmNdefaultButtonXmCWidgetWidgetNULLSG
_____
.TE
.IP  "\fBXmNequalSize\fP" 10
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.
.IP  "\fBXmNfillOption\fP" 10
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:
.RS
.IP  "\fBXmFillNone\fP" 10
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.
.IP  "\fBXmFillMinor\fP" 10
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.
.IP  "\fBXmFillMajor\fP" 10
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.
.IP  "\fBXmFillAll\fP" 10
This option combines the placement actions and sizing 
actions of XmFillMinor and XmFillMajor.
.IP "" 10
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.
.RE
.IP  "\fBXmNmarginHeight\fP" 10
.IP  "\fBXmNmarginWidth\fP" 10
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. 
.IP  "\fBXmNorientation\fP" 10
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.
.SS "Inherited Resources"
.PP
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\&.
.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
XmButtonBox inherits translations from XmManager\&.
.PP
.SH "RELATED"
.PP
\fBComposite\fP(3), \fBConstraint\fP(3),
\fBCore\fP(3),
\fBXmCreateButtonBox\fP(3),
\fBXmManager\fP(3),
\fBXmVaCreateButtonBox\fP(3),
\fBXmVaCreateManagedButtonBox\fP(3)\&.
.PP
.SH COPYRIGHT
.PP
Copyright (c) 1992 by Integrated Computer Solutions, Inc.