Crazy Eddies GUI System  0.7.1
CEGUICheckbox.h
1 /***********************************************************************
2  filename: CEGUICheckbox.h
3  created: 13/4/2004
4  author: Paul D Turner
5 
6  purpose: Interface to base class for Checkbox 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 _CEGUICheckbox_h_
31 #define _CEGUICheckbox_h_
32 
33 #include "../CEGUIBase.h"
34 #include "CEGUIButtonBase.h"
35 #include "CEGUICheckboxProperties.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 {
47 
52 class CEGUIEXPORT Checkbox : 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
62  static const String EventCheckStateChanged;
63 
64 
65  /*************************************************************************
66  Accessor Functions
67  *************************************************************************/
76  bool isSelected(void) const {return d_selected;}
77 
78 
79  /*************************************************************************
80  Manipulator Functions
81  *************************************************************************/
93  void setSelected(bool select);
94 
95 
96  /*************************************************************************
97  Construction / Destruction
98  *************************************************************************/
103  Checkbox(const String& type, const String& name);
104 
105 
110  virtual ~Checkbox(void);
111 
112 
113 protected:
114  /*************************************************************************
115  New event handlers
116  *************************************************************************/
121  virtual void onSelectStateChange(WindowEventArgs& e);
122 
123 
124  /*************************************************************************
125  Overridden event handlers
126  *************************************************************************/
127  virtual void onMouseButtonUp(MouseEventArgs& e);
128 
129 
130  /*************************************************************************
131  Implementation Functions
132  *************************************************************************/
143  virtual bool testClassName_impl(const String& class_name) const
144  {
145  if (class_name=="Checkbox") return true;
146  return ButtonBase::testClassName_impl(class_name);
147  }
148 
149 
150  /*************************************************************************
151  Implementation Data
152  *************************************************************************/
153  bool d_selected;
154 
155 private:
156  /*************************************************************************
157  Static Properties for this class
158  *************************************************************************/
159  static CheckboxProperties::Selected d_selectedProperty;
160 
161 
162  /*************************************************************************
163  Private methods
164  *************************************************************************/
165  void addCheckboxProperties(void);
166 };
167 
168 } // End of CEGUI namespace section
169 
170 #if defined(_MSC_VER)
171 # pragma warning(pop)
172 #endif
173 
174 #endif // end of guard _CEGUICheckbox_h_
Generated by   doxygen 1.8.3.1