Documentation of SFML 2.3.2

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
Keyboard.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_KEYBOARD_HPP
26 #define SFML_KEYBOARD_HPP
27 
29 // Headers
31 #include <SFML/Window/Export.hpp>
32 
33 
34 namespace sf
35 {
40 class SFML_WINDOW_API Keyboard
41 {
42 public:
43 
48  enum Key
49  {
50  Unknown = -1,
51  A = 0,
52  B,
53  C,
54  D,
55  E,
56  F,
57  G,
58  H,
59  I,
60  J,
61  K,
62  L,
63  M,
64  N,
65  O,
66  P,
67  Q,
68  R,
69  S,
70  T,
71  U,
72  V,
73  W,
74  X,
75  Y,
76  Z,
77  Num0,
78  Num1,
79  Num2,
80  Num3,
81  Num4,
82  Num5,
83  Num6,
84  Num7,
85  Num8,
86  Num9,
90  LAlt,
94  RAlt,
96  Menu,
111  Tab,
114  End,
118  Add,
124  Up,
136  F1,
137  F2,
138  F3,
139  F4,
140  F5,
141  F6,
142  F7,
143  F8,
144  F9,
145  F10,
146  F11,
147  F12,
148  F13,
149  F14,
150  F15,
152 
153  KeyCount
154  };
155 
164  static bool isKeyPressed(Key key);
165 
179  static void setVirtualKeyboardVisible(bool visible);
180 };
181 
182 } // namespace sf
183 
184 
185 #endif // SFML_KEYBOARD_HPP
186 
187 
The F13 key.
Definition: Keyboard.hpp:148
The End key.
Definition: Keyboard.hpp:114
The numpad 3 key.
Definition: Keyboard.hpp:129
The N key.
Definition: Keyboard.hpp:64
The F5 key.
Definition: Keyboard.hpp:140
The Return key.
Definition: Keyboard.hpp:109
The right OS specific key: window (Windows and Linux), apple (MacOS X), ...
Definition: Keyboard.hpp:95
The Backspace key.
Definition: Keyboard.hpp:110
The numpad 9 key.
Definition: Keyboard.hpp:135
The Home key.
Definition: Keyboard.hpp:115
The Y key.
Definition: Keyboard.hpp:75
The F9 key.
Definition: Keyboard.hpp:144
The M key.
Definition: Keyboard.hpp:63
The Space key.
Definition: Keyboard.hpp:108
The left Alt key.
Definition: Keyboard.hpp:90
Down arrow.
Definition: Keyboard.hpp:125
The numpad 1 key.
Definition: Keyboard.hpp:127
The F14 key.
Definition: Keyboard.hpp:149
The numpad 0 key.
Definition: Keyboard.hpp:126
The numpad 5 key.
Definition: Keyboard.hpp:131
The - key.
Definition: Keyboard.hpp:107
The U key.
Definition: Keyboard.hpp:71
The left Control key.
Definition: Keyboard.hpp:88
The left OS specific key: window (Windows and Linux), apple (MacOS X), ...
Definition: Keyboard.hpp:91
The + key.
Definition: Keyboard.hpp:118
Key
Key codes.
Definition: Keyboard.hpp:48
The F10 key.
Definition: Keyboard.hpp:145
The Page down key.
Definition: Keyboard.hpp:113
The numpad 2 key.
Definition: Keyboard.hpp:128
The V key.
Definition: Keyboard.hpp:72
The O key.
Definition: Keyboard.hpp:65
The T key.
Definition: Keyboard.hpp:70
The F6 key.
Definition: Keyboard.hpp:141
The right Control key.
Definition: Keyboard.hpp:92
The numpad 7 key.
Definition: Keyboard.hpp:133
The Insert key.
Definition: Keyboard.hpp:116
The Page up key.
Definition: Keyboard.hpp:112
The 8 key.
Definition: Keyboard.hpp:85
The F4 key.
Definition: Keyboard.hpp:139
The F7 key.
Definition: Keyboard.hpp:142
The J key.
Definition: Keyboard.hpp:60
The F8 key.
Definition: Keyboard.hpp:143
The numpad 8 key.
Definition: Keyboard.hpp:134
The G key.
Definition: Keyboard.hpp:57
The R key.
Definition: Keyboard.hpp:68
The F11 key.
Definition: Keyboard.hpp:146
The Q key.
Definition: Keyboard.hpp:67
The F3 key.
Definition: Keyboard.hpp:138
The D key.
Definition: Keyboard.hpp:54
The F2 key.
Definition: Keyboard.hpp:137
Right arrow.
Definition: Keyboard.hpp:123
The 6 key.
Definition: Keyboard.hpp:83
Give access to the real-time state of the keyboard.
Definition: Keyboard.hpp:40
The W key.
Definition: Keyboard.hpp:73
The 0 key.
Definition: Keyboard.hpp:77
The F key.
Definition: Keyboard.hpp:56
The Z key.
Definition: Keyboard.hpp:76
The right Alt key.
Definition: Keyboard.hpp:94
The numpad 6 key.
Definition: Keyboard.hpp:132
Up arrow.
Definition: Keyboard.hpp:124
The L key.
Definition: Keyboard.hpp:62
The 4 key.
Definition: Keyboard.hpp:81
The F1 key.
Definition: Keyboard.hpp:136
The H key.
Definition: Keyboard.hpp:58
The Escape key.
Definition: Keyboard.hpp:87
The C key.
Definition: Keyboard.hpp:53
The I key.
Definition: Keyboard.hpp:59
The F15 key.
Definition: Keyboard.hpp:150
The S key.
Definition: Keyboard.hpp:69
The F12 key.
Definition: Keyboard.hpp:147
The 1 key.
Definition: Keyboard.hpp:78
The 9 key.
Definition: Keyboard.hpp:86
The numpad 4 key.
Definition: Keyboard.hpp:130
The K key.
Definition: Keyboard.hpp:61
The left Shift key.
Definition: Keyboard.hpp:89
The Menu key.
Definition: Keyboard.hpp:96
The Delete key.
Definition: Keyboard.hpp:117
The 5 key.
Definition: Keyboard.hpp:82
The right Shift key.
Definition: Keyboard.hpp:93
The 3 key.
Definition: Keyboard.hpp:80
The P key.
Definition: Keyboard.hpp:66
The Tabulation key.
Definition: Keyboard.hpp:111
The B key.
Definition: Keyboard.hpp:52
The 2 key.
Definition: Keyboard.hpp:79
The 7 key.
Definition: Keyboard.hpp:84
The Pause key.
Definition: Keyboard.hpp:151
Left arrow.
Definition: Keyboard.hpp:122
The X key.
Definition: Keyboard.hpp:74
The E key.
Definition: Keyboard.hpp:55