1 |
|
|
/* |
2 |
|
|
* The ManaPlus Client |
3 |
|
|
* Copyright (C) 2011-2019 The ManaPlus Developers |
4 |
|
|
* Copyright (C) 2019-2021 Andrei Karas |
5 |
|
|
* |
6 |
|
|
* This file is part of The ManaPlus Client. |
7 |
|
|
* |
8 |
|
|
* This program is free software; you can redistribute it and/or modify |
9 |
|
|
* it under the terms of the GNU General Public License as published by |
10 |
|
|
* the Free Software Foundation; either version 2 of the License, or |
11 |
|
|
* any later version. |
12 |
|
|
* |
13 |
|
|
* This program is distributed in the hope that it will be useful, |
14 |
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 |
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 |
|
|
* GNU General Public License for more details. |
17 |
|
|
* |
18 |
|
|
* You should have received a copy of the GNU General Public License |
19 |
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
20 |
|
|
*/ |
21 |
|
|
|
22 |
|
|
/* _______ __ __ __ ______ __ __ _______ __ __ |
23 |
|
|
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\ |
24 |
|
|
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / / |
25 |
|
|
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / / |
26 |
|
|
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / / |
27 |
|
|
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ / |
28 |
|
|
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/ |
29 |
|
|
* |
30 |
|
|
* Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson |
31 |
|
|
* |
32 |
|
|
* |
33 |
|
|
* Per Larsson a.k.a finalman |
34 |
|
|
* Olof Naessén a.k.a jansem/yakslem |
35 |
|
|
* |
36 |
|
|
* Visit: http://guichan.sourceforge.net |
37 |
|
|
* |
38 |
|
|
* License: (BSD) |
39 |
|
|
* Redistribution and use in source and binary forms, with or without |
40 |
|
|
* modification, are permitted provided that the following conditions |
41 |
|
|
* are met: |
42 |
|
|
* 1. Redistributions of source code must retain the above copyright |
43 |
|
|
* notice, this list of conditions and the following disclaimer. |
44 |
|
|
* 2. Redistributions in binary form must reproduce the above copyright |
45 |
|
|
* notice, this list of conditions and the following disclaimer in |
46 |
|
|
* the documentation and/or other materials provided with the |
47 |
|
|
* distribution. |
48 |
|
|
* 3. Neither the name of Guichan nor the names of its contributors may |
49 |
|
|
* be used to endorse or promote products derived from this software |
50 |
|
|
* without specific prior written permission. |
51 |
|
|
* |
52 |
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
53 |
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
54 |
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
55 |
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
56 |
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
57 |
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED |
58 |
|
|
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
59 |
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
60 |
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
61 |
|
|
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
62 |
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
63 |
|
|
*/ |
64 |
|
|
|
65 |
|
|
#ifndef EVENTS_INPUTGUIEVENT_H |
66 |
|
|
#define EVENTS_INPUTGUIEVENT_H |
67 |
|
|
|
68 |
|
|
#include "events/event.h" |
69 |
|
|
|
70 |
|
|
/** |
71 |
|
|
* Base class for all events concerning input. |
72 |
|
|
* |
73 |
|
|
* @author Olof Naessén |
74 |
|
|
*/ |
75 |
|
|
class InputGuiEvent notfinal : public Event |
76 |
|
|
{ |
77 |
|
|
public: |
78 |
|
|
/** |
79 |
|
|
* Constructor. |
80 |
|
|
* |
81 |
|
|
* @param source The source widget of the event. |
82 |
|
|
*/ |
83 |
|
|
explicit InputGuiEvent(Widget *const source) : |
84 |
|
|
Event(source), |
85 |
|
|
mIsConsumed(false) |
86 |
|
|
{ } |
87 |
|
|
|
88 |
|
|
A_DELETE_COPY(InputGuiEvent) |
89 |
|
|
|
90 |
|
|
/** |
91 |
|
|
* Marks the event as consumed. Input event listeners may discard |
92 |
|
|
* consumed input or act on consumed input. An example of a widget |
93 |
|
|
* that discards consumed input is the ScrollArea widget that |
94 |
|
|
* discards consumed mouse wheel events so the ScrollArea will not |
95 |
|
|
* scroll if for instance a Slider's value inside the ScrollArea was |
96 |
|
|
* changed with the mouse wheel. |
97 |
|
|
* |
98 |
|
|
* @see isConsumed |
99 |
|
|
*/ |
100 |
|
|
void consume() |
101 |
|
|
{ mIsConsumed = true; } |
102 |
|
|
|
103 |
|
|
/** |
104 |
|
|
* Checks if the input event is consumed. |
105 |
|
|
* |
106 |
|
|
* @return True if the input event is consumed, |
107 |
|
|
* false otherwise. |
108 |
|
|
* @see consume |
109 |
|
|
*/ |
110 |
|
|
bool isConsumed() const noexcept2 A_WARN_UNUSED |
111 |
|
|
{ return mIsConsumed; } |
112 |
|
|
|
113 |
|
|
protected: |
114 |
|
|
/** |
115 |
|
|
* True if the input event is consumed, |
116 |
|
|
* false otherwise. |
117 |
|
|
*/ |
118 |
|
|
bool mIsConsumed; |
119 |
|
|
}; |
120 |
|
|
|
121 |
|
|
#endif // EVENTS_INPUTGUIEVENT_H |