'\" t
...\" IconGadg.sgm /main/13 1996/09/08 20:47:14 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmIconGadget" "library call"
.SH "NAME"
\fBXmIconGadget\fR \(em The IconGadget widget class
.iX "XmIconGadget"
.iX "iconGadget" "IconGadget"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/IconG\&.h>
.fi
.SH "DESCRIPTION"
.PP
IconGadget is an instantiable widget used to display both text and a pixmap
in various combinations\&.
Other widgets that hold the \fBXmQTcontainer\fP trait, such as
Container, can use IconGadget to represent objects\&.
.PP
IconGadget text is a compound string\&. If no text is supplied, then
the compound string is generated from the gadget name\&. IconGadget
text is placed relative to the type of associated pixmap\&.
.PP
Depending upon the \fBXmNviewType\fP resource, IconGadget can display
two views:
.IP "\fBXmLARGE_ICON\fP" 10
The IconGadget text string is displayed below the
pixmap, and centered\&.
.IP "\fBXmSMALL_ICON\fP" 10
The IconGadget text string is placed on the side of the small icon, in the
widget\&'s \fBXmNlayoutDirection\fP\&.
.PP
A bitmap mask can be supplied for each pixmap to
clip the pixmap into some shape other than a rectangle\&. The
\fBXmNlargeIconMask\fP and \fBXmNsmallIconMask\fP resources specify
the large and small bitmap masks respectively\&. Visual emphasis for
the IconGadget is
provided with the \fBXmNvisualEmphasis\fP resource\&.
IconGadget\&'s \fBXmNdetail\fP and \fBXmNdetailCount\fP resources provide
a detail view for IconGadgets, enabling the display of Strings alongside the
IconGadget\&. The exact layout ordering of the strings depends on the
associated containing widget\&.
.PP
IconGadget uses the \fBXmQTcontainer\fP and
\fBXmQTspecifyRenderTable\fP traits, and
holds the \fBXmQTcareParentVisual\fP and \fBXmQTcontainerItem\fP traits\&.
.SS "Classes"
.PP
IconGadget inherits behaviour, resources, and traits from \fBObject,
RectObject\fP,
and \fBXmGadget\fP classes\&.
.PP
The class pointer is \fBxmIconGadgetClass\fP\&.
.PP
The class name is \fBXmIconGadget\fR\&.
.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 whether 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)\&.
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmIconGadget Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmalignmentXmCAlignmentunsigned charXmALIGNMENT_CENTERCSG
_____
XmNdetailXmCDetailXmStringTableNULLCSG
_____
XmNdetailCountXmCDetailCountCardinal0CSG
_____
XmNfontListXmCFontListXmFontListNULLCSG
_____
XmNlabelStringXmCXmStringXmStringdynamicCSG
_____
XmNlargeIconMaskXmCIconMaskPixmapdynamicCSG
_____
XmNlargeIconPixmapXmCIconPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNmarginHeightXmCMarginHeightDimension2CSG
_____
XmNmarginWidthXmCMarginWidthDimension2CSG
_____
XmNrenderTableXmCRenderTableXmRenderTabledynamicCSG
_____
XmNsmallIconMaskXmCIconMaskPixmapdynamicCSG
_____
XmNsmallIconPixmapXmCIconPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNviewTypeXmCViewTypeunsigned charXmLARGE_ICONCSG
_____
XmNvisualEmphasisXmCVisualEmphasisunsigned charXmNOT_SELECTEDCSG
_____
XmNspacingXmCSpacingDimension4CSG
_____
.TE
.IP "\fBXmNalignment\fP" 10
Specifies the horizontal alignment of the pixmap with
respect to the label when the icon is in
\fBLARGE_ICON\fP
view\&. Valid values are
\fBXmALIGNMENT_BEGINNING\fP,
\fBXmALIGNMENT_CENTER\fP,
and \fBXmALIGNMENT_END\fP\&.
.IP "\fBXmNdetail\fP" 10
Specifies an array of \fBXmString\fRs that are the detail information
associated with the gadget\&.
.IP "\fBXmNdetailCount\fP" 10
Specifies the size of the \fBXmNdetail\fP array\&.
.IP "\fBXmNfontList\fP" 10
Specifies the font list associated with \fBXmIconGadget\fR\&. The font list
is an obsolete construct, and has been superseded by the render table\&.
It is included for compatibility with earlier versions of Motif, and
for applications that do not easily support render tables\&. The
default font list is derived from the default render table, and if
both a font list and a render table are specified, the render table
takes precedence\&.
.IP "\fBXmNlabelString\fP" 10
Specifies the compound string\&.
If this value is NULL, it is initialized by converting the name of the
gadget to a compound string\&.
Refer to \fBXmString\fP(3)
for more information on the
creation and structure of compound strings\&.
.IP "\fBXmNlargeIconMask\fP" 10
Specifies the icon mask used when \fBXmNviewType\fP is \fBXmLARGE_ICON\fP\&.
.IP "\fBXmNlargeIconPixmap\fP" 10
Specifies the pixmap when \fBXmNviewType\fP is \fBXmLARGE_ICON\fP\&. If
this resource\&'s value is \fBXmUNSPECIFIED_PIXMAP\fP, there is no
pixmap\&. If a large
icon pixmap is specified, and if during conversion an associated mask
can be fetched, then the
\fBXmNlargeIconMask\fP resource is set to that mask\&.
.IP "\fBXmNmarginHeight\fP" 10
Specifies the amount of vertical space between the highlight
and the inside (pixmap and label)\&.
.IP "\fBXmNmarginWidth\fP" 10
Specifies the amount of horizontal space between the highlight
and the inside (pixmap and label)\&.
.IP "\fBXmNrenderTable\fP" 10
Specifies the \fBXmRenderTable\fR of the text used in the gadget\&.
If \fBXmNrenderTable\fP is NULL when the IconGadget is created, the parent\&'s
render table resource value is used if there is a render table\&. If
the parent does not have a render table,
the parent hierarchy of the widget is
searched for a widget that
holds the \fBXmQTspecifyRenderTable\fP trait\&.
If such an ancestor is found, the render table is initialized to the
\fBXmLABEL_RENDER_TABLE\fP value of the ancestor widget\&. If no such widget
is found, the default is implementation dependent\&.
Refer to
\fBXmRenderTable\fP(3) for more information on the creation and
structure of a \fBXmRenderTable\fR\&.
If both a render table and a font list are specified, the render table
will take precedence\&.
.IP "\fBXmNsmallIconMask\fP" 10
Specifies the icon mask used when \fBXmNviewType\fP is \fBXmSMALL_ICON\fP\&.
.IP "\fBXmNsmallIconPixmap\fP" 10
Specifies the pixmap when \fBXmNviewType\fP is \fBXmSMALL_ICON\fP\&.
If
this resource\&'s value is \fBXmUNSPECIFIED_PIXMAP\fP, there is no
pixmap\&. If a small
icon pixmap is specified, and if during conversion an associated mask
can be fetched, then the
\fBXmNsmallIconMask\fP resource is set to that mask\&.
.IP "\fBXmNspacing\fP" 10
Specifies the amount of space between the pixmap and
the label parts of the icon\&.
.IP "\fBXmNviewType\fP" 10
Specifies the view (combination of pixmaps/text) that will be displayed\&.
If the IconGadget is a child of a Container widget, however, then the
specification of this resource will be taken from the Container\(em
if Container\&'s \fBXmNentryViewType\fP is either \fBXmLARGE_ICON\fP or
\fBXmSMALL_ICON\fP, then IconGadget\&'s \fBXmNviewType\fP takes that value;
otherwise, the default is \fBXmLARGE_ICON\fP\&.
This resource is set to one of the following:
.RS
.IP "\fBXmLARGE_ICON\fP" 10
The pixmap specified by \fBXmNlargeIconPixmap\fP is
displayed with the \fBXmNlabelString\fP beneath it\&.
.IP "\fBXmSMALL_ICON\fP" 10
The pixmap specified by \fBXmNsmallIconPixmap\fP is
displayed with the \fBXmNlabelString\fP displayed in the direction of the
\fBXmNlayoutDirection\fP resource\&.
.RE
.IP "\fBXmNvisualEmphasis\fP" 10
Specifies the visual state of the IconGadget\&. If the IconGadget is in a
selected state
all visuals are displayed using the Container \fBXmNselectColor\fP
resource\&.
It is set to one of the following:
.RS
.IP "\fBXmSELECTED\fP" 10
The IconGadget is in the selected state and displays
the appropriate visuals\&.
.IP "\fBXmNOT_SELECTED\fP" 10
The IconGadget is not in the selected state\&.
.RE
.SS "Inherited Resources"
.PP
IconGadget 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\&.
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBXmGadget Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNbackgroundXmCBackgroundPixeldynamicCSG
_____
XmNbackgroundPixmapXmCPixmapPixmapXmUNSPECIFIED_PIXMAPCSG
_____
XmNbottomShadowColorXmCBottomShadowColorPixeldynamicCSG
_____
XmNbottomShadowPixmapXmCBottomShadowPixmapPixmapdynamicCSG
_____
XmNhelpCallbackXmCCallbackXtCallbackListNULLC
_____
XmNforegroundXmCForegroundPixeldynamicCSG
_____
XmNhighlightColorXmCHighlightColorPixeldynamicCSG
_____
XmNhighlightOnEnterXmCHighlightOnEnterBooleanFalseCSG
_____
XmNhighlightPixmapXmCHighlightPixmapPixmapdynamicCSG
_____
XmNhighlightThicknessXmCHighlightThicknessDimension0CSG
_____
XmNlayoutDirectionXmNCLayoutDirectionXmDirectiondynamicCG
_____
XmNnavigationTypeXmCNavigationTypeXmNavigationTypeXmNONECSG
_____
XmNshadowThicknessXmCShadowThicknessDimension0CSG
_____
XmNtopShadowColorXmCTopShadowColorPixeldynamicCSG
_____
XmNtopShadowPixmapXmCTopShadowPixmapPixmapdynamicCSG
_____
XmNtraversalOnXmCTraversalOnBooleanFalseCSG
_____
XmNunitTypeXmCUnitTypeunsigned chardynamicCSG
_____
XmNuserDataXmCUserDataXtPointerNULLCSG
_____
.TE
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBRectObj Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNancestorSensitiveXmCSensitiveBooleandynamicG
_____
XmNborderWidthXmCBorderWidthDimension0N/A
_____
XmNheightXmCHeightDimensiondynamicCSG
_____
XmNsensitiveXmCSensitiveBooleanTrueCSG
_____
XmNwidthXmCWidthDimensiondynamicCSG
_____
XmNxXmCPositionPosition0CSG
_____
XmNyXmCPositionPosition0CSG
_____
.TE
.TS
tab() box;
c s s s s
l| l| l| l| l.
\fBObject Resource Set\fP
\fBName\fP\fBClass\fP\fBType\fP\fBDefault\fP\fBAccess\fP
_____
XmNdestroyCallbackXmCCallbackXtCallbackListNULLC
_____
.TE
.SS "Additional Behavior"
.PP
IconGadget has no behavior\&.
.SS "Virtual Bindings"
.PP
The bindings for virtual keys are vendor specific\&.
For information about bindings for virtual buttons and keys, see
\fBVirtualBindings\fP(3)\&.
.SS "Errors/Warnings"
.PP
The toolkit will display a warning if an incorrect value is given
for an enumeration resource\&.
.SH "RELATED"
.PP
\fBCore\fP(3),
\fBXmContainer\fP(3),
\fBXmCreateIconGadget\fP(3),
\fBXmGadget\fP(3),
\fBXmVaCreateIconGadget\fP(3), and
\fBXmVaCreateManagedIconGadget\fP(3)\&.