LessTif

LessTif Manual Page - Widget Classes

XmScrollBar


[Resources] [Callbacks] [Inherited Resources] [Actions] [Translations] [Public Functions] [Usage] [Example] [See Also]

Synopsis

Widget Class xmScrollBarWidgetClass
Public Header <Xm/ScrollBar.h>
Private Header <Xm/ScrollBarP.h>
Class Hierarchy Core:: XmPrimitive:: XmScrollBar

Description

The scrollbar widget provides a means of users scrolling through large amounts of data that would be too big to display on the Screen. This is usually combined with other widgets to produce ScrolledWindow or ScrolledList widget.

Resources

Name Class Type Default Access
XmNdecrementCallback XmCCallback XtCallbackListNULL CSG
XmNdragCallback XmCCallback XtCallbackListNULL CSG
XmNincrement XmCIncrement int1 CSG
XmNincrementCallback XmCCallback XtCallbackListNULL CSG
XmNinitialDelay XmCInitialDelay int250 CSG
XmNmaximum XmCMaximum int_XmScrollBarMaximumDefault CSG
XmNminimum XmCMinimum int0 CSG
XmNorientation XmCOrientation unsigned charXmVERTICAL CSG
XmNpageDecrementCallback XmCCallback XtCallbackListNULL CSG
XmNpageIncrement XmCPageIncrement int10 CSG
XmNpageIncrementCallback XmCCallback XtCallbackListNULL CSG
XmNprocessingDirection XmCProcessingDirection XmRProcessingDirection_XmScrollBarProcessingDirectionDefault CSG
XmNrepeatDelay XmCRepeatDelay int50 CSG
XmNshowArrows XmCShowArrows BooleanTrue CSG
XmNsliderSize XmCSliderSize int_XmScrollBarSliderSizeDefault CSG
XmNtoBottomCallback XmCCallback XtCallbackListNULL CSG
XmNtoTopCallback XmCCallback XtCallbackListNULL CSG
XmNtroughColor XmCTroughColor Pixel_XmScrollBarTroughColorDefault CSG
XmNvalue XmCValue int_XmScrollBarValueDefault CSG
XmNvalueChangedCallback XmCCallback XtCallbackListNULL CSG

XmNincrement
under construction

XmNinitialDelay
under construction

XmNmaximum
Specifies the maximum slider value.

XmNminimum
Specifies the minimum slider value.

XmNorientation
Specifies the orientation of the widget. Possible values are:

XmNpageIncrement
under construction

XmNprocessingDirection
Specifies the min-to-max direction of the slider. Valid values are dependent on the value of XmNorientation.

If XmNorientation is XmVERTICAL, the default value is XmMAX_ON_TOP, and the valid values are:

If XmNorientation is XmHORIZONTAL, the default value is XmMAX_ON_RIGHT, and the valid values are:

XmNrepeatDelay
under construction

XmNshowArrows
Specifies whether or not arrows are displayed. True = arrows are displayed, False = arrows are hidden.

XmNsliderSize
Specifies the length of the slider, measured in the same units as XmNmaximum and XmNminimum. Valid values range from 1 to (XmNmaximum - XmNminimum). If XmNsliderSize is set to a value outside this range, a warning is written to stderr. The default value is (XmNmaximum - XmNminimum) / 10.

XmNtroughColor
Specifies the pixel value of the trough. The default value depends on XmNbackground.

XmNvalue
Specifies the value of the slider. Valid values range from XmNminimum to (XmNmaximum - XmNsliderSize). If a value specified is outside this range, a warning is written to stderr.


Callbacks

Callback Resources

The Scrollbar widget defines the following callback resources:

Name Reason
XmNdecrementCallback XmCR_DECREMENT
XmNdragCallback XmCR_DRAG
XmNincrementCallback XmCR_INCREMENT
XmNpageDecrementCallback XmCR_PAGE_DECREMENT
XmNpageIncrementCallback XmCR_PAGE_INCREMENT
XmNtoBottomCallback XmCR_TO_BOTTOM
XmNtoTopCallback XmCR_TO_TOP
XmNvalueChangedCallback XmCR_VALUE_CHANGED

Callback Structure

typedef struct
{
int     reason;
XEvent  *event;
int     value;
int     pixel;
} XmScrollBarCallbackStruct;


Inherited Resources

XmScrollBar inherits resources from the following widget classes:

Actions

Select()

Release()

Moved()

TopOrBottom()

CancelDrag()

PageDownOrRight()

PageUpOrLeft()

IncrementDownOrRight()

IncrementUpOrLeft()


Translations

Under Construction
Sequence Actions
BSelect Press Select()
BSelect Release Release()
BSelect Press Moved Moved()
BTransfer Press Select()
BTransfer Release Release()
BTransfer Press Moved Moved()
MCtrl BSelect Press TopOrBottom()
MCtrl BSelect Release Release()
KUp IncrementUpOrLeft(0)
MCtrl KUp PageUpOrLeft(0)
KDown IncrementDownOrRight(0)
MCtrl KDown PageDownOrRight(0)
KLeft IncrementUpOrLeft(1)
MCtrl KLeft PageUpOrLeft(1)
KRight IncrementDownOrRight(1)
MCtrl KRight PageDownOrRight(1)
KPageUp PageUpOrLeft(0)
KPageDown PageDownOrRight(0)
KPageLeft PageUpOrLeft(1)
KPageRight PageDownOrRight(1)
KBeginLine TopOrBottom()
KEndLine TopOrBottom()
KBeginData TopOrBottom()
KEndData TopOrBottom()
KNextField PrimitiveNextTabGroup()
KPrevField PrimitivePrevTabGroup()
KActivate PrimitiveParentActivate()
KCancel CancelDrag()
KHelp PrimitiveHelp()

Usage

Under Construction

Public Functions

Under Construction
Widget XmCreateScrollBar(Widget Parent,char *Name,Arg *arglist,Cardinal count)

XmIsScrollBar(Widget w)

void XmScrollBarGetValues(Widget w, int *value_ret, int *slider_size_ret, int *increment_ret, int *page_increment_ret)

void XmScrollBarSetValues(Widget w, int value, int slider_size, int increment, int page_increment)


See Also

Core, XmPrimitive,
Go Back to Index
Go Back to Main Index
Last Update:Fri 8 Dec 08:36:13 1995