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

Revision 692, 2.9 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies

Line 
1/************************************************************************
2        filename:       CEGUIRadioButtonProperties.h
3        created:        10/7/2004
4        author:         Paul D Turner
5       
6        purpose:        Interface to properties for RadioButton 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 _CEGUIRadioButtonProperties_h_
27#define _CEGUIRadioButtonProperties_h_
28
29#include "CEGUIProperty.h"
30
31
32// Start of CEGUI namespace section
33namespace CEGUI
34{
35
36// Start of RadioButtonProperties namespace section
37/*!
38\brief
39        Namespace containing all classes that make up the properties interface for the RadioButton class
40*/
41namespace RadioButtonProperties
42{
43/*!
44\brief
45        Property to access the selected state of the RadioButton.
46
47        \par Usage:
48                - Name: Selected
49                - Format: "[text]".
50
51        \par Where [Text] is:
52                - "True" to indicate the radio button is selected.
53                - "False" to indicate the radio button is not selected.
54*/
55class Selected : public Property
56{
57public:
58        Selected() : Property(
59                "Selected",
60                "Property to get/set the selected state of the RadioButton.  Value is either \"True\" or \"False\".",
61                "False")
62        {}
63
64        String  get(const PropertyReceiver* receiver) const;
65        void    set(PropertyReceiver* receiver, const String& value);
66};
67
68
69/*!
70\brief
71        Property to access the radio button group ID.
72
73        \par Usage:
74                - Name: GroupID
75                - Format: "[uint]".
76
77        \par Where:
78                - [uint] is any unsigned integer value.
79*/
80class GroupID : public Property
81{
82public:
83        GroupID() : Property(
84                "GroupID",
85                "Property to get/set the radio button group ID.  Value is an unsigned integer number.",
86                "0")
87        {}
88
89        String  get(const PropertyReceiver* receiver) const;
90        void    set(PropertyReceiver* receiver, const String& value);
91};
92
93
94} // End of  RadioButtonProperties namespace section
95
96} // End of  CEGUI namespace section
97
98
99#endif  // end of guard _CEGUIRadioButtonProperties_h_
Note: See TracBrowser for help on using the repository browser.