XmFrame(3X)XmFrame(3X)NAMEXmFrame - The Frame widget class
SYNOPSIS
#include <Xm/Frame.h>
DESCRIPTION
Frame is a very simple manager used to enclose a single work area child
in a border drawn by Frame. It uses the Manager class resources for
border drawing and performs geometry management so that its size always
matches its child's outer size plus the Frame's margins and shadow
thickness.
Frame is most often used to enclose other managers when the application
developer desires the manager to have the same border appearance as the
primitive widgets. Frame can also be used to enclose primitive widgets
that do not support the same type of border drawing. This gives visual
consistency when you develop applications using diverse widget sets.
Constraint resources are used to designate a child as the Frame title,
align its text, and control its vertical alignment in relation to
Frame's top shadow. The title appears only at the top of the Frame.
If the Frame's parent is a Shell widget, XmNshadowType defaults to
XmSHADOW_OUT, and Manager's resource XmNshadowThickness defaults to 1.
If the Frame's parent is not a Shell widget, XmNshadowType defaults to
XmSHADOW_ETCHED_IN, and Manager's resource XmNshadowThickness defaults
to 2.
Classes
Frame inherits behavior and resources from the Core, Composite, Con‐
straint, and XmManager classes.
The class pointer is xmFrameWidgetClass.
The class name is XmFrame.
New Resources
The following table defines a set of widget resources used by the pro‐
grammer to specify data. The programmer can also set the resource val‐
ues 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).
XmFrame Resource Set
Class: XmCMarginWidth
Default: 0
Type: Dimension
Access: CSG
Class: XmCMarginHeight
Default: 0
Type: Dimension
Access: CSG
Class: XmCShadowType
Default: dynamic
Type: unsigned char
Access: CSG
Specifies the padding space on the left and right sides between
Frame's child and Frame's shadow drawing. Specifies the padding
space on the top and bottom sides between Frame's child and
Frame's shadow drawing. When a title is present, the top margin
equals the value specified by this resource plus the distance
(if any) that the title extends below the top shadow. Describes
the drawing style for Frame. This resource can have the follow‐
ing values: XmSHADOW_IN--draws Frame so that it appears inset.
This means that the bottom shadow visuals and top shadow visuals
are reversed. XmSHADOW_OUT--draws Frame so that it appears out‐
set. This is the default if Frame's parent is a Shell widget.
XmSHADOW_ETCHED_IN--draws Frame using a double line giving the
effect of a line etched into the window. The thickness of the
double line is equal to the value of XmNshadowThickness. This is
the default when Frame's parent is not a Shell widget.
XmSHADOW_ETCHED_OUT--draws Frame using a double line giving the
effect of a line coming out of the window. The thickness of the
double line is equal to the value of XmNshadowThickness.
XmFrame Constraint Resource Set
Class: XmCChildType
Default: XmFRAME_WORKAREA_CHILD
Type: unsigned char
Access: CSG
Class: XmCChildHorizontalAlignment
Default: XmALIGNMENT_BEGINNING
Type: unsigned char
Access: CSG
Class: XmCChildHorizontalSpacing
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCChildVerticalAlignment
Default: XmALIGNMENT_CENTER
Type: unsigned char
Access: CSG
Specifies whether a child is a title or work area. Frame supports a
single title and/or work area child. The possible values are:
XmFRAME_TITLE_CHILD XmFRAME_WORKAREA_CHILD XmFRAME_GENERIC_CHILD
The Frame geometry manager ignores any child of type
XmFRAME_GENERIC_CHILD. Specifies the alignment of the title.
This resource has the following values: XmALIGNMENT_BEGINNING
XmALIGNMENT_CENTER XmALIGNMENT_END
See the description of XmNalignment in the XmLabel(3X) man page
for an explanation of these values. Specifies the minimum dis‐
tance between either edge of the title text and the inner edge
of the Frame shadow. Clipping of the title text occurs in order
to maintain this spacing. The default value is the margin width
of the Frame. Specifies the vertical alignment of the title
text, or the title area in relation to the top shadow of the
Frame. XmALIGNMENT_BASELINE_BOTTOM--causes the baseline of the
title to align vertically with the top shadow of the Frame. In
the case of a multi-line title, the baseline of the last line of
text aligns vertically with the top shadow of the Frame. XmA‐
LIGNMENT_BASELINE_TOP--causes the baseline of the first line of
the title to align vertically with the top shadow of the Frame.
XmALIGNMENT_WIDGET_TOP--causes the top edge of the title area to
align vertically with the top shadow of the Frame. XmALIGN‐
MENT_CENTER--causes the center of the title area to align verti‐
cally with the top shadow of the Frame. XmALIGNMENT_WIDGET_BOT‐
TOM--causes the bottom edge of the title area to align verti‐
cally with the top shadow of the Frame.
Inherited Resources
Frame inherits behavior and resources from the following superclasses.
For a complete description of each resource, refer to the man page for
that superclass.
XmManager Resource Set
Class: XmCBottomShadowColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCBottomShadowPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCForeground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHighlightColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCHighlightPixmap
Default: dynamic
Type: Pixmap
Access: CSG
Class: XmCInitialFocus
Default: NULL
Type: Widget
Access: CSG
Class: XmCNavigationType
Default: XmTAB_GROUP
Type: XmNavigationType
Access: CSG
Class: XmCShadowThickness
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCStringDirection
Default: dynamic
Type: XmStringDirection
Access: CG
Class: XmCTopShadowColor
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCTopShadowPixmap
Default: dynamic
Type: Pixmap
Access: CSG
Class: XmCTraversalOn
Default: True
Type: Boolean
Access: CSG
Class: XmCUnitType
Default: dynamic
Type: unsigned char
Access: CSG
Class: XmCUserData
Default: NULL
Type: XtPointer
Access: CSG
Composite Resource Set
Class: XmCReadOnly
Default: NULL
Type: WidgetList
Access: G
Class: XmCInsertPosition
Default: NULL
Type: XtOrderProc
Access: CSG
Class: XmCReadOnly
Default: 0
Type: Cardinal
Access: G
Core Resource Set
Class: XmCAccelerators
Default: dynamic
Type: XtAccelerators
Access: CSG
Class: XmCSensitive
Default: dynamic
Type: Boolean
Access: G
Class: XmCBackground
Default: dynamic
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderColor
Default: XtDefaultForeground
Type: Pixel
Access: CSG
Class: XmCPixmap
Default: XmUNSPECIFIED_PIXMAP
Type: Pixmap
Access: CSG
Class: XmCBorderWidth
Default: 0
Type: Dimension
Access: CSG
Class: XmCColormap
Default: dynamic
Type: Colormap
Access: CG
Class: XmCDepth
Default: dynamic
Type: int
Access: CG
Class: XmCCallback
Default: NULL
Type: XtCallbackList
Access: C
Class: XmCHeight
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCInitialResourcesPersistent
Default: True
Type: Boolean
Access: C
Class: XmCMappedWhenManaged
Default: True
Type: Boolean
Access: CSG
Class: XmCScreen
Default: dynamic
Type: Screen *
Access: CG
Class: XmCSensitive
Default: True
Type: Boolean
Access: CSG
Class: XmCTranslations
Default: dynamic
Type: XtTranslations
Access: CSG
Class: XmCWidth
Default: dynamic
Type: Dimension
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Class: XmCPosition
Default: 0
Type: Position
Access: CSG
Translations
XmFrame inherits translations from XmManager.
SEE ALSOComposite(3X), Constraint(3X), Core(3X), XmCreateFrame(3X), XmMan‐
ager(3X)XmFrame(3X)
