Blender V5.3
WM_keymap.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2007 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include <optional>
12#include <string>
13
15#include "WM_types.hh"
16
17namespace blender {
18
19#ifdef hyper /* MSVC defines. */
20# undef hyper
21#endif
22
23struct EnumPropertyItem;
24
25/* Key Configuration. */
26
29
30wmKeyConfig *WM_keyconfig_new(wmWindowManager *wm, const char *idname, bool user_defined);
31wmKeyConfig *WM_keyconfig_ensure(wmWindowManager *wm, const char *idname, bool user_defined);
33void WM_keyconfig_clear(wmKeyConfig *keyconf);
34void WM_keyconfig_free(wmKeyConfig *keyconf);
35
36void WM_keyconfig_set_active(wmWindowManager *wm, const char *idname);
37
43void WM_keyconfig_update_ex(wmWindowManager *wm, bool keep_properties);
48
51
54
56
81
86#define KMI_PARAMS_MOD_TO_ANY(mod) ((mod) << 8)
91#define KMI_PARAMS_MOD_FROM_ANY(mod) ((mod) >> 8)
92
93void WM_keymap_clear(wmKeyMap *keymap);
94
98wmKeyMapItem *WM_keymap_add_item(wmKeyMap *keymap,
99 const char *idname,
100 const KeyMapItem_Params *params);
101wmKeyMapItem *WM_keymap_add_item_copy(wmKeyMap *keymap, const wmKeyMapItem *kmi_src);
102
103void WM_keymap_remove_item(wmKeyMap *keymap, wmKeyMapItem *kmi);
104std::optional<std::string> WM_keymap_item_to_string(const wmKeyMapItem *kmi, bool compact);
105
106wmKeyMap *WM_keymap_list_find(ListBaseT<wmKeyMap> *lb,
107 const char *idname,
108 int spaceid,
109 int regionid);
110wmKeyMap *WM_keymap_list_find_spaceid_or_empty(ListBaseT<wmKeyMap> *lb,
111 const char *idname,
112 int spaceid,
113 int regionid);
114wmKeyMap *WM_keymap_ensure(wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
115wmKeyMap *WM_keymap_find_all(wmWindowManager *wm, const char *idname, int spaceid, int regionid);
116wmKeyMap *WM_keymap_find_all_spaceid_or_empty(wmWindowManager *wm,
117 const char *idname,
118 int spaceid,
119 int regionid);
120wmKeyMap *WM_keymap_active(const wmWindowManager *wm, wmKeyMap *keymap);
121void WM_keymap_remove(wmKeyConfig *keyconf, wmKeyMap *keymap);
122bool WM_keymap_poll(bContext *C, wmKeyMap *keymap);
123
124wmKeyMapItem *WM_keymap_item_find_id(wmKeyMap *keymap, int id);
125bool WM_keymap_item_compare(const wmKeyMapItem *k1, const wmKeyMapItem *k2);
126
132wmKeyMapItem *WM_keymap_item_find_match(wmKeyMap *km_base,
133 wmKeyMap *km_match,
134 const wmKeyMapItem *kmi_match,
135 ReportList *reports);
136
137/* `wm_keymap_utils.cc`. */
138
139/* Wrappers for #WM_keymap_add_item. */
140
144wmKeyMapItem *WM_keymap_add_menu(wmKeyMap *keymap,
145 const char *idname,
146 const KeyMapItem_Params *params);
150wmKeyMapItem *WM_keymap_add_menu_pie(wmKeyMap *keymap,
151 const char *idname,
152 const KeyMapItem_Params *params);
156wmKeyMapItem *WM_keymap_add_panel(wmKeyMap *keymap,
157 const char *idname,
158 const KeyMapItem_Params *params);
162wmKeyMapItem *WM_keymap_add_tool(wmKeyMap *keymap,
163 const char *idname,
164 const KeyMapItem_Params *params);
165
166wmKeyMap *WM_keymap_guess_from_context(const bContext *C);
167
173wmKeyMap *WM_keymap_guess_opname(const bContext *C, const char *opname);
174
175bool WM_keymap_uses_event_modifier(const wmKeyMap *keymap, int event_modifier);
176
178
179/* Modal Keymap. */
180
181std::optional<std::string> WM_modalkeymap_items_to_string(const wmKeyMap *km,
182 int propvalue,
183 bool compact);
184std::optional<std::string> WM_modalkeymap_operator_items_to_string(wmOperatorType *ot,
185 int propvalue,
186 bool compact);
187
188wmKeyMap *WM_modalkeymap_ensure(wmKeyConfig *keyconf,
189 const char *idname,
190 const EnumPropertyItem *items);
191wmKeyMap *WM_modalkeymap_find(wmKeyConfig *keyconf, const char *idname);
192wmKeyMapItem *WM_modalkeymap_add_item(wmKeyMap *km, const KeyMapItem_Params *params, int value);
193wmKeyMapItem *WM_modalkeymap_add_item_str(wmKeyMap *km,
194 const KeyMapItem_Params *params,
195 const char *value);
196const wmKeyMapItem *WM_modalkeymap_find_propvalue(const wmKeyMap *km, int propvalue);
197void WM_modalkeymap_assign(wmKeyMap *km, const char *opname);
198
199/* Keymap Editor. */
200
201void WM_keymap_restore_to_default(wmKeyMap *keymap, wmWindowManager *wm);
205void WM_keymap_item_properties_reset(wmKeyMapItem *kmi, IDProperty *properties);
206void WM_keymap_item_restore_to_default(wmWindowManager *wm, wmKeyMap *keymap, wmKeyMapItem *kmi);
207int WM_keymap_item_map_type_get(const wmKeyMapItem *kmi);
208
209/* Key Event. */
210
211const char *WM_key_event_string(short type, bool compact);
212std::optional<std::string> WM_keymap_item_raw_to_string(int8_t shift,
213 int8_t ctrl,
214 int8_t alt,
215 int8_t oskey,
216 int8_t hyper,
217 short keymodifier,
218 short val,
219 short type,
220 bool compact);
225wmKeyMapItem *WM_key_event_operator(const bContext *C,
226 const char *opname,
227 wm::OpCallContext opcontext,
228 IDProperty *properties,
229 short include_mask,
230 short exclude_mask,
231 wmKeyMap **r_keymap);
232std::optional<std::string> WM_key_event_operator_string(const bContext *C,
233 const char *opname,
234 wm::OpCallContext opcontext,
235 IDProperty *properties,
236 bool is_strict);
237
238wmKeyMapItem *WM_key_event_operator_from_keymap(wmKeyMap *keymap,
239 const char *opname,
240 IDProperty *properties,
241 short include_mask,
242 short exclude_mask);
243
244const char *WM_bool_as_string(bool test);
245
246} // namespace blender
#define C
Definition RandGen.cpp:29
BMesh Iterators.
wmKeyConfig * WM_keyconfig_ensure(wmWindowManager *wm, const char *idname, bool user_defined)
Definition wm_keymap.cc:310
void WM_keymap_item_properties_reset(wmKeyMapItem *kmi, IDProperty *properties)
Definition wm_keymap.cc:210
wmKeyMap * WM_keymap_active(const wmWindowManager *wm, wmKeyMap *keymap)
wmKeyMap * WM_keymap_list_find_spaceid_or_empty(ListBaseT< wmKeyMap > *lb, const char *idname, int spaceid, int regionid)
Definition wm_keymap.cc:919
const wmKeyMapItem * WM_modalkeymap_find_propvalue(const wmKeyMap *km, const int propvalue)
wmKeyMap * WM_keymap_find_all(wmWindowManager *wm, const char *idname, int spaceid, int regionid)
Definition wm_keymap.cc:949
wmKeyMapItem * WM_keymap_item_find_id(wmKeyMap *keymap, const int id)
void WM_keyconfig_update_postpone_begin()
wmKeyMap * WM_modalkeymap_find(wmKeyConfig *keyconf, const char *idname)
Definition wm_keymap.cc:999
wmKeyMapItem * WM_modalkeymap_add_item(wmKeyMap *km, const KeyMapItem_Params *params, int value)
bool WM_keymap_poll(bContext *C, wmKeyMap *keymap)
Definition wm_keymap.cc:485
void WM_keymap_remove(wmKeyConfig *keyconf, wmKeyMap *keymap)
Definition wm_keymap.cc:477
wmKeyMapItem * WM_keymap_add_tool(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
std::optional< std::string > WM_keymap_item_raw_to_string(const int8_t shift, const int8_t ctrl, const int8_t alt, const int8_t oskey, const int8_t hyper, const short keymodifier, const short val, const short type, const bool compact)
wmKeyMapItem * WM_key_event_operator_from_keymap(wmKeyMap *keymap, const char *opname, IDProperty *properties, const short include_mask, const short exclude_mask)
const char * WM_bool_as_string(bool test)
void WM_keymap_fix_linking()
void WM_keyconfig_update(wmWindowManager *wm)
wmKeyMap * WM_keymap_guess_opname(const bContext *C, const char *opname)
void WM_keyconfig_update_operatortype_tag()
std::optional< std::string > WM_key_event_operator_string(const bContext *C, const char *opname, wm::OpCallContext opcontext, IDProperty *properties, const bool is_strict)
void WM_keyconfig_init(bContext *C)
Definition wm.cc:454
void WM_keymap_clear(wmKeyMap *keymap)
Definition wm_keymap.cc:461
wmKeyMapItem * WM_keymap_add_item(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
Definition wm_keymap.cc:563
wmKeyMapItem * WM_keymap_item_find_match(wmKeyMap *km_base, wmKeyMap *km_match, const wmKeyMapItem *kmi_match, ReportList *reports)
const char * WM_key_event_string(const short type, const bool compact)
wmKeyMapItem * WM_keymap_add_menu(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
void WM_keyconfig_reload(bContext *C)
Definition wm.cc:444
bool WM_keymap_item_compare(const wmKeyMapItem *k1, const wmKeyMapItem *k2)
void WM_keymap_item_restore_to_default(wmWindowManager *wm, wmKeyMap *keymap, wmKeyMapItem *kmi)
wmKeyMapItem * WM_keymap_add_item_copy(wmKeyMap *keymap, const wmKeyMapItem *kmi_src)
Definition wm_keymap.cc:582
void WM_keyconfig_set_active(wmWindowManager *wm, const char *idname)
Definition wm_keymap.cc:386
void WM_keyconfig_update_on_startup(wmWindowManager *wm)
wmKeyMap * WM_keymap_ensure(wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid)
Definition wm_keymap.cc:935
int WM_keymap_item_map_type_get(const wmKeyMapItem *kmi)
Definition wm_keymap.cc:227
void WM_keyconfig_update_suppress_begin()
wmKeyMapItem * WM_key_event_operator(const bContext *C, const char *opname, wm::OpCallContext opcontext, IDProperty *properties, const short include_mask, const short exclude_mask, wmKeyMap **r_keymap)
std::optional< std::string > WM_keymap_item_to_string(const wmKeyMapItem *kmi, const bool compact)
void WM_keyconfig_free(wmKeyConfig *keyconf)
Definition wm_keymap.cc:365
wmKeyMap * WM_keymap_list_find(ListBaseT< wmKeyMap > *lb, const char *idname, int spaceid, int regionid)
Definition wm_keymap.cc:903
void WM_keyconfig_remove(wmWindowManager *wm, wmKeyConfig *keyconf)
Definition wm_keymap.cc:333
void WM_keymap_restore_to_default(wmKeyMap *keymap, wmWindowManager *wm)
void WM_keyconfig_update_suppress_end()
wmKeyMapItem * WM_keymap_add_panel(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
void WM_modalkeymap_assign(wmKeyMap *km, const char *opname)
void WM_keyconfig_clear(wmKeyConfig *keyconf)
Definition wm_keymap.cc:355
wmKeyMap * WM_modalkeymap_ensure(wmKeyConfig *keyconf, const char *idname, const EnumPropertyItem *items)
Definition wm_keymap.cc:972
void WM_keyconfig_update_postpone_end()
void WM_keyconfig_update_tag(wmKeyMap *keymap, wmKeyMapItem *kmi)
bool WM_keymap_uses_event_modifier(const wmKeyMap *keymap, const int event_modifier)
std::optional< std::string > WM_modalkeymap_operator_items_to_string(wmOperatorType *ot, const int propvalue, const bool compact)
wmKeyMapItem * WM_modalkeymap_add_item_str(wmKeyMap *km, const KeyMapItem_Params *params, const char *value)
std::optional< std::string > WM_modalkeymap_items_to_string(const wmKeyMap *km, const int propvalue, const bool compact)
wmKeyConfig * WM_keyconfig_new(wmWindowManager *wm, const char *idname, bool user_defined)
Definition wm_keymap.cc:295
wmKeyMapItem * WM_keymap_add_menu_pie(wmKeyMap *keymap, const char *idname, const KeyMapItem_Params *params)
void WM_keymap_remove_item(wmKeyMap *keymap, wmKeyMapItem *kmi)
Definition wm_keymap.cc:595
void WM_keyconfig_update_ex(wmWindowManager *wm, bool keep_properties)
wmKeyMap * WM_keymap_find_all_spaceid_or_empty(wmWindowManager *wm, const char *idname, int spaceid, int regionid)
Definition wm_keymap.cc:954
wmKeyMap * WM_keymap_guess_from_context(const bContext *C)
signed char int8_t
Definition BKE_text.h:76
signed short int16_t
Definition BKE_text.h:77