XmScale(3X) OSF/Motif XmScale(3X)NAMEXmScale - The Scale widget class
SYNOPSIS
#include <Xm/Scale.h>
DESCRIPTION
Scale is used by an application to indicate a value from within a range
of values, and it allows the user to input or modify a value from the
same range.
A Scale has an elongated rectangular region similar to a ScrollBar. A
slider inside this region indicates the current value along the Scale.
The user can also modify the Scale's value by moving the slider within
the rectangular region of the Scale. A Scale can also include a label
set located outside the Scale region. These can indicate the relative
value at various positions along the scale.
A Scale can be either input/output or output only. An input/output
Scale's value can be set by the application and also modified by the
user with the slider. An output-only Scale is used strictly as an
indicator of the current value of something and cannot be modified
interactively by the user. The Core resource XmNsensitive specifies
whether the user can interactively modify the Scale's value.
The user can specify resources in a resource file for the automatically
created gadget that contains the title of the Scale widget. The name
of the gadget is "Title".
Classes
Scale inherits behavior and resources from Core, Composite, Constraint,
and XmManager classes.
The class pointer is xmScaleWidgetClass.
The class name is XmScale.
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).
XmScale Resource Set
──────────────────────────────────────────────────────────────
Name Default Access
Class Type
──────────────────────────────────────────────────────────────
──────────────────────────────────────────────────────────────
XmNdecimalPoints 0 CSG
XmCDecimalPoints short
──────────────────────────────────────────────────────────────
XmNdragCallback NULL C
XmCCallback XtCallbackList
──────────────────────────────────────────────────────────────
XmNfontList dynamic CSG
XmCFontList XmFontList
──────────────────────────────────────────────────────────────
XmNhighlightOnEnter False CSG
XmCHighlightOnEnter Boolean
──────────────────────────────────────────────────────────────
XmNhighlightThickness 2 CSG
XmCHighlightThickness Dimension
──────────────────────────────────────────────────────────────
XmNmaximum 100 CSG
XmCMaximum int
──────────────────────────────────────────────────────────────
XmNminimum 0 CSG
XmCMinimum int
──────────────────────────────────────────────────────────────
XmNorientation XmVERTICAL CSG
XmCOrientation unsigned char
──────────────────────────────────────────────────────────────
XmNprocessingDirection dynamic CSG
XmCProcessingDirection unsigned char
──────────────────────────────────────────────────────────────
XmNscaleHeight 0 CSG
XmCScaleHeight Dimension
──────────────────────────────────────────────────────────────
XmNscaleMultiple dynamic CSG
XmCScaleMultiple int
──────────────────────────────────────────────────────────────
XmNscaleWidth 0 CSG
XmCScaleWidth Dimension
──────────────────────────────────────────────────────────────
XmNshowValue False CSG
XmCShowValue Boolean
──────────────────────────────────────────────────────────────
XmNtitleString NULL CSG
XmCTitleString XmString
──────────────────────────────────────────────────────────────
XmNvalue dynamic CSG
XmCValue int
──────────────────────────────────────────────────────────────
XmNvalueChangedCallback NULL C
XmCCallback XtCallbackList
──────────────────────────────────────────────────────────────
Specifies the number of decimal points to shift the slider value when
displaying it. For example, a slider value of 2,350 and an Xmdecimal‐
Points value of 2 results in a display value of 23.50. The value must
not be negative. Specifies the list of callbacks that is called when
the slider position changes as the slider is being dragged. The reason
sent by the callback is XmCR_DRAG. Specifies the font list to use for
the title text string specified by XmNtitleString, and the label dis‐
played when XmNshowValue is True. If this value is NULL at initializa‐
tion, the font list is initialized by looking up the parent hierarchy
of the widget for an ancestor that is a subclass of the XmBullet‐
inBoard, VendorShell, or XmMenuShell widget class. If such an ancestor
is found, the font list is initialized to the XmNlabelFontList of the
ancestor widget. If no such ancestor is found, the default is imple‐
mentation dependent. Refer to XmFontList(3X) for more information on
the creation and structure of a font list. Specifies whether the high‐
lighting rectangle is drawn when the cursor moves into the widget. If
the shell's focus policy is XmEXPLICIT, this resource is ignored, and
the widget is highlighted when it has the focus. If the shell's focus
policy is XmPOINTER and if this resource is True, the highlighting rec‐
tangle is drawn when the the cursor moves into the widget. If the
shell's focus policy is XmPOINTER and if this resource is False, the
highlighting rectangle is not drawn when the the cursor moves into the
widget. The default is False. Specifies the size of the slider's bor‐
der drawing rectangle used for enter window and traversal highlight
drawing. Specifies the slider's maximum value. XmNmaximum must be
greater than XmNminimum. Specifies the slider's minimum value. XmN‐
maximum must be greater than XmNminimum. Displays Scale vertically or
horizontally. This resource can have values of XmVERTICAL and XmHORI‐
ZONTAL. Specifies whether the value for XmNmaximum is on the right or
left side of XmNminimum for horizontal Scales or above or below XmNmin‐
imum for vertical Scales. This resource can have values of
XmMAX_ON_TOP, XmMAX_ON_BOTTOM,XmMAX_ON_LEFT, and XmMAX_ON_RIGHT. If
the XmScale is oriented vertically, the default value is XmMAX_ON_TOP.
If the XmScale is oriented horizontally, the default value may depend
on the value of the XmNstringDirection resource. Specifies the height
of the slider area. The value should be in the specified unit type
(the default is pixels). If no value is specified a default height is
computed. Specifies the amount to move the slider when the user takes
an action that moves the slider by a multiple increment. The default
is (XmNmaximum - XmNminimum) divided by 10, with a minimum of 1. Spec‐
ifies the width of the slider area. The value should be in the speci‐
fied unit type (the default is pixels). If no value is specified a
default width is computed. Specifies whether a label for the current
slider value should be displayed next to the slider. If the value is
True, the current slider value is displayed. Specifies the title text
string to appear in the Scale widget window. Specifies the slider's
current position along the scale, between XmNminimum and XmNmaximum.
The value is constrained to be within these inclusive bounds. The ini‐
tial value of this resource is the larger of 0 and XmNminimum. Speci‐
fies the list of callbacks that is called when the value of the slider
has changed. The reason sent by the callback is XmCR_VALUE_CHANGED.
Inherited Resources
Scale 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
────────────────────────────────────────────────────────────────
Name Default Access
Class Type
────────────────────────────────────────────────────────────────
────────────────────────────────────────────────────────────────
XmNbottomShadowColor dynamic CSG
XmCBottomShadowColor Pixel
────────────────────────────────────────────────────────────────
XmNbottomShadowPixmap XmUNSPECIFIED_PIXMAP CSG
XmCBottomShadowPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNforeground dynamic CSG
XmCForeground Pixel
────────────────────────────────────────────────────────────────
XmNhelpCallback NULL C
XmCCallback XtCallbackList
────────────────────────────────────────────────────────────────
XmNhighlightColor dynamic CSG
XmCHighlightColor Pixel
────────────────────────────────────────────────────────────────
XmNhighlightPixmap dynamic CSG
XmCHighlightPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNinitialFocus NULL CSG
XmCInitialFocus Widget
────────────────────────────────────────────────────────────────
XmNnavigationType XmTAB_GROUP CSG
XmCNavigationType XmNavigationType
────────────────────────────────────────────────────────────────
XmNshadowThickness 2 CSG
XmCShadowThickness Dimension
────────────────────────────────────────────────────────────────
XmNstringDirection dynamic CG
XmCStringDirection XmStringDirection
────────────────────────────────────────────────────────────────
XmNtopShadowColor dynamic CSG
XmCTopShadowColor Pixel
────────────────────────────────────────────────────────────────
XmNtopShadowPixmap dynamic CSG
XmCTopShadowPixmap Pixmap
────────────────────────────────────────────────────────────────
XmNtraversalOn True CSG
XmCTraversalOn Boolean
────────────────────────────────────────────────────────────────
XmNunitType dynamic CSG
XmCUnitType unsigned char
────────────────────────────────────────────────────────────────
XmNuserData NULL CSG
XmCUserData XtPointer
────────────────────────────────────────────────────────────────
Composite Resource Set
──────────────────────────────────────────────────────
Name Default Access
Class Type
──────────────────────────────────────────────────────
──────────────────────────────────────────────────────
XmNchildren NULL G
XmCReadOnly WidgetList
──────────────────────────────────────────────────────
XmNinsertPosition NULL CSG
XmCInsertPosition XtOrderProc
──────────────────────────────────────────────────────
XmNnumChildren 0 G
XmCReadOnly Cardinal
──────────────────────────────────────────────────────
Core Resource Set
─────────────────────────────────────────────────────────────────────
Name Default Access
Class Type
─────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────
XmNaccelerators dynamic CSG
XmCAccelerators XtAccelerators
─────────────────────────────────────────────────────────────────────
XmNancestorSensitive dynamic G
XmCSensitive Boolean
─────────────────────────────────────────────────────────────────────
XmNbackground dynamic CSG
XmCBackground Pixel
─────────────────────────────────────────────────────────────────────
XmNbackgroundPixmap XmUNSPECIFIED_PIXMAP CSG
XmCPixmap Pixmap
─────────────────────────────────────────────────────────────────────
XmNborderColor XtDefaultForeground CSG
XmCBorderColor Pixel
─────────────────────────────────────────────────────────────────────
XmNborderPixmap XmUNSPECIFIED_PIXMAP CSG
XmCPixmap Pixmap
─────────────────────────────────────────────────────────────────────
XmNborderWidth 0 CSG
XmCBorderWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNcolormap dynamic CG
XmCColormap Colormap
─────────────────────────────────────────────────────────────────────
XmNdepth dynamic CG
XmCDepth int
─────────────────────────────────────────────────────────────────────
XmNdestroyCallback NULL C
XmCCallback XtCallbackList
─────────────────────────────────────────────────────────────────────
XmNheight dynamic CSG
XmCHeight Dimension
─────────────────────────────────────────────────────────────────────
XmNinitialResourcesPersistent True C
XmCInitialResourcesPersistent Boolean
─────────────────────────────────────────────────────────────────────
XmNmappedWhenManaged True CSG
XmCMappedWhenManaged Boolean
─────────────────────────────────────────────────────────────────────
XmNscreen dynamic CG
XmCScreen Screen *
─────────────────────────────────────────────────────────────────────
XmNsensitive True CSG
XmCSensitive Boolean
─────────────────────────────────────────────────────────────────────
XmNtranslations dynamic CSG
XmCTranslations XtTranslations
─────────────────────────────────────────────────────────────────────
XmNwidth dynamic CSG
XmCWidth Dimension
─────────────────────────────────────────────────────────────────────
XmNx 0 CSG
XmCPosition Position
─────────────────────────────────────────────────────────────────────
XmNy 0 CSG
XmCPosition Position
─────────────────────────────────────────────────────────────────────
Callback Information
A pointer to the following structure is passed to each callback: type‐
def struct { int reason; XEvent * event; int value; }
XmScaleCallbackStruct; Indicates why the callback was invoked Points to
the XEvent that triggered the callback Is the new slider value
Behavior
XmScale behavior is described below: (in region between an end of the
Scale and the slider): Moves the slider by one multiple increment in
the direction of the end of the Scale and calls the XmNvalueChanged‐
Callback callbacks. If XmNprocessingDirection is XmMAX_ON_RIGHT or
XmMAX_ON_BOTTOM, movement toward the right or bottom increments the
Scale value, and movement toward the left or top decrements the Scale
value. If XmNprocessingDirection is XmMAX_ON_LEFT or XmMAX_ON_TOP,
movement toward the right or bottom decrements the Scale value, and
movement toward the left or top increments the Scale value. If the
button is held down longer than a delay period, the slider is moved
again by the same increment and the same callbacks are called.
In the slider region: Activates the interactive dragging of the
slider. If the button press occurs within the slider, the subsequent
motion events move the slider to the position of the pointer and call
the callbacks for XmNdragCallback. If the button press occurs within
the slider and the slider position is changed, the callbacks for XmN‐
valueChangedCallback are called. In the region between an end of the
Scale and the slider: Moves the slider to that end of the Scale and
calls the XmNvalueChangedCallback callbacks. If XmNprocessingDirection
is XmMAX_ON_RIGHT or XmMAX_ON_BOTTOM, movement toward the right or bot‐
tom increments the Scale value, and movement toward the left or top
decrements the Scale value. If XmNprocessingDirection is XmMAX_ON_LEFT
or XmMAX_ON_TOP, movement toward the right or bottom decrements the
Scale value, and movement toward the left or top increments the Scale
value. For vertical Scales, moves the slider up one increment and
calls the XmNvalueChangedCallback callbacks. If XmNprocessingDirection
is XmMAX_ON_TOP, movement toward the top increments the Scale value.
If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward the top
decrements the Scale value. For vertical Scales, moves the slider down
one increment and calls the XmNvalueChangedCallback callbacks. If XmN‐
processingDirection is XmMAX_ON_BOTTOM, movement toward the bottom
increments the Scale value. If XmNprocessingDirection is XmMAX_ON_TOP,
movement toward the bottom decrements the Scale value. For horizontal
Scales, moves the slider one increment to the left and calls the XmN‐
valueChangedCallback callbacks. If XmNprocessingDirection is
XmMAX_ON_LEFT, movement toward the left increments the Scale value. If
XmNprocessingDirection is XmMAX_ON_RIGHT, movement toward the left
decrements the Scale value. For horizontal Scales, moves the slider
one increment to the right and calls the XmNvalueChangedCallback call‐
backs. If XmNprocessingDirection is XmMAX_ON_RIGHT, movement toward
the right increments the Scale value. If XmNprocessingDirection is
XmMAX_ON_LEFT, movement toward the right decrements the Scale value.
For vertical Scales, moves the slider up one multiple increment and
calls the XmNvalueChangedCallback callbacks. If XmNprocessingDirection
is XmMAX_ON_TOP, movement toward the top increments the Scale value.
If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward the top
decrements the Scale value. For vertical Scales, moves the slider down
one multiple increment and calls the XmNvalueChangedCallback callbacks.
If XmNprocessingDirection is XmMAX_ON_BOTTOM, movement toward the bot‐
tom increments the Scale value. If XmNprocessingDirection is
XmMAX_ON_TOP, movement toward the bottom decrements the Scale value.
For horizontal Scales, moves the slider one multiple increment to the
left and calls the XmNvalueChangedCallback callbacks. If XmNprocess‐
ingDirection is XmMAX_ON_LEFT, movement toward the left increments the
Scale value. If XmNprocessingDirection is XmMAX_ON_RIGHT, movement
toward the left decrements the Scale value. For horizontal Scales,
moves the slider one multiple increment to the right and calls the XmN‐
valueChangedCallback callbacks. If XmNprocessingDirection is
XmMAX_ON_RIGHT, movement toward the right increments the Scale value.
If XmNprocessingDirection is XmMAX_ON_LEFT, movement toward the right
decrements the Scale value. Moves the slider to the minimum value and
calls the XmNvalueChangedCallback callbacks. Moves the slider to the
maximum value and calls the XmNvalueChangedCallback callbacks. Tra‐
verses to the first item in the next tab group. If the current tab
group is the last entry in the tab group list, it wraps to the begin‐
ning of the tab group list. Traverses to the first item in the previ‐
ous tab group. If the beginning of the tab group list is reached, it
wraps to the end of the tab group list. Calls the callbacks for XmN‐
helpCallback if any exist. If there are no help callbacks for this
widget, this action calls the help callbacks for the nearest ancestor
that has them.
Virtual Bindings
The bindings for virtual keys are vendor specific. For information
about bindings for virtual buttons and keys, see VirtualBindings(3X).
RELATED INFORMATIONComposite(3X), Constraint(3X), Core(3X), XmCreateScale(3X), XmMan‐
ager(3X), XmScaleGetValue(3X), and XmScaleSetValue(3X).
XmScale(3X)
