ZtScrollBar.H

// ZtScrollBar.H    $Revision: 1.5 $    $Date: 2005/04/29 10:11:53 $ 

#if !defined __ZtScrollBar_H

#define __ZtScrollBar_H

#include <zm/ZTypes.h>
#include <zm/ZtObject.H>


/* Scrollbar coord is defined in 0..SB_COORD_SET */
#define SB_COORD_SET    32000

/* Default increment fraction: 0..1 */
#define SB_INCREMENT    0.05


/*************************************************************
 * Base class for all scrollbar realization.  Establish
 * interface and tools for any specific object.  Scrollbar
 * has own coordinates that is mapped to bounds of its natural
 * group. By default page increment is equal to current slider
 * size and increment is equal to 1/20 of slider size.
 *************************************************************/
class ZtScrollBar : public ZtObject
{
public:

  /* Dimension: zdHorizontal, zdVertical scrollbar */
  ZtScrollBar (ZtMain* pManager, ZDimension dimension, ZGroupId nid);
  ZtScrollBar (ZtMain* pManager, ZDimension dimension, ZGroupId nid,
           Widget sb_widget);
#ifndef NO_XTOOLKIT
  /* Define own XmScrollBar */
  ZtScrollBar (ZtMain* pManager, ZGroupId pxid, ZGroupId pyid,
           ZDimension dimension, ZGroupId nid);
#endif /* NO_XTOOLKIT */

  virtual ~ZtScrollBar ();

  /* Call this function in callback of any event for scrollbar */
  virtual void  sb_callback (Widget w = NULL);

  /* Standard scrollbar callback (with this passed via pThis) */
  static void   sb_callback (Widget w, XtPointer pThis, XtPointer pCallData);

  /* Register for scrollbar local callback. */
  void      use_sb_callback ();

  /* Synchronize given scrollbar widget position and size with it's
     natural group parameters or synchronize with default scrollbar */
  virtual void  sb_synchronize (Widget w = NULL);

  /* Set increment for slider as fraction of slider size */
  void      sb_increment (float v_inc);

  /* Force synchronization instead of redraw */
  virtual void  expose ();

  /* Return reference at the only natural coord group of scrollbar */
  ZNCoordSlave& nslave () const;

  virtual const char*   class_id () const;

private:

  Widget    wsb;        /* widget of Motif's scrollbar */
  Widget    own_wsb;    /* own widget of Motif's scrollbar -
                 * create and destroy with the object */

protected:

  float     inc_frac;   /* increment as fraction of slider size */

  ZDimension    dim;    /* zdHorizontal or zdVertical */

  /* Convert natural coord into scrollbar coord meaning the whole
   * range coord is associated with bounds of natural group:
   * 0..|b[1]-b[0]| ==> 0..SB_COORD_SET */
  int   nc2sb (float nc_value);

  /* Convert scrollbar value into natural one
   * 0..|b[1]-b[0]| <== 0..SB_COORD_SET */
  float sb2nc (int sb_value);

  /* Set location of scrollbar widget (own_wsb) the same as of *this
   * zobject */
  void  set_own_location ();

};

#endif  // ZtScrollBar.H