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