Crazy Eddie's GUI System  0.8.5
widgets/ToggleButton.h
1 /***********************************************************************
2  created: Tue Feb 28 2012
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIToggleButton_h_
28 #define _CEGUIToggleButton_h_
29 
30 #include "CEGUI/widgets/ButtonBase.h"
31 
32 #if defined(_MSC_VER)
33 # pragma warning(push)
34 # pragma warning(disable : 4251)
35 #endif
36 
37 namespace CEGUI
38 {
40 class CEGUIEXPORT ToggleButton : public ButtonBase
41 {
42 public:
43  static const String EventNamespace;
44  static const String WidgetTypeName;
45 
51 
53  bool isSelected(void) const { return d_selected; }
54 
56  void setSelected(bool select);
57 
58  ToggleButton(const String& type, const String& name);
59 
60 protected:
61  virtual bool getPostClickSelectState() const;
62  void addToggleButtonProperties();
63 
65  virtual void onSelectStateChange(WindowEventArgs& e);
66 
67  // base class overriddes
68  void onMouseButtonUp(MouseEventArgs& e);
69 
70  bool d_selected;
71 };
72 
73 }
74 
75 #endif
76 
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Base class for all the 'button' type widgets (push button, radio button, check-box, etc)
Definition: ButtonBase.h:50
Class providing logic buttons that can have their selected state toggled.
Definition: widgets/ToggleButton.h:40
EventArgs based class that is used for objects passed to handlers triggered for events concerning som...
Definition: InputEvent.h:251
EventArgs based class that is used for objects passed to input event handlers concerning mouse input...
Definition: InputEvent.h:280
bool isSelected(void) const
returns true if the toggle button is in the selected state.
Definition: widgets/ToggleButton.h:53
static const String EventSelectStateChanged
Definition: widgets/ToggleButton.h:50
String class used within the GUI system.
Definition: String.h:62