Mercurial > fife-parpg

comparison ext/guichan-0.8.2/include/guichan/mouselistener.hpp @ 378:64738befdf3b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children
comparison
equal deleted inserted replaced
377:fe6fb0e0ed23 378:64738befdf3b
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_MOUSELISTENER_HPP
45 #define GCN_MOUSELISTENER_HPP
46
47 #include "guichan/mouseevent.hpp"
48 #include "guichan/platform.hpp"
49
50 namespace gcn
51 {
52 /**
53 * Interface for listening for mouse events from widgets.
54 *
55 * @see Widget::addMouseListener, Widget::removeMouseListener
56 * @since 0.1.0
57 */
58 class GCN_CORE_DECLSPEC MouseListener
59 {
60 public:
61
62 /**
63 * Destructor.
64 */
65 virtual ~MouseListener() { }
66
67 /**
68 * Called when the mouse has entered into the widget area.
69 *
70 * @param mouseEvent Describes the event.
71 * @since 0.6.0
72 */
73 virtual void mouseEntered(MouseEvent& mouseEvent)
74 {
75
76 }
77
78 /**
79 * Called when the mouse has exited the widget area.
80 *
81 * @param mouseEvent Describes the event.
82 * @since 0.6.0
83 */
84 virtual void mouseExited(MouseEvent& mouseEvent)
85 {
86
87 }
88
89 /**
90 * Called when a mouse button has been pressed on the widget area.
91 *
92 * NOTE: A mouse press is NOT equal to a mouse click.
93 * Use mouseClickMessage to check for mouse clicks.
94 *
95 * @param mouseEvent Describes the event.
96 * @since 0.6.0
97 */
98 virtual void mousePressed(MouseEvent& mouseEvent)
99 {
100
101 }
102
103 /**
104 * Called when a mouse button has been released on the widget area.
105 *
106 * @param mouseEvent Describes the event.
107 * @since 0.6.0
108 */
109 virtual void mouseReleased(MouseEvent& mouseEvent)
110 {
111
112 }
113
114 /**
115 * Called when a mouse button is pressed and released (clicked) on
116 * the widget area.
117 *
118 * @param mouseEvent Describes the event.
119 * @since 0.6.0
120 */
121 virtual void mouseClicked(MouseEvent& mouseEvent)
122 {
123
124 }
125
126 /**
127 * Called when the mouse wheel has moved up on the widget area.
128 *
129 * @param mouseEvent Describes the event.
130 * @since 0.6.0
131 */
132 virtual void mouseWheelMovedUp(MouseEvent& mouseEvent)
133 {
134
135 }
136
137 /**
138 * Called when the mouse wheel has moved down on the widget area.
139 *
140 * @param mousEvent Describes the event.
141 * @since 0.6.0
142 */
143 virtual void mouseWheelMovedDown(MouseEvent& mouseEvent)
144 {
145
146 }
147
148 /**
149 * Called when the mouse has moved in the widget area and no mouse button
150 * has been pressed (i.e no widget is being dragged).
151 *
152 * @param mouseEvent Describes the event.
153 * @since 0.6.0
154 */
155 virtual void mouseMoved(MouseEvent& mouseEvent)
156 {
157
158 }
159
160 /**
161 * Called when the mouse has moved and the mouse has previously been
162 * pressed on the widget.
163 *
164 * @param mouseEvent Describes the event.
165 * @since 0.6.0
166 */
167 virtual void mouseDragged(MouseEvent& mouseEvent)
168 {
169
170 }
171
172 protected:
173 /**
174 * Constructor.
175 *
176 * You should not be able to make an instance of MouseListener,
177 * therefore its constructor is protected.
178 */
179 MouseListener() { }
180 };
181 }
182
183 #endif // end GCN_MOUSELISTENER_HPP