ClickableWidget.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_CLICKABLE_WIDGET_HPP
#define TGUI_CLICKABLE_WIDGET_HPP


#include <TGUI/Widget.hpp>


namespace tgui
{

    class TGUI_API ClickableWidget : public Widget
    {
      public:

        typedef SharedWidgetPtr<ClickableWidget> Ptr;


        ClickableWidget();


        ClickableWidget(const ClickableWidget& copy);


        virtual ~ClickableWidget();


        ClickableWidget& operator= (const ClickableWidget& 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 ClickableWidget* clone();


        virtual void setSize(float width, float height);


        virtual sf::Vector2f getSize() const;


        virtual bool mouseOnWidget(float x, float y);

        virtual void leftMousePressed(float x, float y);

        virtual void leftMouseReleased(float x, float y);


        // 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;


      protected:

        // This function draws nothing.
        virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


      public:

        enum ClickableWidgetCallbacks
        {
            LeftMousePressed              = WidgetCallbacksCount * 1,     
            LeftMouseReleased             = WidgetCallbacksCount * 2,     
            LeftMouseClicked              = WidgetCallbacksCount * 4,     
            AllClickableWidgetCallbacks   = WidgetCallbacksCount * 8 - 1, 
            ClickableWidgetCallbacksCount = WidgetCallbacksCount * 8
        };


      protected:

        // The size of the widget
        sf::Vector2f  m_Size;
    };

}


#endif // TGUI_CLICKABLE_WIDGET_HPP