Slider.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_Slider_h_
#define _GG_Slider_h_

#include <GG/Control.h>

#include <boost/serialization/version.hpp>


namespace GG {

class Button;
class WndEvent;

class GG_API Slider : public Control
{
public: 
    typedef boost::signal<void (int, int, int)> SlidSignalType;           
    typedef boost::signal<void (int, int, int)> SlidAndStoppedSignalType; 

 
    typedef SlidSignalType::slot_type SlidSlotType;           
    typedef SlidSignalType::slot_type SlidAndStoppedSlotType; 

 
    Slider(int x, int y, int w, int h, int min, int max, Orientation orientation, SliderLineStyle style, Clr color, int tab_width, int line_width = 5, Flags<WndFlag> flags = CLICKABLE); 

 
    virtual Pt           MinUsableSize() const;

    int                  Posn() const;           
    std::pair<int, int>  SliderRange() const;    

    int                  PageSize() const;

    Orientation          GetOrientation() const; 
    int                  TabWidth() const;       
    int                  LineWidth() const;      
    SliderLineStyle      LineStyle() const;      

    mutable SlidSignalType           SlidSignal;           
    mutable SlidAndStoppedSignalType SlidAndStoppedSignal; 

 
    virtual void   Render();
    virtual void   LClick(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   KeyPress(Key key, 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           SizeSlider(int min, int max); 
    void           SetMax(int max);              
    void           SetMin(int min);              
    void           SlideTo(int p);               

    void           SetPageSize(int size);

    void           SetLineStyle(SliderLineStyle style); 

    virtual void   DefineAttributes(WndEditor* editor);

protected: 
    Slider(); 

 
    Button* Tab() const;                  
    int     PtToPosn(const Pt& pt) const; 

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

    void MoveTabToPosn(); 


private:
    void UpdatePosn();

    int                       m_posn;
    int                       m_range_min;
    int                       m_range_max;
    int                       m_page_sz;
    Orientation               m_orientation;
    int                       m_line_width;
    int                       m_tab_width;
    SliderLineStyle           m_line_style;
    int                       m_tab_drag_offset;
    Button*                   m_tab;

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

} // namespace GG

BOOST_CLASS_VERSION(GG::Slider, 1)

// template implementations
template <class Archive>
void GG::Slider::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(Control)
        & BOOST_SERIALIZATION_NVP(m_posn)
        & BOOST_SERIALIZATION_NVP(m_range_min)
        & BOOST_SERIALIZATION_NVP(m_range_max)
        & BOOST_SERIALIZATION_NVP(m_orientation)
        & BOOST_SERIALIZATION_NVP(m_line_width)
        & BOOST_SERIALIZATION_NVP(m_tab_width)
        & BOOST_SERIALIZATION_NVP(m_line_style)
        & BOOST_SERIALIZATION_NVP(m_tab_drag_offset)
        & BOOST_SERIALIZATION_NVP(m_tab);

    if (1 <= version)
        ar & BOOST_SERIALIZATION_NVP(m_page_sz);
}

#endif // _GG_Slider_h_

---