SoXtSlider.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_XT_SLIDER_
#define  _SO_XT_SLIDER_
 
#ifdef SOQT
#  include <Inventor/Qt/SoQtSlider.h>
#elif defined(_WIN32)
#  include <Inventor/Win/SoWinSlider.h>
#else
 
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Xt/SoXtGLWidget.h>
 
 
class SoFloatCallbackList;
class SoXtMouse;
 
// callback function prototypes
typedef void SoXtSliderCB(void *userData, float val);
 
//
//  Class: SoXtSlider
//
//      This is the basic slider type, which lets you set the slider value and
//  register callbacks when the slider is being moved (either as soon as the
//  slider changes values, or when the slider has stopped moving (mouse up)).
//
 
{
 public:
 
  // constructor/destructor
  SoXtSlider(
             SoWidget parent = NULL,
             const char *name = NULL,
             SbBool buildInsideParent = TRUE);
  ~SoXtSlider();
 
  //
  // Those routines are used to specify the slider value (which is automatically
  // reflected in the slider) and get the current value.
  //
  // NOTE: setValue() will call valueChanged callbacks if the value differs.
  //
  // NOTE: currently only values [0.0 , 1.0] are supported
  //
  void        setValue(float v);
  float       getValue() const                { return value; }
 
  //
  // Specifies the label string which appears before the slider. A NULL
  // string will remove the label altogether. (default behavior)
  //
  // @UNICODE_WARNING
  //
  SoNONUNICODE void        setLabel(const char *newlabel);
 
 
  //
  // Specifies the label string which appears before the slider. A NULL
  // string will remove the label altogether. (default behavior)
  //
  void        setLabel(const SbString& newlabel);
 
  
  SbString getLabel() const {return labelStr;}
 
  //
  // Display a numeric value in a text field to the right of the slider
  // which can be edited to change the value of the slider.
  // Default is TRUE (display the numeric value).
  //
  void        setNumericFieldVisible(SbBool b);
  SbBool      isNumericFieldVisible() const   { return numberVisible; }
 
  //
  // Those routines are used to register callbacks for the different slider
  // actions.
  //
  // NOTE: the start and finish callbacks are only to signal when the mouse
  // goes down and up. No valid callback data is passed (0.0 passed).
  //
  void        addStartCallback(
                               SoXtSliderCB *f,
                               void *userData = NULL);
  void        addValueChangedCallback(
                                      SoXtSliderCB *f,
                                      void *userData = NULL);
  void        addFinishCallback(
                                SoXtSliderCB *f,
                                void *userData = NULL);
 
  void        removeStartCallback(
                                  SoXtSliderCB *f,
                                  void *userData = NULL);
  void        removeValueChangedCallback(
                                         SoXtSliderCB *f,
                                         void *userData = NULL);
  void        removeFinishCallback(
                                   SoXtSliderCB *f,
                                   void *userData = NULL);
 
  // true while the value is changing interactively
  void interactivity( SbBool flag ) { interactive = flag; }
  SbBool  isInteractive()                     { return interactive; }
 
  // sets/gets the size of the actual slider, excluding the label and
  // text field widget sizes which are fixed in size.
  //
  // This is the prefered behavior since it allows a user to align
  // multiple sliders (same size) regardless of the text label size
  // (which are usually different).
  //
  // NOTE: this is different from most widgets, which do resize their
  // container widgets. This functionality can still be achieved using
  // the setSize() and getSize() methods.
  //
  void            setSliderSize(const SbVec2s &size);
  SbVec2s         getSliderSize();
 
 private:
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtSlider::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoXtSlider(
               SoWidget parent,
               const char *name,
               SbBool buildInsideParent,
               SbBool buildNow);
 
  // redefine these to do slider specific things
  virtual void    redraw();
  virtual void    processEvent(XAnyEvent *anyevent);
  virtual void    sizeChanged(const SbVec2s &newSize);
 
  SoWidget          buildWidget(SoWidget parent);
 
  //
  // this is the routine subclasses would redefine to change the look of
  // the actual slider top region, which defaults to grey with a thin white marker.
  //
  virtual void    drawSliderTopRegion();
 
  // slider top region area (used by subclasses to do their own
  // drawings in there).
  short       slx1, sly1, slx2, sly2;
  short       thumx1, thumy1, thumx2, thumy2;
 
 private:
 
  SoWidget          mgrWidget, numberWidget, sliderWidget, labelWidget;
  SbBool          numberVisible;      // whether numeric field is visible
  SbString        labelStr;          // label preceeding slider
  SbVec2s         sliderSize;         // size of the 'widget' and 'shell'
  SoXtMouse       *mouse;
 
  // slider local variables (slider value, thum position)
  float           value;
  short           position, posdiff;
 
  // build routines
  void            doLabelLayout();
  void            doNumberLayout();
 
  // callback variables
  SoFloatCallbackList  *startCallbacks;
  SoFloatCallbackList  *changedCallbacks;
  SoFloatCallbackList  *finishCallbacks;
  SbBool          interactive;
 
  // text field vars and callbacks
  static void     textFieldCB(SoWidget, SoXtSlider *, XtPointer);
 
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
 
};
 
#endif
 
#endif  /* _SO_XT_SLIDER_ */