uscrollpane.hpp

/************************************************************************
 *
 *  uscrollpane.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 _uscrollpane_hpp_
#define _uscrollpane_hpp_ 1
#include <ubit/uborder.hpp>
#include <ubit/uview.hpp>
namespace ubit {
  
  class UScrollpane: public UBox {
  public:
    UCLASS(UScrollpane)

    UScrollpane(UArgs = UArgs::none);
    
    UScrollpane(int vert_scrollbar, int horiz_scrollbar, UArgs = UArgs::none);
    virtual ~UScrollpane();
    
    static UStyle* createStyle();

    void setTracking(bool);
    
    float getXScroll() const {return xscroll;}
    
    float getYScroll() const {return yscroll;}
  
    UScrollpane& setXScroll(float _xscroll) {return setScroll(_xscroll, yscroll);}
    
    UScrollpane& setYScroll(float _yscroll) {return setScroll(xscroll, _yscroll);}
    
    virtual UScrollpane& setScroll(float xscroll, float yscroll);

    virtual void makeVisible(UBox& child);
    UScrollpane& showHScrollbar(bool state);
    UScrollpane& showVScrollbar(bool state);
    
    UScrollpane& showHScrollButtons(bool state);
    UScrollpane& showVScrollButtons(bool state);

    UScrollbar* getHScrollbar() {return hscrollbar;}
    
    UScrollbar* getVScrollbar() {return vscrollbar;}
    
    UBox* getScrolledBox();
    
    UView* getScrolledView(UView* pane_view);
    // - - - Impl.  - - - - - - - - - - - - - - - - - - - - - - - - - - -    
#ifndef NO_DOC
    virtual void setScrollImpl(float xscroll, float yscroll);    
  protected:
    friend class UScrollbar;
    UScrollbar *hscrollbar, *vscrollbar;
    float xscroll, yscroll;
    
    virtual void constructs(int vs_mode, int hs_mode, const UArgs&);
    virtual void unsetHScrollbar();
    virtual void unsetVScrollbar();
    virtual void resizeCB(UResizeEvent&);
    virtual void wheelCB(UWheelEvent&);
#endif
  };
  
  inline UScrollpane& uscrollpane(const UArgs& args = UArgs::none) 
  {return *new UScrollpane(args);}
  
  inline UScrollpane& uscrollpane(int vscrollbar, int hscrollbar, const UArgs& args = UArgs::none)
  {return *new UScrollpane(vscrollbar, hscrollbar, args);}
  
  
  /* ==================================================== ======== ======= */
  class UPaneView: public UView {
  public:
    static  UViewStyle style;  // renderer
    virtual UViewStyle* getViewStyle() {return &style;}
    
    UPaneView(UBox*, UView* parview, UHardwinImpl*);
    virtual ~UPaneView() {}
    static UView* createView(UBox*, UView* parview, UHardwinImpl*);
    
    virtual UPaneView* toPaneView() {return this;}
    
    float getXScroll() {return xscroll;}
    float getYScroll() {return yscroll;}
    
    virtual void setXScroll(float scr) {xscroll = scr;}
    virtual void setYScroll(float scr) {yscroll = scr;}
    
    void setPadding(const UPaddingSpec& p) {padding = p;} // for UView::initLayoutViewport
    
#ifndef NO_DOC
    friend class UScrollpane;
    UPaddingSpec padding;
    float xscroll, yscroll;
#endif
  };
}
#endif