GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/events/keyevent.h Lines: 0 6 0.0 %
Date: 2018-09-20 Branches: 0 0 0.0 %

Line Branch Exec Source
1
/*
2
 *  The ManaPlus Client
3
 *  Copyright (C) 2011-2018  The ManaPlus Developers
4
 *
5
 *  This file is part of The ManaPlus Client.
6
 *
7
 *  This program is free software; you can redistribute it and/or modify
8
 *  it under the terms of the GNU General Public License as published by
9
 *  the Free Software Foundation; either version 2 of the License, or
10
 *  any later version.
11
 *
12
 *  This program is distributed in the hope that it will be useful,
13
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 *  GNU General Public License for more details.
16
 *
17
 *  You should have received a copy of the GNU General Public License
18
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 */
20
21
/*      _______   __   __   __   ______   __   __   _______   __   __
22
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
23
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
24
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
25
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
26
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
27
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
28
 *
29
 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
30
 *
31
 *
32
 * Per Larsson a.k.a finalman
33
 * Olof Naessén a.k.a jansem/yakslem
34
 *
35
 * Visit: http://guichan.sourceforge.net
36
 *
37
 * License: (BSD)
38
 * Redistribution and use in source and binary forms, with or without
39
 * modification, are permitted provided that the following conditions
40
 * are met:
41
 * 1. Redistributions of source code must retain the above copyright
42
 *    notice, this list of conditions and the following disclaimer.
43
 * 2. Redistributions in binary form must reproduce the above copyright
44
 *    notice, this list of conditions and the following disclaimer in
45
 *    the documentation and/or other materials provided with the
46
 *    distribution.
47
 * 3. Neither the name of Guichan nor the names of its contributors may
48
 *    be used to endorse or promote products derived from this software
49
 *    without specific prior written permission.
50
 *
51
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
57
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
58
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
59
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
60
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
61
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62
 */
63
64
#ifndef EVENTS_KEYEVENT_H
65
#define EVENTS_KEYEVENT_H
66
67
#include "enums/events/keyeventtype.h"
68
69
#include "enums/input/inputaction.h"
70
71
#include "events/inputguievent.h"
72
73
#include "input/key.h"
74
75
#ifdef USE_SDL2
76
#include <string>
77
#endif  // USE_SDL2
78
79
class Widget;
80
81
/**
82
  * Represents a key event.
83
  */
84
class KeyEvent final : public InputGuiEvent
85
{
86
    public:
87
        /**
88
          * Constructor.
89
          *
90
          * @param source The source widget of the event.
91
          * @param type The type of the event. A value from KeyEventType.
92
          *                     false otherwise.
93
          * @param key The key of the event.
94
          */
95
        KeyEvent(Widget *const source,
96
                 KeyEventTypeT type,
97
                 const InputActionT actionId,
98
                 const Key &key) :
99
            InputGuiEvent(source),
100
            mKey(key),
101
#ifdef USE_SDL2
102
            mText(),
103
#endif  // USE_SDL2
104
            mType(type),
105
            mActionId(actionId)
106
        { }
107
108
        A_DELETE_COPY(KeyEvent)
109
110
        /**
111
          * Gets the type of the event.
112
          *
113
          * @return The type of the event.
114
          */
115
        KeyEventTypeT getType() const noexcept2 A_WARN_UNUSED
116
        { return mType; }
117
118
        /**
119
          * Gets the key of the event.
120
          *
121
          * @return The key of the event.
122
          */
123
        const Key &getKey() const noexcept2 A_WARN_UNUSED
124
        { return mKey; }
125
126
        InputActionT getActionId() const noexcept2 A_WARN_UNUSED
127
        { return mActionId; }
128
129
#ifdef USE_SDL2
130
        void setText(const std::string &text)
131
        { mText = text; }
132
133
        std::string getText() const
134
        { return mText; }
135
#endif  // USE_SDL2
136
137
    protected:
138
        /**
139
          * Holds the key of the key event.
140
          */
141
        Key mKey;
142
143
#ifdef USE_SDL2
144
        std::string mText;
145
#endif  // USE_SDL2
146
147
        /**
148
          * Holds the type of the key event.
149
          */
150
        KeyEventTypeT mType;
151
152
        InputActionT mActionId;
153
};
154
155
#endif  // EVENTS_KEYEVENT_H