The Battle for Wesnoth  1.15.0+dev
key.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2018 by David White <dave@whitevine.net>
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #pragma once
16 
17 #include <cstdint>
18 #include <SDL2/SDL.h>
19 
20 /**
21  * Class that keeps track of all the keys on the keyboard.
22  * Whether any key is pressed or not can be found by using its
23  * operator[]. Note though that it is generally better to use
24  * key events to see when keys are pressed rather than to poll using
25  * this object.
26  */
27 class CKey
28 {
29  const uint8_t *key_list;
30 
31 public:
32  CKey();
33  bool operator[](int k) const;
34  static bool is_uncomposable(const SDL_KeyboardEvent &event);
35 };
bool operator[](int k) const
Definition: key.cpp:22
const uint8_t * key_list
Definition: key.hpp:29
static bool is_uncomposable(const SDL_KeyboardEvent &event)
Definition: key.cpp:27
CKey()
Definition: key.cpp:17
Class that keeps track of all the keys on the keyboard.
Definition: key.hpp:27