source: GTP/trunk/Lib/Geom/OgreStuff/include/CEGUI/elements/CEGUICheckboxProperties.h @ 1809

Revision 1809, 2.5 KB checked in by gumbau, 18 years ago (diff)
Line 
1/************************************************************************
2        filename:       CEGUICheckboxProperties.h
3        created:        9/7/2004
4        author:         Paul D Turner
5       
6        purpose:        Interface to properties for the Checkbox class
7*************************************************************************/
8/*************************************************************************
9    Crazy Eddie's GUI System (http://www.cegui.org.uk)
10    Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
11
12    This library is free software; you can redistribute it and/or
13    modify it under the terms of the GNU Lesser General Public
14    License as published by the Free Software Foundation; either
15    version 2.1 of the License, or (at your option) any later version.
16
17    This library is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20    Lesser General Public License for more details.
21
22    You should have received a copy of the GNU Lesser General Public
23    License along with this library; if not, write to the Free Software
24    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25*************************************************************************/
26#ifndef _CEGUICheckboxProperties_h_
27#define _CEGUICheckboxProperties_h_
28
29#include "CEGUIProperty.h"
30
31
32// Start of CEGUI namespace section
33namespace CEGUI
34{
35
36// Start of CheckboxProperties namespace section
37/*!
38\brief
39        Namespace containing all classes that make up the properties interface for the Checkbox class
40*/
41namespace CheckboxProperties
42{
43/*!
44\brief
45        Property to access the selected state of the check box.
46
47        This property offers access to the select state for the Checkbox object.
48
49        \par Usage:
50                - Name: Selected
51                - Format: "[text]".
52
53        \par Where [Text] is:
54                - "True" to indicate the check box is selected (has check mark).
55                - "False" to indicate the check box is not selected (does not have check mark).
56*/
57class Selected : public Property
58{
59public:
60        Selected() : Property(
61                "Selected",
62                "Property to get/set the selected state of the Checkbox.  Value is either \"True\" or \"False\".",
63                "False")
64        {}
65
66        String  get(const PropertyReceiver* receiver) const;
67        void    set(PropertyReceiver* receiver, const String& value);
68};
69
70} // End of  CheckboxProperties namespace section
71
72} // End of  CEGUI namespace section
73
74
75#endif  // end of guard _CEGUICheckboxProperties_h_
Note: See TracBrowser for help on using the repository browser.