WM_keymap.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2007 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <optional>
#include <string>
 
#include "DNA_windowmanager_types.h"
#include "WM_types.hh"
 
#ifdef hyper /* MSVC defines. */
#  undef hyper
#endif
 
struct EnumPropertyItem;
 
/* Key Configuration. */
 
void WM_keyconfig_init(bContext *C);
void WM_keyconfig_reload(bContext *C);
 
wmKeyConfig *WM_keyconfig_new(wmWindowManager *wm, const char *idname, bool user_defined);
wmKeyConfig *WM_keyconfig_ensure(wmWindowManager *wm, const char *idname, bool user_defined);
void WM_keyconfig_remove(wmWindowManager *wm, wmKeyConfig *keyconf);
void WM_keyconfig_clear(wmKeyConfig *keyconf);
void WM_keyconfig_free(wmKeyConfig *keyconf);
 
void WM_keyconfig_set_active(wmWindowManager *wm, const char *idname);

void WM_keyconfig_update_ex(wmWindowManager *wm, bool keep_properties);
void WM_keyconfig_update(wmWindowManager *wm);
void WM_keyconfig_update_on_startup(wmWindowManager *wm);
void WM_keyconfig_update_tag(wmKeyMap *keymap, wmKeyMapItem *kmi);
void WM_keyconfig_update_operatortype_tag();
 
void WM_keyconfig_update_suppress_begin();
void WM_keyconfig_update_suppress_end();
 
void WM_keyconfig_update_postpone_begin();
void WM_keyconfig_update_postpone_end();


struct KeyMapItem_Params {
  int16_t type;
  int8_t value;
  int16_t modifier;

  int16_t keymodifier;
  int8_t direction;
};

#define KMI_PARAMS_MOD_TO_ANY(mod) ((mod) << 8)
#define KMI_PARAMS_MOD_FROM_ANY(mod) ((mod) >> 8)
 
void WM_keymap_clear(wmKeyMap *keymap);

wmKeyMapItem *WM_keymap_add_item(wmKeyMap *keymap,
                                 const char *idname,
                                 const KeyMapItem_Params *params);
wmKeyMapItem *WM_keymap_add_item_copy(wmKeyMap *keymap, wmKeyMapItem *kmi_src);
 
void WM_keymap_remove_item(wmKeyMap *keymap, wmKeyMapItem *kmi);
std::optional<std::string> WM_keymap_item_to_string(const wmKeyMapItem *kmi, bool compact);
 
wmKeyMap *WM_keymap_list_find(ListBase *lb, const char *idname, int spaceid, int regionid);
wmKeyMap *WM_keymap_list_find_spaceid_or_empty(ListBase *lb,
                                               const char *idname,
                                               int spaceid,
                                               int regionid);
wmKeyMap *WM_keymap_ensure(wmKeyConfig *keyconf, const char *idname, int spaceid, int regionid);
wmKeyMap *WM_keymap_find_all(wmWindowManager *wm, const char *idname, int spaceid, int regionid);
wmKeyMap *WM_keymap_find_all_spaceid_or_empty(wmWindowManager *wm,
                                              const char *idname,
                                              int spaceid,
                                              int regionid);
wmKeyMap *WM_keymap_active(const wmWindowManager *wm, wmKeyMap *keymap);
void WM_keymap_remove(wmKeyConfig *keyconf, wmKeyMap *keymap);
bool WM_keymap_poll(bContext *C, wmKeyMap *keymap);
 
wmKeyMapItem *WM_keymap_item_find_id(wmKeyMap *keymap, int id);
bool WM_keymap_item_compare(const wmKeyMapItem *k1, const wmKeyMapItem *k2);

wmKeyMapItem *WM_keymap_item_find_match(wmKeyMap *km_base,
                                        wmKeyMap *km_match,
                                        wmKeyMapItem *kmi_match,
                                        ReportList *reports);
 
/* `wm_keymap_utils.cc`. */
 
/* Wrappers for #WM_keymap_add_item. */

wmKeyMapItem *WM_keymap_add_menu(wmKeyMap *keymap,
                                 const char *idname,
                                 const KeyMapItem_Params *params);
wmKeyMapItem *WM_keymap_add_menu_pie(wmKeyMap *keymap,
                                     const char *idname,
                                     const KeyMapItem_Params *params);
wmKeyMapItem *WM_keymap_add_panel(wmKeyMap *keymap,
                                  const char *idname,
                                  const KeyMapItem_Params *params);
wmKeyMapItem *WM_keymap_add_tool(wmKeyMap *keymap,
                                 const char *idname,
                                 const KeyMapItem_Params *params);
 
wmKeyMap *WM_keymap_guess_from_context(const bContext *C);

wmKeyMap *WM_keymap_guess_opname(const bContext *C, const char *opname);
 
bool WM_keymap_uses_event_modifier(const wmKeyMap *keymap, int event_modifier);
 
void WM_keymap_fix_linking();
 
/* Modal Keymap. */
 
std::optional<std::string> WM_modalkeymap_items_to_string(const wmKeyMap *km,
                                                          int propvalue,
                                                          bool compact);
std::optional<std::string> WM_modalkeymap_operator_items_to_string(wmOperatorType *ot,
                                                                   int propvalue,
                                                                   bool compact);
 
wmKeyMap *WM_modalkeymap_ensure(wmKeyConfig *keyconf,
                                const char *idname,
                                const EnumPropertyItem *items);
wmKeyMap *WM_modalkeymap_find(wmKeyConfig *keyconf, const char *idname);
wmKeyMapItem *WM_modalkeymap_add_item(wmKeyMap *km, const KeyMapItem_Params *params, int value);
wmKeyMapItem *WM_modalkeymap_add_item_str(wmKeyMap *km,
                                          const KeyMapItem_Params *params,
                                          const char *value);
const wmKeyMapItem *WM_modalkeymap_find_propvalue(const wmKeyMap *km, int propvalue);
void WM_modalkeymap_assign(wmKeyMap *km, const char *opname);
 
/* Keymap Editor. */
 
void WM_keymap_restore_to_default(wmKeyMap *keymap, wmWindowManager *wm);
void WM_keymap_item_properties_reset(wmKeyMapItem *kmi, IDProperty *properties);
void WM_keymap_item_restore_to_default(wmWindowManager *wm, wmKeyMap *keymap, wmKeyMapItem *kmi);
int WM_keymap_item_map_type_get(const wmKeyMapItem *kmi);
 
/* Key Event. */
 
const char *WM_key_event_string(short type, bool compact);
std::optional<std::string> WM_keymap_item_raw_to_string(int8_t shift,
                                                        int8_t ctrl,
                                                        int8_t alt,
                                                        int8_t oskey,
                                                        int8_t hyper,
                                                        short keymodifier,
                                                        short val,
                                                        short type,
                                                        bool compact);
wmKeyMapItem *WM_key_event_operator(const bContext *C,
                                    const char *opname,
                                    blender::wm::OpCallContext opcontext,
                                    IDProperty *properties,
                                    short include_mask,
                                    short exclude_mask,
                                    wmKeyMap **r_keymap);
std::optional<std::string> WM_key_event_operator_string(const bContext *C,
                                                        const char *opname,
                                                        blender::wm::OpCallContext opcontext,
                                                        IDProperty *properties,
                                                        bool is_strict);
 
wmKeyMapItem *WM_key_event_operator_from_keymap(wmKeyMap *keymap,
                                                const char *opname,
                                                IDProperty *properties,
                                                short include_mask,
                                                short exclude_mask);
 
const char *WM_bool_as_string(bool test);