Slider2d.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef TGUI_SLIDER2D_HPP
#define TGUI_SLIDER2D_HPP


#include <TGUI/ClickableWidget.hpp>


namespace tgui
{

    class TGUI_API Slider2d : public ClickableWidget
    {
      public:

        typedef SharedWidgetPtr<Slider2d> Ptr;


        Slider2d();


        Slider2d(const Slider2d& copy);


        virtual ~Slider2d();


        Slider2d& operator= (const Slider2d& right);


        // Makes a copy of the widget by calling the copy constructor.
        // This function calls new and if you use this function then you are responsible for calling delete.
        virtual Slider2d* clone();


        bool load(const std::string& configFileFilename, const std::string& sectionName = "Slider2d");


        const std::string& getLoadedConfigFile() const;


        void setSize(float width, float height);


        void setMinimum(const sf::Vector2f& minimum);


        void setMaximum(const sf::Vector2f& maximum);


        void setValue(const sf::Vector2f& value);


        sf::Vector2f getMinimum() const;


        sf::Vector2f getMaximum() const;


        sf::Vector2f getValue() const;


        void setFixedThumbSize(bool fixedSize);


        bool getFixedThumbSize() const;


        void enableThumbCenter(bool autoCenterThumb);


        void centerThumb();


        virtual void setTransparency(unsigned char transparency);


        virtual void leftMousePressed(float x, float y);

        virtual void leftMouseReleased(float x, float y);

        virtual void mouseMoved(float x, float y);

        virtual void widgetFocused();

        virtual void mouseNoLongerDown();


        // This function is a (slow) way to set properties on the widget, no matter what type it is.
        // When the requested property doesn't exist in the widget then the functions will return false.
        virtual bool setProperty(std::string property, const std::string& value);

        // This function is a (slow) way to get properties of the widget, no matter what type it is.
        // When the requested property doesn't exist in the widget then the functions will return false.
        virtual bool getProperty(std::string property, std::string& value) const;


        // Returns a list of all properties that can be used in setProperty and getProperty.
        // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
        virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


      protected:

        // Draws the widget on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


      public:

        enum Slider2dCallbacks
        {
            ValueChanged = ClickableWidgetCallbacksCount * 1,             
            ThumbReturnedToCenter = ClickableWidgetCallbacksCount * 2,    
            AllSlider2dCallbacks = ClickableWidgetCallbacksCount * 4 - 1, 
            Slider2dCallbacksCount = ClickableWidgetCallbacksCount * 4
        };


      protected:

        std::string m_LoadedConfigFile;

        sf::Vector2f m_Minimum;
        sf::Vector2f m_Maximum;
        sf::Vector2f m_Value;

        bool m_ReturnThumbToCenter;
        bool m_FixedThumbSize;

        Texture m_TextureThumbNormal;
        Texture m_TextureThumbHover;
        Texture m_TextureTrackNormal;
        Texture m_TextureTrackHover;

        bool m_SeparateHoverImage;
    };

}


#endif // TGUI_SLIDER2D_HPP