1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/***********************************************************************
filename: CEGUIPushButton.h
created: 13/4/2004
author: Paul D Turner
purpose: Interface to base class for PushButton widget
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIPushButton_h_
#define _CEGUIPushButton_h_
#include "../CEGUIBase.h"
#include "CEGUIButtonBase.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Base class to provide logic for push button type widgets.
*/
class CEGUIEXPORT PushButton : public ButtonBase
{
public:
static const String EventNamespace; //!< Namespace for global events
static const String WidgetTypeName; //!< Window factory name
/*************************************************************************
Event name constants
*************************************************************************/
// generated internally by Window
/** Event fired when the button is clicked.
* Handlers are passed a const WindowEventArgs reference with
* WindowEventArgs::window set to the PushButton that was clicked.
*/
static const String EventClicked;
/*************************************************************************
Construction and Destruction
*************************************************************************/
/*!
\brief
Constructor for base PushButton class
*/
PushButton(const String& type, const String& name);
/*!
\brief
Destructor for PushButton class
*/
virtual ~PushButton(void);
protected:
/*************************************************************************
New Event Handlers
*************************************************************************/
/*!
\brief
handler invoked internally when the button is clicked.
*/
virtual void onClicked(WindowEventArgs& e);
/*************************************************************************
Overridden Event Handlers
*************************************************************************/
virtual void onMouseButtonUp(MouseEventArgs& e);
/*************************************************************************
Implementation Functions
*************************************************************************/
/*!
\brief
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
\param class_name
The class name that is to be checked.
\return
true if this window was inherited from \a class_name. false if not.
*/
virtual bool testClassName_impl(const String& class_name) const
{
if (class_name=="PushButton") return true;
return ButtonBase::testClassName_impl(class_name);
}
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIPushButton_h_
|
