XmQTscrollFrame(3X)
XmQTscrollFrame - A widget holding this trait can handle one or more navigator widgets
As shipped in IRIX 6.5.30. Added in IRIX 6.5.5.
NAME XmQTscrollFrame - A widget holding this trait can handle one or more navigator widgets SYNOPSIS #include <Xm/ScrollFrameT.h> typdefe struct { int version; XmScrollFrameInitProc init; XmScrollFrameGetInfoProc getInfo; XmScrollFrameAddNavigatorProc addNavigator; XmScrollFrameRemoveNavigatorProc removeNavigator; } XmSrollFrameTraitRec, *XmScrollFrameTrait; void (*XmScrollFrameInitProc)( Widget, XtCallbackProc, Widget, Boolean (*XmScrollFrameGetInfoProc)( Widget, Cardinal*, Widget**, Cardinal*, void (*XmScrollFrameAddNavigatorProc)( Widget, Widget, Mask, void (*XmScrollFrameRemoveNavigatorProc)( Widget, Widget); VERSION This page documents Motif 2.1. DESCRIPTION A widget holding the XmQTscrollFrame trait can handle one or more navigator widgets and use them to pan a scrollable object. The trait methods of XmQTscrollFrame are useful if you are writing you own navigator or scrollable widget. The following standard Motif manager widgets hold this trait: o XmScrolledWindow o XmNotebook In addition, the following standard Motif widgets access the trait methods of XmQTscrollFrame: o XmList o XmText The init Trait Method void init( Widget scrollFrameWidget, XtCallbackProc moveCB, Widget scrollableWidget); The init trait method initializes several internal data fields. One of these fields must hold the name the default move callback (moveCB) procedure that is to be associated with this widget. scrollFrameWidget Specifies the widget that holds the XmQTscrollFrame trait. moveCB Specifies the default move callback procedure that is to be associated with this widget. Typically, this callback is going to be added to a list of navigator widgets maintained by the scrollFrameWidget. scrollableWidget Specifies client data to be passed to the moveCB. Typically, the client data will be the name of a scrollable widget. The getInfo Trait Method Boolean getInfo( Widget scrollFrameWidget, Cardinal *dimension, Widget **nav_list, Cardinal *num_nav_list); The getInfo trait method returns information about the scrollFrameWidget. The caller may set the dimension, nav_list, or num_nav_list fields to NULL if the returned information would be of no interest. scrollFrameWidget Specifies the widget that is providing this method. dimension Returns the dimension(s) that scrollFrameWidgetis capable of operating upon. nav_list Returns the current list of navigators associated with this scrollFrameWidget. This data is returned to internal storage, and should not be modified or freed by the caller. num_nav_list Returns the number of navigators returned in nav_list. This method returns True if the init trait method was already called. This method returns False if inithas not yet been called. If this method returns False, then the returned information in the other fields should be ignored. The addNavigator Trait Method void addNavigator( Widget scrollFrameWidget, Widget navigatorWidget, Mask dimMask); The addNavigator trait method associates a navigatorWidgetwith a scrollFrameWidget. Since one scrollFrameWidget can support multiple navigator widgets, it is possible that this method will be called multiple times. scrollFrameWidget Specifies the scroll frame widget that is providing this method. navigatorWidget Specifies the navigator widget to be associated with the scrollFrameWidget. dimMask Specifies the dimension(s) upon which the navigatorWidgetis going to operate. The removeNavigator Trait Method void removeNavigator( Widget scrollFrameWidget, Widget navigatorWidget); The removeNavigator trait method disassociates a navigatorWidgetfrom a scrollFrameWidget. Since one scrollFrameWidget can support multiple navigatorWidgets, this method can be called multiple times. It is the responsibility of whomever associated the navigatorWidgetwith the scrollFrameWidget to call removeNavigator prior to destroying it. scrollFrameWidget Specifies the scroll frame widget that is providing this method. navigatorWidget Specifies the navigator widget to be disassociated from the scrollFrameWidget. RELATED XmScrolledWindow(3), XmNotebook(3), and XmQTnavigator(3).