Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIRadioButton.h
1 /***********************************************************************
2  filename: CEGUIRadioButton.h
3  created: 13/4/2004
4  author: Paul D Turner
5 
6  purpose: Interface to base class for RadioButton widget
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to deal in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _CEGUIRadioButton_h_
31 #define _CEGUIRadioButton_h_
32 
33 #include "../CEGUIBase.h"
34 #include "CEGUIButtonBase.h"
35 #include "CEGUIRadioButtonProperties.h"
36 
37 
38 #if defined(_MSC_VER)
39 # pragma warning(push)
40 # pragma warning(disable : 4251)
41 #endif
42 
43 
44 // Start of CEGUI namespace section
45 namespace CEGUI
46 {
52 class CEGUIEXPORT RadioButton : public ButtonBase
53 {
54 public:
55  static const String EventNamespace;
56  static const String WidgetTypeName;
57 
58  /*************************************************************************
59  Event name constants
60  *************************************************************************/
61  // generated internally by Window
67  static const String EventSelectStateChanged;
68 
69 
70  /*************************************************************************
71  Accessor Functions
72  *************************************************************************/
80  bool isSelected(void) const {return d_selected;}
81 
82 
90  ulong getGroupID(void) const {return d_groupID;}
91 
92 
103  RadioButton* getSelectedButtonInGroup(void) const;
104 
105 
106  /*************************************************************************
107  Manipulator Functions
108  *************************************************************************/
121  void setSelected(bool select);
122 
123 
134  void setGroupID(ulong group);
135 
136 
137  /*************************************************************************
138  Construction / Destruction
139  *************************************************************************/
140  RadioButton(const String& type, const String& name);
141  virtual ~RadioButton(void);
142 
143 
144 protected:
145  /*************************************************************************
146  Implementation Functions
147  *************************************************************************/
153  void deselectOtherButtonsInGroup(void) const;
154 
155 
166  virtual bool testClassName_impl(const String& class_name) const
167  {
168  if (class_name=="RadioButton") return true;
169  return ButtonBase::testClassName_impl(class_name);
170  }
171 
172 
173  /*************************************************************************
174  New Radio Button Events
175  *************************************************************************/
180  virtual void onSelectStateChanged(WindowEventArgs& e);
181 
182 
183  /*************************************************************************
184  Overridden Event handlers
185  *************************************************************************/
186  virtual void onMouseButtonUp(MouseEventArgs& e);
187 
188 
189  /*************************************************************************
190  Implementation Data
191  *************************************************************************/
192  bool d_selected; // true when radio button is selected (has checkmark)
193  ulong d_groupID; // radio button group ID
194 
195 
196 private:
197  /*************************************************************************
198  Static Properties for this class
199  *************************************************************************/
200  static RadioButtonProperties::Selected d_selectedProperty;
201  static RadioButtonProperties::GroupID d_groupIDProperty;
202 
203 
204  /*************************************************************************
205  Private methods
206  *************************************************************************/
207  void addRadioButtonProperties(void);
208 };
209 
210 } // End of CEGUI namespace section
211 
212 #if defined(_MSC_VER)
213 # pragma warning(pop)
214 #endif
215 
216 #endif // end of guard _CEGUIRadioButton_h_