VkScroll(3x)

NAME
     VkScroll - Automatic scrolled window using the annotated scrollbar

INHERITS FROM
     VkComponent : VkCallbackObject :

HEADER FILE
     #include <Vk/VkScroll.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkScroll(const char* name, Widget parent);
           virtual void ~VkScroll(void);


   Configuration
           void setChild(Widget child);
           void recomputeScrollBar(void);
           void setAnnotations(void);


   Display Functions
           int getScrollPos(void);
           void setScrollPos(int pos);
           void reannotateScrollBar(void);


   Access Functions
           Widget getClip(void);
           Widget getFrame(void);
           Widget getScrollBar(void);




CLASS DESCRIPTION
     The VkScroll component provides something very similar to a Motif
     XmScrolledWindow with XmNscrollingPolicy set to XmAUTOMATIC.  The
     difference is that the VkScroll object is a component rather than a
     widget, and that it supports the annotated scrollbar widget.



FUNCTION DESCRIPTIONS
   VkScroll()
           VkScroll(const char* name, Widget parent);
           virtual void ~VkScroll(void);


          The VkScroll constructor creates a component that simulates an
          automatically-scrolled Motif scrolled window, but uses an annotated
          scrollbar.  Note that you need to call the setAnnotations() method
          to turn on annotations in the scrollbar.  The first argument is the
          name of the base widget, the second is the parent of the widget.

   setChild()
           void setChild(Widget child);


          Tells VkScroll what the child of its clip widget is, so that it can
          track geometry changes and update the scrollbar.

   getScrollPos()
           int getScrollPos(void);


          Returns the current scrollbar position.  This value is the number of
          pixels relative to the child size.

   setScrollPos()
           void setScrollPos(int pos);


          Changes the current scrollbar position.  This values should be the
          number of pixels relative to the child size.

   getClip()
           Widget getClip(void);


          Returns the clip widget of the VkScroll component.  This should be
          the parent of the child widget.

   getFrame()
           Widget getFrame(void);


          Returns the frame widget of the VkScroll component.  This is the
          visible area of the component.

   getScrollBar()
           Widget getScrollBar(void);


          Returns the annotated scrollbar widget.

   recomputeScrollBar()
           void recomputeScrollBar(void);


          Tells the VkScroll object that the component's geometry has changed,
          and to force a recalculation of the scrollbar scale.

   reannotateScrollBar()
           void reannotateScrollBar(void);


          Forces a redraw of the annotated scrollbar pixmap.

   setAnnotations()
           void setAnnotations(void);


          Turns on annotations in the annotated scrollbar.

   scrollCallback
          static const const char* scrollCallback;


          A callback function for detecting initial exposure of the scrolled
          window, resize of the scrolled window, or a need to reannotate the
          trough pixmap.  The callData argument should be cast to a
          (VkScrollCallback *).

INHERITED MEMBER FUNCTIONS
   Inherited from VkComponent
          installDestroyHandler(),  removeDestroyHandler(),
          widgetDestroyed(),  afterRealizeHook(), setDefaultResources(),
          getResources(),  VkComponent(),  VkComponent(),  ~VkComponent(),
          show(),  hide(),  realize(),  manage(),  unmanage(), name(),
          baseWidget(),  okToQuit(),  isComponent(),  *(), _name,
          _baseWidget,  _w,  deleteCallback,


   Inherited from VkCallbackObject
          callCallbacks(),  VkCallbackObject(),  ~VkCallbackObject(),
          addCallback(),  addCallback(), removeCallback(),  removeCallback(),
          removeAllCallbacks(),  removeAllCallbacks(),


SEE ALSO
     VkComponent, VkCallbackObject, VkScroll
     ViewKit Programmer's Guide
     The X Window System, DEC Press, Bob Sheifler and Jim Gettys
     The X Window System Toolkit, DEC Press, Paul Asente and Ralph Swick
     The OSF/Motif Programmers Reference, Prentice Hall, OSF