WM: add keymap.find_from_operator(...)
[blender.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 blender/windowmanager/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 void            WM_keyconfig_init       (struct bContext *C);
46 void            WM_keyconfig_reload     (struct bContext *C);
47
48 wmKeyConfig *WM_keyconfig_new   (struct wmWindowManager *wm, const char *idname, bool user_defined);
49 wmKeyConfig *WM_keyconfig_new_user(struct wmWindowManager *wm, const char *idname);
50 bool        WM_keyconfig_remove (struct wmWindowManager *wm, struct wmKeyConfig *keyconf);
51 void            WM_keyconfig_clear      (struct wmKeyConfig *keyconf);
52 void            WM_keyconfig_free       (struct wmKeyConfig *keyconf);
53
54 void            WM_keyconfig_set_active(struct wmWindowManager *wm, const char *idname);
55
56 void            WM_keyconfig_update(struct wmWindowManager *wm);
57 void            WM_keyconfig_update_tag(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
58 void        WM_keyconfig_update_operatortype(void);
59
60 /* Keymap */
61
62 void            WM_keymap_clear         (struct wmKeyMap *keymap);
63
64 wmKeyMapItem *WM_keymap_verify_item(
65         struct wmKeyMap *keymap, const char *idname, int type,
66         int val, int modifier, int keymodifier);
67 wmKeyMapItem *WM_keymap_add_item(
68         struct wmKeyMap *keymap, const char *idname, int type,
69         int val, int modifier, int keymodifier);
70 wmKeyMapItem *WM_keymap_add_item_copy(
71         struct wmKeyMap *keymap, wmKeyMapItem *kmi_src);
72
73 bool        WM_keymap_remove_item(struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
74 int         WM_keymap_item_to_string(wmKeyMapItem *kmi, const bool compact, char *result, const int result_len);
75
76 wmKeyMap        *WM_keymap_list_find(ListBase *lb, const char *idname, int spaceid, int regionid);
77 wmKeyMap        *WM_keymap_list_find_spaceid_or_empty(ListBase *lb, const char *idname, int spaceid, int regionid);
78 wmKeyMap        *WM_keymap_ensure(struct wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
79 wmKeyMap        *WM_keymap_find_all(const struct bContext *C, const char *idname, int spaceid, int regionid);
80 wmKeyMap        *WM_keymap_find_all_spaceid_or_empty(const struct bContext *C, const char *idname, int spaceid, int regionid);
81 wmKeyMap        *WM_keymap_active(struct wmWindowManager *wm, struct wmKeyMap *keymap);
82 bool             WM_keymap_remove(struct wmKeyConfig *keyconfig, struct wmKeyMap *keymap);
83 bool         WM_keymap_poll(struct bContext *C, struct wmKeyMap *keymap);
84
85 wmKeyMapItem *WM_keymap_item_find_id(struct wmKeyMap *keymap, int id);
86 bool          WM_keymap_item_compare(struct wmKeyMapItem *k1, struct wmKeyMapItem *k2);
87
88 /* keymap_utils.c */
89
90 /** Wrappers for #WM_keymap_add_item */
91 wmKeyMapItem *WM_keymap_add_menu(
92         struct wmKeyMap *keymap, const char *idname, int type,
93         int val, int modifier, int keymodifier);
94 wmKeyMapItem *WM_keymap_add_menu_pie(
95         struct wmKeyMap *keymap, const char *idname, int type,
96         int val, int modifier, int keymodifier);
97 wmKeyMapItem *WM_keymap_add_panel(
98         struct wmKeyMap *keymap, const char *idname, int type,
99         int val, int modifier, int keymodifier);
100 wmKeyMapItem *WM_keymap_add_tool(
101         struct wmKeyMap *keymap, const char *idname, int type,
102         int val, int modifier, int keymodifier);
103
104 void WM_keymap_add_context_enum_set_items(
105         wmKeyMap *keymap, const struct EnumPropertyItem *items, const char *data_path,
106         int type_start, int val, int modifier, int keymodifier);
107
108 wmKeyMap *WM_keymap_guess_from_context(const struct bContext *C);
109 wmKeyMap *WM_keymap_guess_opname(const struct bContext *C, const char *opname);
110
111 void WM_keymap_fix_linking(void);
112
113 /* Modal Keymap */
114
115 int WM_modalkeymap_items_to_string(
116         struct wmKeyMap *km, const int propvalue, const bool compact,
117         char *result, const int result_len);
118 int WM_modalkeymap_operator_items_to_string(
119         struct wmOperatorType *ot, const int propvalue, const bool compact,
120         char *result, const int result_len);
121 char *WM_modalkeymap_operator_items_to_string_buf(
122         struct wmOperatorType *ot, const int propvalue, const bool compact,
123         const int max_len, int *r_available_len, char **r_result);
124
125 wmKeyMap        *WM_modalkeymap_add(struct wmKeyConfig *keyconf, const char *idname, const struct EnumPropertyItem *items);
126 wmKeyMap        *WM_modalkeymap_get(struct wmKeyConfig *keyconf, const char *idname);
127 wmKeyMapItem *WM_modalkeymap_add_item(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, int value);
128 wmKeyMapItem *WM_modalkeymap_add_item_str(struct wmKeyMap *km, int type, int val, int modifier, int keymodifier, const char *value);
129 wmKeyMapItem *WM_modalkeymap_find_propvalue(wmKeyMap *km, const int propvalue);
130 void            WM_modalkeymap_assign(struct wmKeyMap *km, const char *opname);
131
132 /* Keymap Editor */
133
134 void            WM_keymap_restore_to_default(struct wmKeyMap *keymap, struct bContext *C);
135 void            WM_keymap_properties_reset(struct wmKeyMapItem *kmi, struct IDProperty *properties);
136 void            WM_keymap_restore_item_to_default(struct bContext *C, struct wmKeyMap *keymap, struct wmKeyMapItem *kmi);
137 int                     WM_keymap_map_type_get(struct wmKeyMapItem *kmi);
138
139 /* Key Event */
140
141 const char *WM_key_event_string(const short type, const bool compact);
142 int WM_keymap_item_raw_to_string(
143         const short shift, const short ctrl, const short alt, const short oskey, const short keymodifier,
144         const short val, const short type, const bool compact,
145         char *result, const int result_len);
146 wmKeyMapItem *WM_key_event_operator(
147         const struct bContext *C, const char *opname, int opcontext, struct IDProperty *properties,
148         const short include_mask, const short exclude_mask,
149         struct wmKeyMap **r_keymap);
150 char *WM_key_event_operator_string(
151         const struct bContext *C, const char *opname, int opcontext,
152         struct IDProperty *properties, const bool is_strict,
153         char *result, const int result_len);
154
155 wmKeyMapItem *WM_key_event_operator_from_keymap(
156         struct wmKeyMap *keymap, const char *opname, struct IDProperty *properties,
157         const short include_mask, const short exclude_mask);
158
159 const char *WM_bool_as_string(bool test);
160
161 #ifdef __cplusplus
162 }
163 #endif
164
165 #endif /* __WM_KEYMAP_H__ */