source: OGRE/trunk/ogre_dependencies/Dependencies/include/CEGUI/elements/CEGUICheckboxProperties.h @ 692

/************************************************************************
        filename:       CEGUICheckboxProperties.h
        created:        9/7/2004
        author:         Paul D Turner
        
        purpose:        Interface to properties for the Checkbox class
*************************************************************************/
/*************************************************************************
    Crazy Eddie's GUI System (http://www.cegui.org.uk)
    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*************************************************************************/
#ifndef _CEGUICheckboxProperties_h_
#define _CEGUICheckboxProperties_h_

#include "CEGUIProperty.h"


// Start of CEGUI namespace section
namespace CEGUI
{

// Start of CheckboxProperties namespace section
/*!
\brief
        Namespace containing all classes that make up the properties interface for the Checkbox class
*/
namespace CheckboxProperties
{
/*!
\brief
        Property to access the selected state of the check box.

        This property offers access to the select state for the Checkbox object.

        \par Usage:
                - Name: Selected
                - Format: "[text]".

        \par Where [Text] is:
                - "True" to indicate the check box is selected (has check mark).
                - "False" to indicate the check box is not selected (does not have check mark).
*/
class Selected : public Property
{
public:
        Selected() : Property(
                "Selected",
                "Property to get/set the selected state of the Checkbox.  Value is either \"True\" or \"False\".",
                "False")
        {}

        String  get(const PropertyReceiver* receiver) const;
        void    set(PropertyReceiver* receiver, const String& value);
};

} // End of  CheckboxProperties namespace section

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUICheckboxProperties_h_