XmFrame(3Xm) XmFrame(3Xm)
NAME
XmFrame - the Frame widget class.
AES SUPPORT LEVEL
full-use
SYNOPSIS
#include <Xm/Frame.h>
DESCRIPTION
Frame is a very simple manager used to enclose a single
child in a border drawn by Frame. It uses the Manager
class resources for border drawing and performs
geometry management such that its size will always
match its child's size plus the margins defined for it.
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 will give visual consistency when developing
applications using diverse widget sets.
If the Frame's parent is a Shell widget, then
XmNshadowType is set to XmSHADOW_OUT and Manager's
resource XmNshadowThickness is set to one by default.
Classes
Frame inherits behavior and resources from the Core,
Composite, Constraint, 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 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
lower case or upper case, but include any underscores
between words). The codes in the access column
- 1 -
XmFrame(3Xm) XmFrame(3Xm)
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
Name Class Type Default Access
_______________________________________________________________________________
XmNmarginWidth XmCMarginWidth short 0 CSG
XmNmarginHeight XmCMarginHeight short 0 CSG
XmNshadowType XmCShadowType unsigned char XmSHADOW_ETCHED_IN CSG
XmNmarginWidth
Specifies the padding space on the left and right
sides between the child of Frame and Frame's
shadow drawing.
XmNmarginHeight
Specifies the padding space on the top and bottom
sides between the child of Frame and Frame's
shadow drawing.
XmNshadowType
Describes the drawing style for Frame. This
resource can have the following values:
⊕ XmSHADOW_IN - draws Frame such that it appears
inset. This means that the bottom shadow visuals and
top shadow visuals are reversed.
⊕ XmSHADOW_OUT - draws Frame such that it appears
outset.
⊕ 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 if
Frame's parent is 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. This is the
default except when Frame's parent is a Shell
widget.
Inherited Resources
Frame inherits behavior and resources from the
following superclasses. For a complete description of
these resources, refer to the man page for that
superclass.
- 2 -
XmFrame(3Xm) XmFrame(3Xm)
XmManager Resource Set
Name Class Type Default Access
______________________________________________________________________________________________
XmNbottomShadowColor XmCForeground Pixel dynamic CSG
XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNforeground XmCForeground Pixel dynamic CSG
XmNhelpCallback XmCCallback XtCallbackList NULL C
XmNhighlightColor XmCForeground Pixel Black CSG
XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG
XmNshadowThickness XmCShadowThickness short dynamic CSG
XmNtopShadowColor XmCBackground Pixel dynamic CSG
XmNtopShadowPixmap XmCTopShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNuserData XmCUserData caddr_t NULL CSG
Composite Resource Set
Name Class Type Default Access
______________________________________________________________________
XmNinsertPosition XmCInsertPosition XmRFunction NULL CSG
Core Resource Set
Name Class Type Default Access
____________________________________________________________________________________________
XmNaccelerators XmCAccelerators XtTranslations NULL CSG
XmNancestorSensitive XmCSensitive Boolean True G
XmNbackground XmCBackground Pixel dynamic CSG
XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderColor XmCBorderColor Pixel Black CSG
XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG
XmNborderWidth XmCBorderWidth Dimension 0 CSG
XmNcolormap XmCColormap Colormap XtCopyFromParent CG
XmNdepth XmCDepth int XtCopyFromParent CG
XmNdestroyCallback XmCCallback XtCallbackList NULL C
XmNheight XmCHeight Dimension 0 CSG
XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG
XmNscreen XmCScreen Pointer XtCopyScreen CG
XmNsensitive XmCSensitive Boolean True CSG
XmNtranslations XmCTranslations XtTranslations NULL CSG
XmNwidth XmCWidth Dimension 0 CSG
XmNx XmCPosition Position 0 CSG
XmNy XmCPosition Position 0 CSG
Default Translations
<EnterWindow>: Enter()
<FocusIn>: FocusIn()
<Btn1Down>: Arm()
<Btn1Up>: Activate()
RELATED INFORMATION
Composite(3X), Constraint(3X), Core(3X),
- 3 -
XmFrame(3Xm) XmFrame(3Xm)
XmCreateFrame(3X), and XmManager(3X).
- 4 -