RadioButton.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_RADIO_BUTTON_HPP
#define TGUI_RADIO_BUTTON_HPP


#include <TGUI/ClickableWidget.hpp>


namespace tgui
{

    class TGUI_API RadioButton : public ClickableWidget
    {
      public:

        typedef SharedWidgetPtr<RadioButton> Ptr;


        RadioButton();


        RadioButton(const RadioButton& copy);


        virtual ~RadioButton();


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


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


        const std::string& getLoadedConfigFile() const;


        virtual void setPosition(float x, float y);
        using Transformable::setPosition;


        virtual void setSize(float width, float height);


        virtual sf::Vector2f getSize() const;


        virtual sf::Vector2f getFullSize() const;


        virtual void check();


        virtual void uncheck();


        bool isChecked() const;


        void setText(const sf::String& text);


        sf::String getText() const;


        void setTextFont(const sf::Font& font);


        const sf::Font* getTextFont() const;


        void setTextColor(const sf::Color& color);


        const sf::Color& getTextColor() const;


        void setTextSize(unsigned int size);


        unsigned int getTextSize() const;


        void allowTextClick(bool acceptTextClick = true);


        virtual void setTransparency(unsigned char transparency);


        virtual bool mouseOnWidget(float x, float y);

        virtual void leftMouseReleased(float x, float y);

        virtual void keyPressed(const sf::Event::KeyEvent& event);

        virtual void widgetFocused();


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

        // This function is called when the widget is added to a container.
        virtual void initialize(Container *const container);


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


      public:

        enum RadioButtonCallbacks
        {
            Checked = ClickableWidgetCallbacksCount * 1,                      
            Unchecked = ClickableWidgetCallbacksCount * 2,                    
            SpaceKeyPressed = ClickableWidgetCallbacksCount * 8,              
            ReturnKeyPressed = ClickableWidgetCallbacksCount * 16,            
            AllRadioButtonCallbacks = ClickableWidgetCallbacksCount * 32 - 1, 
            RadioButtonCallbacksCount = ClickableWidgetCallbacksCount * 32
        };


      protected:

        std::string m_LoadedConfigFile;

        // This is the checked flag. When the radio button is checked then this variable will be true.
        bool m_Checked;

        // When this boolean is true (default) then the radio button will also be checked by clicking on the text.
        bool m_AllowTextClick;

        // This will contain the text that is written next to radio button.
        sf::Text m_Text;

        // This will store the size of the text ( 0 to auto size )
        unsigned int m_TextSize;

        Texture m_TextureUnchecked;
        Texture m_TextureChecked;
        Texture m_TextureHover;
        Texture m_TextureFocused;

    };

}


#endif // TGUI_RADIO_BUTTON_HPP