Merging r39652 through r39842 from trunk into vgroup_modifiers.
[blender.git] / source / blender / windowmanager / WM_keymap.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2007 Blender Foundation.
21  * All rights reserved.
22  * 
23  * Contributor(s): Blender Foundation
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef WM_KEYMAP_H
29 #define WM_KEYMAP_H
30
31 /** \file WM_keymap.h
32  *  \ingroup wm
33  */
34
35 /* dna-savable wmStructs here */
36 #include "DNA_windowmanager_types.h"
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct EnumPropertyItem;
43
44 /* Key Configuration */
45
46 wmKeyConfig *WM_keyconfig_new   (struct wmWindowManager *wm, const char *idname);
47 wmKeyConfig *WM_keyconfig_new_user(struct wmWindowManager *wm, const char *idname);
48 void            WM_keyconfig_remove     (struct wmWindowManager *wm, struct wmKeyConfig *keyconf);
49 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
50
51 void            WM_keyconfig_set_active(struct wmWindowManager *wm, const char *idname);
52
53 void            WM_keyconfig_update(struct wmWindowManager *wm);
54 void            WM_keyconfig_update_tag(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
55
56 /* Keymap */
57
58 void            WM_keymap_init          (struct bContext *C);
59 void            WM_keymap_free          (struct wmKeyMap *keymap);
60
61 wmKeyMapItem *WM_keymap_verify_item(struct wmKeyMap *keymap, const char *idname, int type, 
62                                                                  int val, int modifier, int keymodifier);
63 wmKeyMapItem *WM_keymap_add_item(struct wmKeyMap *keymap, const char *idname, int type, 
64                                                                  int val, int modifier, int keymodifier);
65 wmKeyMapItem *WM_keymap_add_menu(struct wmKeyMap *keymap, const char *idname, int type,
66                                                                  int val, int modifier, int keymodifier);
67
68 void            WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
69 char             *WM_keymap_item_to_string(wmKeyMapItem *kmi, char *str, int len);
70
71 wmKeyMap        *WM_keymap_list_find(ListBase *lb, const char *idname, int spaceid, int regionid);
72 wmKeyMap        *WM_keymap_find(struct wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
73 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, const char *idname, int spaceid, int regionid);
74 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
75 wmKeyMap        *WM_keymap_guess_opname(const struct bContext *C, const char *opname);
76
77 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
78 int                     WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
79
80 /* Modal Keymap */
81
82 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, const char *idname, struct EnumPropertyItem *items);
83 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, const char *idname);
84 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
85 void            WM_modalkeymap_assign(struct wmKeyMap *km, const char *opname);
86
87 /* Keymap Editor */
88
89 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap, struct bContext *C);
90 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi, struct IDProperty *properties);
91 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
92
93 /* Key Event */
94
95 const char      *WM_key_event_string(short type);
96 int                     WM_key_event_operator_id(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, int hotkey, struct wmKeyMap **keymap_r);
97 char            *WM_key_event_operator_string(const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties, char *str, int len);
98
99 #ifdef __cplusplus
100 }
101 #endif
102
103 #endif /* WM_KEYMAP_H */
104