ManaPlus
keyevent.h
Go to the documentation of this file.
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_KEYEVENT_H
66 #define EVENTS_KEYEVENT_H
67 
69 
71 
72 #include "events/inputguievent.h"
73 
74 #include "input/key.h"
75 
76 #ifdef USE_SDL2
77 #include <string>
78 #endif // USE_SDL2
79 
80 class Widget;
81 
86 {
87  public:
96  KeyEvent(Widget *const source,
97  KeyEventTypeT type,
98  const InputActionT actionId,
99  const Key &key) :
100  InputGuiEvent(source),
101  mKey(key),
102 #ifdef USE_SDL2
103  mText(),
104 #endif // USE_SDL2
105  mType(type),
106  mActionId(actionId)
107  { }
108 
110 
111 
117  { return mType; }
118 
125  { return mKey; }
126 
128  { return mActionId; }
129 
130 #ifdef USE_SDL2
131  void setText(const std::string &text)
132  { mText = text; }
133 
134  std::string getText() const
135  { return mText; }
136 #endif // USE_SDL2
137 
138  protected:
143 
144 #ifdef USE_SDL2
145  std::string mText;
146 #endif // USE_SDL2
147 
152 
154 };
155 
156 #endif // EVENTS_KEYEVENT_H
Key mKey
Definition: keyevent.h:142
const Key & getKey() const
Definition: keyevent.h:124
KeyEventTypeT mType
Definition: keyevent.h:151
KeyEventTypeT getType() const
Definition: keyevent.h:116
KeyEvent(Widget *const source, KeyEventTypeT type, const InputActionT actionId, const Key &key)
Definition: keyevent.h:96
InputActionT mActionId
Definition: keyevent.h:153
InputActionT getActionId() const
Definition: keyevent.h:127
Definition: key.h:81
Definition: widget.h:99
InputAction ::T InputActionT
Definition: inputaction.h:717
KeyEventType ::T KeyEventTypeT
Definition: keyeventtype.h:75
#define A_WARN_UNUSED
Definition: localconsts.h:161
#define noexcept2
Definition: localconsts.h:50
#define final
Definition: localconsts.h:46
#define A_DELETE_COPY(func)
Definition: localconsts.h:53