uscrollbar.hpp

/* ==================================================== ======== ======= *
*
*  uscrollbar.cpp
*  Ubit Project
*  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
*  (C) 1999-2006 Eric Lecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
*
* ***********************************************************************
* COPYRIGHT NOTICE :
* THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE
* IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
* YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU
* GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION;
* EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
* SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
* ***********************************************************************
* ==================================================== [(c)Elc] ======= *
* ==================================================== ======== ======= */

#ifndef _uscrollbar_hpp_
#define _uscrollbar_hpp_
//pragma ident "@(#)uscrollbar.hpp              ubit:05.05.00"
#include <ubit/ubox.hpp>
#include <ubit/uboxLayout.hpp>
#include <ubit/uboxGeom.hpp>
#include <ubit/ucolor.hpp>
#include <ubit/ustyle.hpp>
#include <ubit/uview.hpp>
namespace ubit {

/* ==================================================== ===== ======= */
class UScrollbar: public UBox {
public:
  UBIT_ELEMENT_CLASS(UScrollbar, UBox)

  UScrollbar(const UArgs& = UArgs::none);
  UScrollbar(UFloat& value, const UArgs& = UArgs::none);
  friend UScrollbar& uscrollbar(const UArgs& a = UArgs::none);

  friend UScrollbar& uscrollbar(UFloat& value, const UArgs& a = UArgs::none);
  
  friend UScrollbar& uhscrollbar(const UArgs& a = UArgs::none);

  friend UScrollbar& uvscrollbar(const UArgs& a = UArgs::none);

  virtual ~UScrollbar();
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  bool isVertical() const;
  bool isHorizontal() const;

  UFloat& value() {return *pvalue;}
  virtual float getValue() const;

  virtual void setValue(float percent);
  virtual int getUnitIncrement() const;
  virtual int getBlockIncrement() const;

  virtual void setUnitIncrement(int);
  virtual void setBlockIncrement(int);

  virtual void setTracking(bool);
  virtual bool isTracking() const;

  virtual void setTransparent(bool state);
  virtual bool isTransparent() const;
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // implementation

  static  UStyle* createStyle();

  virtual UBox* getKnob()         {return pknob;}
  virtual UBox* getRail()         {return prail;}
  virtual UBox* getLessScroller() {return pless_btn;}
  virtual UBox* getMoreScroller() {return pmore_btn;}

  virtual UBox* createKnob(bool vertical);
  virtual UBox* createRail(bool vertical);
  virtual UBox* createLessScroller(bool vertical);
  virtual UBox* createMoreScroller(bool vertical);
  /* fonctions that create the knob, the rail and the 2 scrollers.
   * can be redefined by subclasses to use other widgets
   */

  virtual void setPane(UScrollpane*);
  UScrollpane* getPane() {return ppane;}

  virtual void setValueImpl(float percent, bool update_pane);
  
  virtual void pressScroller(int dir);
   
private:
  friend class UScrollbarView;
  friend class UScrollpane;
  uptr<UFloat> pvalue;          // scrollbar value (percentage)
  uptr<UScrollpane> ppane;      // the pane controlled by this scrollbar
  uptr<UBox> pless_btn, pmore_btn, pknob, prail;
  UPos knob_pos;                // current position of the knob
  int unit_increment, block_increment;
  int delta_mouse;
  bool press_rail_goto_pos;     // dont scroll but goes to pos is trus
  bool is_transparent, show_rail, tracking_mode; //enter_feedback, drag_feedback
  
  void constructs();
  //nb: inutile que contructs soit virtuel car appele par constructeur!

  virtual void pressKnob(UMouseEvent&);
  virtual void releaseKnob(UMouseEvent&);
  virtual void dragKnob(UMouseEvent&);
  virtual void pressRail(UMouseEvent&);
  virtual void releaseRail(UMouseEvent&);
  virtual float getPercent(UMouseEvent&, UView* knob_view, 
                           UView* rail_view, int delta_mouse);
  virtual float getIncrementPercent(int increment);
};

/* ==================================================== ===== ======= */
class UScrollbarView : public UView {
public:
  static  UViewStyle style;  // renderer
  virtual UViewStyle* getViewStyle() {return &style;}

  UScrollbarView(UChild*, UView* parview, UHardWinImpl*);
  static UView* createView(UChild*, UView* parview, UHardWinImpl*);

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#ifndef NO_DOC
  friend class UScrollbar;
  virtual void doUpdate(UContext&, URegion r, URegion clip, UViewUpdate&);
#endif
};
}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---