annotate dynamin/gui/key.d @ 103:73060bc3f004

Change license to Boost 1.0 and MPL 2.0.
author Jordan Miner <jminer7@gmail.com>
date Tue, 15 May 2012 22:06:02 -0500
parents 63ea570c8d7c
children acdbb30fee7e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
1
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
2 /*
103
73060bc3f004 Change license to Boost 1.0 and MPL 2.0.
Jordan Miner <jminer7@gmail.com>
parents: 71
diff changeset
3 * Copyright Jordan Miner
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
4 *
103
73060bc3f004 Change license to Boost 1.0 and MPL 2.0.
Jordan Miner <jminer7@gmail.com>
parents: 71
diff changeset
5 * This Source Code Form is subject to the terms of the Mozilla Public
73060bc3f004 Change license to Boost 1.0 and MPL 2.0.
Jordan Miner <jminer7@gmail.com>
parents: 71
diff changeset
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
73060bc3f004 Change license to Boost 1.0 and MPL 2.0.
Jordan Miner <jminer7@gmail.com>
parents: 71
diff changeset
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
8 *
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
9 */
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
10
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
11 module dynamin.gui.key;
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
12
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
13 import dynamin.core.string;
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
14
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
15 /**
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
16 * No Menu key is included because Shift+F10 is used instead.
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
17 * Note: Windows does not send KeyDown events for PrintScreen, only KeyUp.
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
18 */
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
19 enum Key {
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
20 None,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
21 Escape,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
22 Tab,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
23 Backspace,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
24 Enter,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
25 Space,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
26
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
27 Left,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
28 Right,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
29 Up,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
30 Down,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
31
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
32 Insert,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
33 Delete,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
34 Home,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
35 End,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
36 PageUp,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
37 PageDown,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
38
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
39 PrintScreen,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
40 Pause,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
41
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
42 CapsLock,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
43 NumLock,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
44 ScrollLock,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
45
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
46 NumPad0,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
47 NumPad1,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
48 NumPad2,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
49 NumPad3,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
50 NumPad4,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
51 NumPad5,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
52 NumPad6,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
53 NumPad7,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
54 NumPad8,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
55 NumPad9,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
56 NumPadDivide,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
57 NumPadMultiply,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
58 NumPadSubtract,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
59 NumPadAdd,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
60 NumPadDecimal, // TODO: NumPadPoint?
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
61
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
62 Backquote,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
63 Minus,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
64 Equals,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
65 OpenBracket,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
66 CloseBracket,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
67 Backslash,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
68 Semicolon,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
69 Quote,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
70 Comma,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
71 Period,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
72 Slash,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
73
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
74 /// Windows sends these messages when the Menu key is pressed and released:
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
75 /// Menu pressed, Menu released, Shift pressed, F10 pressed, F10 released, Shift released
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
76 /// So if any program responds to either Menu or Shift+F10, it will work right.
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
77 Menu, // right of spacebar, between WinKey and Ctrl
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
78
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
79 // digits
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
80 D0 = 0x30, D1, D2, D3, D4, D5, D6, D7, D8, D9 = 0x39,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
81 A = 0x41, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z = 0x5A,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
82 F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
83
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
84 VolumeUp,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
85 VolumeDown,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
86 VolumeMute,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
87
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
88 PlayPause,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
89 Stop,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
90 NextTrack,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
91 PrevTrack,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
92
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
93 Shift = 0x10000,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
94 Control = 0x20000,
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
95 Alt = 0x40000
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
96 }
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
97
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
98 const string[] keyStringTable = [
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
99 "None", "Escape", "Tab", "Backspace", "Enter", "Space",
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
100 "Left Arrow", "Right Arrow", "Up Arrow", "Down Arrow",
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
101 "Insert", "Delete", "Home", "End", "Page Up", "Page Down",
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
102 "Print Screen", "Pause",
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
103 "Caps Lock", "Num Lock", "Scroll Lock",
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
104 "NumPad0", "NumPad1", "NumPad2", "NumPad3", "NumPad4",
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
105 "NumPad5", "NumPad6", "NumPad7", "NumPad8", "NumPad9",
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
106 "NumPad/", "NumPad*", "NumPad-", "NumPad+", "NumPad.",
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
107 "`", "-", "=", "[", "]", "\\", ";", "'", ",", ".", "/", "Menu",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
108 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
109 "", "", "", "", "", "", "",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
110 "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
111 "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
112 "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
113 "Volume Up", "Volume Down", "Volume Mute",
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
114 "Play/Pause", "Stop", "Next Track", "Previous Track"
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
115 ];
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
116 string keyToString(Key key) {
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
117 if(key == Key.Shift)
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
118 return "Shift";
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
119 else if(key == Key.Control)
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
120 return "Ctrl";
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
121 else if(key == Key.Alt)
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
122 return "Alt";
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
123 return keyStringTable[key];
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
124 }
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
125 Key toKey(string str) {
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
126 if(!str)
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
127 return Key.None;
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
128 foreach(i, s; keyStringTable)
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
129 if(s == str)
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
130 return cast(Key)i;
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
131 return Key.None;
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
132 }
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
133 unittest {
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
134 assert(keyToString(Key.D0) == "0");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
135 assert(keyToString(Key.A) == "A");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
136 assert(keyToString(Key.N) == "N");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
137 assert(keyToString(Key.F1) == "F1");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
138 assert(keyToString(Key.Escape) == "Escape");
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
139 assert(keyToString(Key.Left) == "Left Arrow");
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
140 assert(keyToString(Key.Up) == "Up Arrow");
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
141 assert(keyToString(Key.Insert) == "Insert");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
142 assert(keyToString(Key.PrintScreen) == "Print Screen");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
143 assert(keyToString(Key.Pause) == "Pause");
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
144 assert(keyToString(Key.CapsLock) == "Caps Lock");
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
145 assert(keyToString(Key.NumPad0) == "NumPad0");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
146 assert(keyToString(Key.NumPad5) == "NumPad5");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
147 assert(keyToString(Key.NumPadDivide) == "NumPad/");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
148 assert(keyToString(Key.Backquote) == "`");
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
149 assert(keyToString(Key.Control) == "Ctrl");
71
63ea570c8d7c Add Key to string and string to Key conversion.
Jordan Miner <jminer7@gmail.com>
parents: 0
diff changeset
150 }
0
aa4efef0f0b1 Initial commit of code.
Jordan Miner <jminer7@gmail.com>
parents:
diff changeset
151