Checkbox.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_CHECKBOX_HPP
#define TGUI_CHECKBOX_HPP


#include <TGUI/RadioButton.hpp>


namespace tgui
{

    class TGUI_API Checkbox : public RadioButton
    {
      public:

        typedef SharedWidgetPtr<Checkbox> Ptr;


        Checkbox();


        // 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 Checkbox* clone();


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


        void check();


        void uncheck();


        virtual void leftMouseReleased(float x, float y);

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


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


      public:

        enum CheckboxCallbacks
        {
            AllCheckboxCallbacks = RadioButtonCallbacksCount - 1, 
            CheckboxCallbacksCount = RadioButtonCallbacksCount
        };


    };


}


#endif // TGUI_CHECKBOX_HPP