a9c64e5d68c50e176b5337a5b18016c95096f499
[vlc.git] / include / vlc_keys.h
1 /*****************************************************************************
2  * vlc_keys.h: keycode defines
3  *****************************************************************************
4  * Copyright (C) 2003-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef VLC_KEYS_H
25 #define VLC_KEYS_H 1
26
27 /**
28  * \file
29  * This file defines keys and functions
30  */
31
32 #define KEY_MODIFIER         0xFF000000
33 #define KEY_MODIFIER_ALT     0x01000000
34 #define KEY_MODIFIER_SHIFT   0x02000000
35 #define KEY_MODIFIER_CTRL    0x04000000
36 #define KEY_MODIFIER_META    0x08000000
37 #define KEY_MODIFIER_COMMAND 0x10000000
38
39 #define KEY_UNSET            0x00000000
40 /* End of Unicode range:     0x0010FFFF */
41 #define KEY_LEFT             0x00210000
42 #define KEY_RIGHT            0x00220000
43 #define KEY_UP               0x00230000
44 #define KEY_DOWN             0x00240000
45 #define KEY_ENTER            0x00260000
46 #define KEY_F1               0x00270000
47 #define KEY_F2               0x00280000
48 #define KEY_F3               0x00290000
49 #define KEY_F4               0x002A0000
50 #define KEY_F5               0x002B0000
51 #define KEY_F6               0x002C0000
52 #define KEY_F7               0x002D0000
53 #define KEY_F8               0x002E0000
54 #define KEY_F9               0x002F0000
55 #define KEY_F10              0x00300000
56 #define KEY_F11              0x00310000
57 #define KEY_F12              0x00320000
58 #define KEY_HOME             0x00330000
59 #define KEY_END              0x00340000
60 #define KEY_INSERT           0x00350000
61 #define KEY_DELETE           0x00360000
62 #define KEY_MENU             0x00370000
63 #define KEY_ESC              0x00380000
64 #define KEY_PAGEUP           0x00390000
65 #define KEY_PAGEDOWN         0x003A0000
66 #define KEY_TAB              0x003B0000
67 #define KEY_BACKSPACE        0x003C0000
68
69 #define KEY_BROWSER_BACK     0x003F0000
70 #define KEY_BROWSER_FORWARD  0x00400000
71 #define KEY_BROWSER_REFRESH  0x00410000
72 #define KEY_BROWSER_STOP     0x00420000
73 #define KEY_BROWSER_SEARCH   0x00430000
74 #define KEY_BROWSER_FAVORITES 0x00440000
75 #define KEY_BROWSER_HOME     0x00450000
76 #define KEY_VOLUME_MUTE      0x00460000
77 #define KEY_VOLUME_DOWN      0x00470000
78 #define KEY_VOLUME_UP        0x00480000
79 #define KEY_MEDIA_NEXT_TRACK 0x00490000
80 #define KEY_MEDIA_PREV_TRACK 0x004A0000
81 #define KEY_MEDIA_STOP       0x004B0000
82 #define KEY_MEDIA_PLAY_PAUSE 0x004C0000
83
84 #define KEY_MOUSEWHEELUP     0x00F00000
85 #define KEY_MOUSEWHEELDOWN   0x00F10000
86 #define KEY_MOUSEWHEELLEFT   0x00F20000
87 #define KEY_MOUSEWHEELRIGHT  0x00F30000
88
89 VLC_EXPORT( char *, KeyToString, (uint_fast32_t i_key) ) LIBVLC_USED;
90 VLC_EXPORT( uint_fast32_t, StringToKey,  (char *psz_key) ) LIBVLC_USED;
91
92 typedef enum vlc_key {
93     ACTIONID_QUIT = 1,
94     ACTIONID_PLAY_PAUSE,
95     ACTIONID_PLAY,
96     ACTIONID_PAUSE,
97     ACTIONID_STOP,
98     ACTIONID_PREV,
99     ACTIONID_NEXT,
100     ACTIONID_SLOWER,
101     ACTIONID_FASTER,
102     ACTIONID_TOGGLE_FULLSCREEN,
103     ACTIONID_VOL_UP,
104     ACTIONID_VOL_DOWN,
105     ACTIONID_NAV_ACTIVATE,
106     ACTIONID_NAV_UP,
107     ACTIONID_NAV_DOWN,
108     ACTIONID_NAV_LEFT,
109     ACTIONID_NAV_RIGHT,
110     ACTIONID_JUMP_BACKWARD_EXTRASHORT,
111     ACTIONID_JUMP_FORWARD_EXTRASHORT,
112     ACTIONID_JUMP_BACKWARD_SHORT,
113     ACTIONID_JUMP_FORWARD_SHORT,
114     ACTIONID_JUMP_BACKWARD_MEDIUM,
115     ACTIONID_JUMP_FORWARD_MEDIUM,
116     ACTIONID_JUMP_BACKWARD_LONG,
117     ACTIONID_JUMP_FORWARD_LONG,
118     ACTIONID_FRAME_NEXT,
119     ACTIONID_POSITION,
120     ACTIONID_VOL_MUTE,
121 /* let ACTIONID_SET_BOOMARK* and ACTIONID_PLAY_BOOKMARK* be contiguous */
122     ACTIONID_SET_BOOKMARK1,
123     ACTIONID_SET_BOOKMARK2,
124     ACTIONID_SET_BOOKMARK3,
125     ACTIONID_SET_BOOKMARK4,
126     ACTIONID_SET_BOOKMARK5,
127     ACTIONID_SET_BOOKMARK6,
128     ACTIONID_SET_BOOKMARK7,
129     ACTIONID_SET_BOOKMARK8,
130     ACTIONID_SET_BOOKMARK9,
131     ACTIONID_SET_BOOKMARK10,
132     ACTIONID_PLAY_BOOKMARK1,
133     ACTIONID_PLAY_BOOKMARK2,
134     ACTIONID_PLAY_BOOKMARK3,
135     ACTIONID_PLAY_BOOKMARK4,
136     ACTIONID_PLAY_BOOKMARK5,
137     ACTIONID_PLAY_BOOKMARK6,
138     ACTIONID_PLAY_BOOKMARK7,
139     ACTIONID_PLAY_BOOKMARK8,
140     ACTIONID_PLAY_BOOKMARK9,
141     ACTIONID_PLAY_BOOKMARK10,
142     /* end of contiguous zone */
143     ACTIONID_SUBDELAY_UP,
144     ACTIONID_SUBDELAY_DOWN,
145     ACTIONID_SUBPOS_UP,
146     ACTIONID_SUBPOS_DOWN,
147     ACTIONID_HISTORY_BACK,
148     ACTIONID_HISTORY_FORWARD,
149     ACTIONID_AUDIO_TRACK,
150     ACTIONID_SUBTITLE_TRACK,
151     ACTIONID_CUBESPEED_UP,
152     ACTIONID_CUBESPEED_DOWN,
153     ACTIONID_INTF_SHOW,
154     ACTIONID_INTF_HIDE,
155     /* chapter and title navigation */
156     ACTIONID_TITLE_PREV,
157     ACTIONID_TITLE_NEXT,
158     ACTIONID_CHAPTER_PREV,
159     ACTIONID_CHAPTER_NEXT,
160     /* end of chapter and title navigation */
161     ACTIONID_AUDIODELAY_UP,
162     ACTIONID_AUDIODELAY_DOWN,
163     ACTIONID_SNAPSHOT,
164     ACTIONID_RECORD,
165     ACTIONID_DISC_MENU,
166     ACTIONID_ASPECT_RATIO,
167     ACTIONID_CROP,
168     ACTIONID_DEINTERLACE,
169     ACTIONID_ZOOM,
170     ACTIONID_UNZOOM,
171     ACTIONID_CROP_TOP,
172     ACTIONID_UNCROP_TOP,
173     ACTIONID_CROP_LEFT,
174     ACTIONID_UNCROP_LEFT,
175     ACTIONID_CROP_BOTTOM,
176     ACTIONID_UNCROP_BOTTOM,
177     ACTIONID_CROP_RIGHT,
178     ACTIONID_UNCROP_RIGHT,
179     ACTIONID_DUMP,
180     ACTIONID_RANDOM,
181     ACTIONID_LOOP,
182     ACTIONID_WALLPAPER,
183     ACTIONID_LEAVE_FULLSCREEN,
184     ACTIONID_MENU_ON,
185     ACTIONID_MENU_OFF,
186     ACTIONID_MENU_RIGHT,
187     ACTIONID_MENU_LEFT,
188     ACTIONID_MENU_UP,
189     ACTIONID_MENU_DOWN,
190     ACTIONID_MENU_SELECT,
191     /* Zoom */
192     ACTIONID_ZOOM_QUARTER,
193     ACTIONID_ZOOM_HALF,
194     ACTIONID_ZOOM_ORIGINAL,
195     ACTIONID_ZOOM_DOUBLE,
196     /* Cycle Through Audio Devices */
197     ACTIONID_AUDIODEVICE_CYCLE,
198     /* scaling */
199     ACTIONID_TOGGLE_AUTOSCALE,
200     ACTIONID_SCALE_UP,
201     ACTIONID_SCALE_DOWN,
202     /* */
203     ACTIONID_RATE_NORMAL,
204     ACTIONID_RATE_SLOWER_FINE,
205     ACTIONID_RATE_FASTER_FINE,
206
207 } vlc_key_t;
208 #endif