#include <wx/string.h>
#include <map>
#include <vector>
#include <i18n_utility.h>

Macros
#define	EESCHEMA_HOTKEY_NAME wxT( "Eeschema" )

#define	PCBNEW_HOTKEY_NAME wxT( "PcbNew" )

#define	PSEUDO_WXK_CLICK 400

#define	PSEUDO_WXK_DBLCLICK 401

#define	PSEUDO_WXK_WHEEL 402

Enumerations
enum	HOTKEY_ACTION_TYPE { IS_HOTKEY , IS_COMMENT }
	In menus we can add a hot key, or an accelerator, or sometimes just a comment. More...

Functions
int	KeyCodeFromKeyName (const wxString &keyname)
	Return the key code from its user-friendly key name (ie: "Ctrl+M").

wxString	KeyNameFromKeyCode (int aKeycode, bool *aIsFound=nullptr)
	Return the user friendly key name (ie: "Ctrl+M") from the key code.

wxString	AddHotkeyName (const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle=IS_HOTKEY)

void	DisplayHotkeyList (EDA_BASE_FRAME *aFrame)
	Display the current hotkey list.

void	ReadHotKeyConfig (const wxString &aFileName, std::map< std::string, std::pair< int, int > > &aHotKeys)
	Reads a hotkey config file into a map.

void	ReadHotKeyConfigIntoActions (const wxString &aFileName, std::vector< TOOL_ACTION * > &aActions)
	Reads a hotkey config file into a list of actions.

int	WriteHotKeyConfig (const std::vector< TOOL_ACTION * > &aActions)
	Update the hotkeys config file with the hotkeys from the given actions map.

int	ReadLegacyHotkeyConfigFile (const wxString &aFilename, std::map< std::string, int > &aMap)
	Read hotkey configuration for a given app.

int	ReadLegacyHotkeyConfig (const wxString &aAppname, std::map< std::string, int > &aMap)
	Read configuration data and fill the current hotkey list with hotkeys.

Macro Definition Documentation

◆ EESCHEMA_HOTKEY_NAME

#define EESCHEMA_HOTKEY_NAME wxT( "Eeschema" )

Definition at line 31 of file hotkeys_basic.h.

◆ PCBNEW_HOTKEY_NAME

#define PCBNEW_HOTKEY_NAME wxT( "PcbNew" )

Definition at line 32 of file hotkeys_basic.h.

◆ PSEUDO_WXK_CLICK

#define PSEUDO_WXK_CLICK 400

Definition at line 50 of file hotkeys_basic.h.

◆ PSEUDO_WXK_DBLCLICK

#define PSEUDO_WXK_DBLCLICK 401

Definition at line 51 of file hotkeys_basic.h.

◆ PSEUDO_WXK_WHEEL

#define PSEUDO_WXK_WHEEL 402

Definition at line 52 of file hotkeys_basic.h.

Enumeration Type Documentation

◆ HOTKEY_ACTION_TYPE

enum HOTKEY_ACTION_TYPE

In menus we can add a hot key, or an accelerator, or sometimes just a comment.

Hot keys can perform actions using the current mouse cursor position and accelerators perform the same action as the associated menu.

A comment is used in tool tips for some tools (zoom ..) to show the hot key that performs this action

Enumerator
IS_HOTKEY
IS_COMMENT

Definition at line 75 of file hotkeys_basic.h.

Function Documentation

◆ AddHotkeyName()

wxString AddHotkeyName	(	const wxString &	aText,
		int	aHotKey,
		HOTKEY_ACTION_TYPE	aStyle
	)

Parameters

aText	the base text on which to append the hotkey.
aHotKey	the hotkey keycode.
aStyle	IS_HOTKEY to add <tab><keyname> (shortcuts in menus, same as hotkeys). IS_COMMENT to add <spaces><(keyname)> mainly in tool tips.
aText	the base text on which to append the hotkey.
aHotKey	the hotkey keycode.
aStyle	IS_HOTKEY to add <tab><keyname> (shortcuts in menus, same as hotkeys). IS_COMMENT to add <spaces><(keyname)> mainly in tool tips.

Definition at line 238 of file hotkeys_basic.cpp.

References IS_COMMENT, IS_HOTKEY, KeyNameFromKeyCode(), MODIFIER_CMD_MAC, and MODIFIER_CTRL_BASE.

Referenced by FOOTPRINT_DIFF_WIDGET::FOOTPRINT_DIFF_WIDGET(), PCB_ONE_LAYER_SELECTOR::getLayerHotKey(), TOOL_ACTION::GetMenuItem(), PCB_LAYER_BOX_SELECTOR::Resync(), and SYMBOL_DIFF_WIDGET::SYMBOL_DIFF_WIDGET().

◆ DisplayHotkeyList()

void DisplayHotkeyList ( EDA_BASE_FRAME * aFrame )

Display the current hotkey list.

Parameters

aFrame	current active frame.
aToolMgr	the tool manager holding the registered actions from which the hotkeys will be harvested.

Definition at line 345 of file hotkeys_basic.cpp.

References DIALOG_SHIM::ShowModal().

Referenced by COMMON_CONTROL::ListHotKeys().

◆ KeyCodeFromKeyName()

int KeyCodeFromKeyName ( const wxString & keyname )

Return the key code from its user-friendly key name (ie: "Ctrl+M").

Definition at line 279 of file hotkeys_basic.cpp.

References hotkeyNameList, KEY_NON_FOUND, hotkey_name_descr::m_KeyCode, hotkey_name_descr::m_Name, MD_ALT, MD_CTRL, MD_SHIFT, MODIFIER_ALT, MODIFIER_CMD_MAC, MODIFIER_CTRL_BASE, and MODIFIER_SHIFT.

Referenced by ReadHotKeyConfig(), ReadLegacyHotkeyConfigFile(), and WIDGET_HOTKEY_LIST::WIDGET_HOTKEY_LIST().

◆ KeyNameFromKeyCode()

wxString KeyNameFromKeyCode	(	int	aKeycode,
		bool *	aIsFound
	)

Return the user friendly key name (ie: "Ctrl+M") from the key code.

Parameters

aKeycode	key code (ASCII value, or wxWidgets value for function keys).
aIsFound	a pointer to a bool to return true if found, or false.

Return the user friendly key name (ie: "Ctrl+M") from the key code.

Only some wxWidgets key values are handled for function key ( see hotkeyNameList[] )

Parameters

aKeycode	key code (ASCII value, or wxWidgets value for function keys).
aIsFound	a pointer to a bool to return true if found, or false. an be nullptr default).