CEGUISlider.h

/***********************************************************************
        filename:       CEGUISlider.h
        created:        13/4/2004
        author:         Paul D Turner
        
        purpose:        Interface to base class for Slider widget
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUISlider_h_
#define _CEGUISlider_h_

#include "CEGUIBase.h"
#include "CEGUIWindow.h"
#include "elements/CEGUISliderProperties.h"


#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT SliderWindowRenderer : public WindowRenderer
{
public:
    SliderWindowRenderer(const String& name);

    virtual void    updateThumb(void)   = 0;

    virtual float   getValueFromThumb(void) const   = 0;

    virtual float   getAdjustDirectionFromPoint(const Point& pt) const  = 0;
};


class CEGUIEXPORT Slider : public Window
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Event name constants
        *************************************************************************/
        static const String EventValueChanged;          
        static const String EventThumbTrackStarted;     
        static const String EventThumbTrackEnded;               

    /*************************************************************************
        Child Widget name suffix constants
    *************************************************************************/
    static const String ThumbNameSuffix;            

        /*************************************************************************
                Accessors
        *************************************************************************/
        float   getCurrentValue(void) const                     {return d_value;}


        float   getMaxValue(void) const                         {return d_maxValue;}


        float   getClickStep(void) const                {return d_step;}


    Thumb* getThumb() const;


        /*************************************************************************
                Manipulators
        *************************************************************************/
        virtual void    initialiseComponents(void);


        void    setMaxValue(float maxVal);


        void    setCurrentValue(float value);


        void    setClickStep(float step)                {d_step = step;}


        /*************************************************************************
                Construction / Destruction
        *************************************************************************/
        Slider(const String& type, const String& name);


        virtual ~Slider(void);


protected:
        /*************************************************************************
                Implementation Functions
        *************************************************************************/
        virtual void    updateThumb(void);


        virtual float   getValueFromThumb(void) const;


        virtual float   getAdjustDirectionFromPoint(const Point& pt) const;


    //virtual void    updateThumb_impl(void)   = 0;


    //virtual float   getValueFromThumb_impl(void) const   = 0;


    //virtual float   getAdjustDirectionFromPoint_impl(const Point& pt) const  = 0;

        bool    handleThumbMoved(const EventArgs& e);


        bool    handleThumbTrackStarted(const EventArgs& e);


        bool    handleThumbTrackEnded(const EventArgs& e);


        virtual bool    testClassName_impl(const String& class_name) const
        {
                if (class_name=="Slider")       return true;
                return Window::testClassName_impl(class_name);
        }


    // validate window renderer
    virtual bool validateWindowRenderer(const String& name) const
    {
        return (name == "Slider");
    }


        /*************************************************************************
                New event handlers for slider widget
        *************************************************************************/
        virtual void    onValueChanged(WindowEventArgs& e);


        virtual void    onThumbTrackStarted(WindowEventArgs& e);


        virtual void    onThumbTrackEnded(WindowEventArgs& e);


        /*************************************************************************
                Overridden event handlers
        *************************************************************************/
        virtual void    onMouseButtonDown(MouseEventArgs& e);
        virtual void    onMouseWheel(MouseEventArgs& e);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        float   d_value;                
        float   d_maxValue;             
        float   d_step;                 

private:
        /*************************************************************************
                Static Properties for this class
        *************************************************************************/
        static SliderProperties::CurrentValue   d_currentValueProperty;
        static SliderProperties::MaximumValue   d_maximumValueProperty;
        static SliderProperties::ClickStepSize  d_clickStepSizeProperty;


        /*************************************************************************
                Private methods
        *************************************************************************/
        void    addSliderProperties(void);
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUISlider_h_