Crazy Eddies GUI System  0.7.8
CEGUIButtonBase.h
1 /***********************************************************************
2  filename: CEGUIButtonBase.h
3  created: 13/4/2004
4  author: Paul D Turner
5 
6  purpose: Interface to base class for ButtonBase 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 _CEGUIButtonBase_h_
31 #define _CEGUIButtonBase_h_
32 
33 #include "../CEGUIBase.h"
34 #include "../CEGUIWindow.h"
35 
36 
37 #if defined(_MSC_VER)
38 # pragma warning(push)
39 # pragma warning(disable : 4251)
40 #endif
41 
42 
43 // Start of CEGUI namespace section
44 namespace CEGUI
45 {
46 
51 class CEGUIEXPORT ButtonBase : public Window
52 {
53 public:
54  /*************************************************************************
55  Accessor type functions
56  *************************************************************************/
64  bool isHovering(void) const {return d_hovering;}
65 
66 
74  bool isPushed(void) const {return d_pushed;}
75 
79  void setPushedState(const bool pushed);
80 
81  /*************************************************************************
82  Construction and Destruction
83  *************************************************************************/
88  ButtonBase(const String& type, const String& name);
89 
90 
95  virtual ~ButtonBase(void);
96 
97 
98 protected:
99  /*************************************************************************
100  Overridden event handlers
101  *************************************************************************/
102  virtual void onMouseMove(MouseEventArgs& e);
103  virtual void onMouseButtonDown(MouseEventArgs& e);
104  virtual void onMouseButtonUp(MouseEventArgs& e);
105  virtual void onCaptureLost(WindowEventArgs& e);
106  virtual void onMouseLeaves(MouseEventArgs& e);
107 
108 
109  /*************************************************************************
110  Implementation Functions
111  *************************************************************************/
122  void updateInternalState(const Point& mouse_pos);
123 
124 
135  virtual bool testClassName_impl(const String& class_name) const
136  {
137  if (class_name=="ButtonBase") return true;
138  return Window::testClassName_impl(class_name);
139  }
140 
141 
142  /*************************************************************************
143  Implementation Data
144  *************************************************************************/
145  bool d_pushed;
146  bool d_hovering;
147 };
148 
149 } // End of CEGUI namespace section
150 
151 #if defined(_MSC_VER)
152 # pragma warning(pop)
153 #endif
154 
155 #endif // end of guard _CEGUIButtonBase_h_
Generated by   doxygen 1.8.3.1