Scroll.h

Go to the documentation of this file.

// -*- C++ -*-
/* GG is a GUI for SDL and OpenGL.
   Copyright (C) 2003 T. Zachary Laine

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public License
   as published by the Free Software Foundation; either version 2.1
   of the License, or (at your option) any later version.
   
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.
    
   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA

   If you do not wish to comply with the terms of the LGPL please
   contact the author as other terms are available for a fee.
    
   Zach Laine
   whatwasthataddress@hotmail.com */

#ifndef _GG_Scroll_h_
#define _GG_Scroll_h_

#include <GG/Control.h>


namespace GG {

class Button;

class GG_API Scroll : public Control
{
public:
    enum ScrollRegion {
        SBR_NONE,
        SBR_PAGE_DN,
        SBR_PAGE_UP
    };
 
    typedef boost::signal<void (int, int, int, int)> ScrolledSignalType; 
    typedef boost::signal<void (int, int, int, int)> ScrolledAndStoppedSignalType; 

 
    typedef ScrolledSignalType::slot_type ScrolledSlotType; 
    typedef ScrolledAndStoppedSignalType::slot_type ScrolledAndStoppedSlotType; 

 

    Scroll(int x, int y, int w, int h, Orientation orientation, Clr color, Clr interior,
           Flags<WndFlag> flags = CLICKABLE | REPEAT_BUTTON_DOWN);
 
    virtual Pt           MinUsableSize() const;

    std::pair<int, int>  PosnRange() const;         
    std::pair<int, int>  ScrollRange() const;       
    int                  LineSize() const;          
    int                  PageSize() const;          

    Clr                  InteriorColor() const;     
    Orientation          ScrollOrientation() const; 

    mutable ScrolledSignalType           ScrolledSignal;           
    mutable ScrolledAndStoppedSignalType ScrolledAndStoppedSignal; 

 
    virtual void   Render();
    virtual void   LButtonDown(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   LButtonUp(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   LClick(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   MouseHere(const Pt& pt, Flags<ModKey> mod_keys);

    virtual void   SizeMove(const Pt& ul, const Pt& lr);

    virtual void   Disable(bool b = true);
    virtual void   SetColor(Clr c);

    void           SetInteriorColor(Clr c); 
    void           SizeScroll(int min, int max, int line, int page); 
    void           SetMax(int max);         
    void           SetMin(int min);         
    void           SetLineSize(int line);   
    void           SetPageSize(int page);   

    void           ScrollTo(int p);  
    void           ScrollLineIncr(); 
    void           ScrollLineDecr(); 
    void           ScrollPageIncr(); 
    void           ScrollPageDecr(); 

    virtual void   DefineAttributes(WndEditor* editor);

protected: 
    Scroll(); 

 
    int           TabSpace() const;          
    int           TabWidth() const;          
    ScrollRegion  RegionUnder(const Pt& pt); 

    Button*       TabButton() const;     
    Button*       IncrButton() const;    
    Button*       DecrButton() const;    

 
    virtual bool  EventFilter(Wnd* w, const WndEvent& event);

private:
    void              UpdatePosn();        
    void              MoveTabToPosn();     

    Clr               m_int_color;   
    const Orientation m_orientation; 
    int               m_posn;        
    int               m_range_min;   
    int               m_range_max;   
    int               m_line_sz;     
    int               m_page_sz;     
    Button*           m_tab;         
    Button*           m_incr;        
    Button*           m_decr;        
    ScrollRegion      m_initial_depressed_region; 
    ScrollRegion      m_depressed_region;         

    friend class boost::serialization::access;
    template <class Archive>
    void serialize(Archive& ar, const unsigned int version);
};

// define EnumMap and stream operators for Scroll::ScrollRegion
GG_ENUM_MAP_BEGIN(Scroll::ScrollRegion)
    GG_ENUM_MAP_INSERT(Scroll::SBR_NONE)
    GG_ENUM_MAP_INSERT(Scroll::SBR_PAGE_DN)
    GG_ENUM_MAP_INSERT(Scroll::SBR_PAGE_UP)
GG_ENUM_MAP_END

GG_ENUM_STREAM_IN(Scroll::ScrollRegion)
GG_ENUM_STREAM_OUT(Scroll::ScrollRegion)

} // namespace GG

// template implementations
template <class Archive>
void GG::Scroll::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(Control)
        & BOOST_SERIALIZATION_NVP(m_int_color)
        & boost::serialization::make_nvp("m_orientation", const_cast<Orientation&>(m_orientation))
        & BOOST_SERIALIZATION_NVP(m_posn)
        & BOOST_SERIALIZATION_NVP(m_range_min)
        & BOOST_SERIALIZATION_NVP(m_range_max)
        & BOOST_SERIALIZATION_NVP(m_line_sz)
        & BOOST_SERIALIZATION_NVP(m_page_sz)
        & BOOST_SERIALIZATION_NVP(m_tab)
        & BOOST_SERIALIZATION_NVP(m_incr)
        & BOOST_SERIALIZATION_NVP(m_decr);
}

#endif // _GG_Scroll_h_

---