e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
199 lines
7.9 KiB
C++
199 lines
7.9 KiB
C++
/* SPDX-FileCopyrightText: 2007 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup wm
|
|
*/
|
|
|
|
#include "BLI_utildefines.h"
|
|
#include "DNA_windowmanager_types.h"
|
|
#include "WM_types.hh"
|
|
|
|
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_new_user(wmWindowManager *wm, const char *idname);
|
|
bool 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(wmWindowManager *wm);
|
|
void WM_keyconfig_update_tag(wmKeyMap *keymap, wmKeyMapItem *kmi);
|
|
void WM_keyconfig_update_operatortype();
|
|
|
|
/* Keymap */
|
|
|
|
/** Parameters for matching events, passed into functions that create key-map items. */
|
|
struct KeyMapItem_Params {
|
|
/** #wmKeyMapItem.type */
|
|
int16_t type;
|
|
/** #wmKeyMapItem.val */
|
|
int8_t value;
|
|
/** #wmKeyMapItem `ctrl, shift, alt, oskey` */
|
|
int8_t modifier;
|
|
/** #wmKeyMapItem.keymodifier */
|
|
int16_t keymodifier;
|
|
/** #wmKeyMapItem.direction */
|
|
int8_t direction;
|
|
};
|
|
|
|
void WM_keymap_clear(wmKeyMap *keymap);
|
|
|
|
/**
|
|
* Always add item.
|
|
*/
|
|
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);
|
|
|
|
bool WM_keymap_remove_item(wmKeyMap *keymap, wmKeyMapItem *kmi);
|
|
int WM_keymap_item_to_string(const wmKeyMapItem *kmi,
|
|
bool compact,
|
|
char *result,
|
|
int result_maxncpy);
|
|
|
|
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);
|
|
bool WM_keymap_remove(wmKeyConfig *keyconfig, 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);
|
|
|
|
/* keymap_utils.c */
|
|
|
|
/* Wrappers for #WM_keymap_add_item */
|
|
|
|
/**
|
|
* Menu wrapper for #WM_keymap_add_item.
|
|
*/
|
|
wmKeyMapItem *WM_keymap_add_menu(wmKeyMap *keymap,
|
|
const char *idname,
|
|
const KeyMapItem_Params *params);
|
|
/**
|
|
* Pie-menu wrapper for #WM_keymap_add_item.
|
|
*/
|
|
wmKeyMapItem *WM_keymap_add_menu_pie(wmKeyMap *keymap,
|
|
const char *idname,
|
|
const KeyMapItem_Params *params);
|
|
/**
|
|
* Panel (popover) wrapper for #WM_keymap_add_item.
|
|
*/
|
|
wmKeyMapItem *WM_keymap_add_panel(wmKeyMap *keymap,
|
|
const char *idname,
|
|
const KeyMapItem_Params *params);
|
|
/**
|
|
* Tool wrapper for #WM_keymap_add_item.
|
|
*/
|
|
wmKeyMapItem *WM_keymap_add_tool(wmKeyMap *keymap,
|
|
const char *idname,
|
|
const KeyMapItem_Params *params);
|
|
|
|
wmKeyMap *WM_keymap_guess_from_context(const bContext *C);
|
|
|
|
/**
|
|
* Guess an appropriate key-map from the operator name.
|
|
*
|
|
* \note Needs to be kept up to date with Key-map and Operator naming.
|
|
*/
|
|
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 */
|
|
|
|
int WM_modalkeymap_items_to_string(
|
|
const wmKeyMap *km, int propvalue, bool compact, char *result, int result_maxncpy);
|
|
int WM_modalkeymap_operator_items_to_string(
|
|
wmOperatorType *ot, int propvalue, bool compact, char *result, int result_maxncpy);
|
|
char *WM_modalkeymap_operator_items_to_string_buf(wmOperatorType *ot,
|
|
int propvalue,
|
|
bool compact,
|
|
int result_maxncpy,
|
|
int *r_available_len,
|
|
char **r_result);
|
|
|
|
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);
|
|
/**
|
|
* Properties can be NULL, otherwise the arg passed is used and ownership is given to the `kmi`.
|
|
*/
|
|
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);
|
|
int WM_keymap_item_raw_to_string(short shift,
|
|
short ctrl,
|
|
short alt,
|
|
short oskey,
|
|
short keymodifier,
|
|
short val,
|
|
short type,
|
|
bool compact,
|
|
char *result,
|
|
int result_maxncpy);
|
|
/**
|
|
* \param include_mask, exclude_mask:
|
|
* Event types to include/exclude when looking up keys (#eEventType_Mask).
|
|
*/
|
|
wmKeyMapItem *WM_key_event_operator(const bContext *C,
|
|
const char *opname,
|
|
wmOperatorCallContext opcontext,
|
|
IDProperty *properties,
|
|
short include_mask,
|
|
short exclude_mask,
|
|
wmKeyMap **r_keymap);
|
|
char *WM_key_event_operator_string(const bContext *C,
|
|
const char *opname,
|
|
wmOperatorCallContext opcontext,
|
|
IDProperty *properties,
|
|
bool is_strict,
|
|
char *result,
|
|
int result_maxncpy);
|
|
|
|
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);
|