Slider.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
//
// 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_SLIDER_INCLUDED_
#define _TGUI_SLIDER_INCLUDED_


namespace tgui
{

    struct TGUI_API Slider : public OBJECT
    {
        Slider();


        Slider(const Slider& copy);


        virtual ~Slider();


        Slider& operator= (const Slider& right);


        virtual Slider* clone();


        virtual bool load(const std::string& pathname);


        virtual void setSize(float width, float height);


        virtual Vector2u getSize() const;


        virtual Vector2f getScaledSize() const;


        virtual std::string getLoadedPathname() const;


        virtual void setMinimum(unsigned int minimum);


        virtual void setMaximum(unsigned int maximum);


        virtual void setValue(unsigned int value);


        virtual void setVerticalScroll(bool verticallScroll);


        virtual unsigned int getMinimum() const;


        virtual unsigned int getMaximum() const;


        virtual unsigned int getValue() const;


        virtual bool getVerticalScroll();


        // These functions are used to receive callback from the EventManager.
        // You normally don't need them, but you can use them to simulate an event.
        virtual bool mouseOnObject(float x, float y);
        virtual void leftMousePressed(float x, float y);
        virtual void leftMouseReleased(float x, float y);
        virtual void mouseMoved(float x, float y);
        virtual void mouseWheelMoved(int delta);
        virtual void keyPressed(sf::Keyboard::Key key);
        virtual void objectFocused();


    protected:

        // Because this struct is derived from sf::Drawable, you can just call the draw function from your sf::RenderTarget.
        // This function will be called and it will draw the slider on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


    protected:

        // When the mouse went down, did it go down on top of the thumb? If so, where?
        bool m_MouseDownOnThumb;
        Vector2f m_MouseDownOnThumbPos;

        unsigned int m_Minimum;
        unsigned int m_Maximum;
        unsigned int m_Value;

        // Is the slider draw vertically?
        bool m_VerticalScroll;

        // Does the image lie vertically?
        bool m_VerticalImage;

        // If this is true then the L, M and R images will be used.
        // If it is false then the slider is just one big image that will be stored in the M image.
        bool m_SplitImage;

        // Is there a separate hover image, or is it a semi-transparent image that is drawn on top of the others?
        bool m_SeparateHoverImage;

        // The size of the slider and its thumb
        Vector2f m_Size;
        Vector2f m_ThumbSize;

        sf::Texture* m_TextureTrackNormal_L;
        sf::Texture* m_TextureTrackHover_L;
        sf::Texture* m_TextureTrackNormal_M;
        sf::Texture* m_TextureTrackHover_M;
        sf::Texture* m_TextureTrackNormal_R;
        sf::Texture* m_TextureTrackHover_R;
        sf::Texture* m_TextureThumbNormal;
        sf::Texture* m_TextureThumbHover;

        sf::Sprite   m_SpriteTrackNormal_L;
        sf::Sprite   m_SpriteTrackHover_L;
        sf::Sprite   m_SpriteTrackNormal_M;
        sf::Sprite   m_SpriteTrackHover_M;
        sf::Sprite   m_SpriteTrackNormal_R;
        sf::Sprite   m_SpriteTrackHover_R;
        sf::Sprite   m_SpriteThumbNormal;
        sf::Sprite   m_SpriteThumbHover;

        // The pathname used to load the slider
        std::string m_LoadedPathname;
    };

}


#endif //_TGUI_SLIDER_INCLUDED_