uscrollbar.hpp

/************************************************************************
 *
 *  uscrollbar.hpp
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | 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.
 * ***********************************************************************/

#ifndef _uscrollbar_hpp_
#define _uscrollbar_hpp_ 1
#include <ubit/ubox.hpp>
#include <ubit/ucolor.hpp>
#include <ubit/ustyle.hpp>
#include <ubit/uview.hpp>
namespace ubit {
  
  class UScrollbar: public UBox {
  public:
    UCLASS(UScrollbar)

    UScrollbar(const UArgs& = UArgs::none);
    UScrollbar(UFloat& value, const UArgs& = UArgs::none);
    virtual ~UScrollbar();
        
    static UStyle* createStyle();

    virtual float getValue() const;
    
    virtual UScrollbar& setValue(float percent);
    virtual float getUnitIncrement() const;

    virtual UScrollbar& setUnitIncrement(float);
    
    virtual float getBlockIncrement() const;

    virtual UScrollbar& setBlockIncrement(float);
    
    virtual UScrollbar& setTracking(bool);

    virtual bool isTracking() const;
    
    virtual UScrollbar& setTransparent(bool state = true);

    virtual bool isTransparent() const;
    
    // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    // implementation
    
    UFloat& value() {return *pvalue;}

    virtual UBox* getKnob() {return pknob;}
    virtual UBox* getRail() {return prail;}
    virtual UBox* getLessButton() {return pless_btn;}
    virtual UBox* getMoreButton() {return pmore_btn;}
    
    virtual UBox* createKnob(bool vertical);
    virtual UBox* createRail(bool vertical);
    virtual UBox* createLessButton(bool vertical);
    virtual UBox* createMoreButton(bool vertical);
    /* fonctions that create the knob, the rail and the 2 scroll buttons.
     * 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 pressScrollButton(UMouseEvent&, 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;
    uptr<UPos> pknob_pos;             // current position of the knob
    float unit_increment, block_increment;
    float 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, float delta_mouse);
    virtual float getIncrementPercent(UMouseEvent&, float increment);
  };
  
  inline UScrollbar& uscrollbar(const UArgs& args = UArgs::none) {return *new UScrollbar(args);}
  
  UScrollbar& uhscrollbar(const UArgs& args = UArgs::none);
  
  inline UScrollbar& uvscrollbar(const UArgs& args = UArgs::none) {return *new UScrollbar(args);}
  

  /* ==================================================== ===== ======= */
  class UScrollbarView : public UView {
    friend class UScrollbar;
  public:
    static  UViewStyle style;  // renderer
    virtual UViewStyle* getViewStyle() {return &style;}
    
    UScrollbarView(UBox*, UView* parview, UHardwinImpl*);
    static UView* createView(UBox*, UView* parview, UHardwinImpl*);
    
    virtual void doUpdate(UUpdateContext&, URect r, URect clip, UViewUpdate&);
  };
}
#endif