Crazy Eddie's GUI System  0.8.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
widgets/ToggleButton.h
1 /***********************************************************************
2  filename: ToggleButton.h
3  created: Tue Feb 28 2012
4  author: Paul D Turner <paul@cegui.org.uk>
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIToggleButton_h_
29 #define _CEGUIToggleButton_h_
30 
31 #include "CEGUI/widgets/ButtonBase.h"
32 
33 #if defined(_MSC_VER)
34 # pragma warning(push)
35 # pragma warning(disable : 4251)
36 #endif
37 
38 namespace CEGUI
39 {
41 class CEGUIEXPORT ToggleButton : public ButtonBase
42 {
43 public:
44  static const String EventNamespace;
45  static const String WidgetTypeName;
46 
51  static const String EventSelectStateChanged;
52 
54  bool isSelected(void) const { return d_selected; }
55 
57  void setSelected(bool select);
58 
59  ToggleButton(const String& type, const String& name);
60 
61 protected:
62  virtual bool getPostClickSelectState() const;
63  void addToggleButtonProperties();
64 
66  virtual void onSelectStateChange(WindowEventArgs& e);
67 
68  // base class overriddes
69  void onMouseButtonUp(MouseEventArgs& e);
70 
71  bool d_selected;
72 };
73 
74 }
75 
76 #endif
77