SpinButton.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_SPIN_BUTTON_INCLUDED_
#define _TGUI_SPIN_BUTTON_INCLUDED_


namespace tgui
{

    struct TGUI_API SpinButton : public OBJECT
    {
        SpinButton();


        SpinButton(const SpinButton& copy);


        virtual ~SpinButton();


        SpinButton& operator= (const SpinButton& right);


        virtual SpinButton* 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 unsigned int getMinimum() const;


        virtual unsigned int getMaximum() const;


        virtual unsigned int getValue() const;


        // 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 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 spin button on the render target.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


    public:

        bool verticalScroll;

    protected:

        Vector2f m_Size;

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

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

        // On which arrow is the mouse?
        bool m_MouseHoverOnTopArrow;
        bool m_MouseDownOnTopArrow;

        sf::Texture* m_TextureNormal;
        sf::Texture* m_TextureHover;

        sf::Sprite   m_SpriteNormal;
        sf::Sprite   m_SpriteHover;

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

}


#endif //_TGUI_SPIN_BUTTON_INCLUDED_