#include <kiface_base.h>
#include <hotkeys_basic.h>
#include <id.h>
#include <string_utils.h>
#include <eda_base_frame.h>
#include <eda_draw_frame.h>
#include <wildcards_and_files_ext.h>
#include <paths.h>
#include <tool/tool_manager.h>
#include "dialogs/dialog_hotkey_list.h"
#include <wx/apptrait.h>
#include <wx/stdpaths.h>
#include <wx/tokenzr.h>
#include <wx/txtstrm.h>
#include <wx/wfstream.h>
#include <tool/tool_action.h>

Classes
struct	hotkey_name_descr

Macros
#define	KEY_NON_FOUND -1

#define	MODIFIER_CTRL wxT( "Ctrl+" )

#define	MODIFIER_ALT wxT( "Alt+" )

#define	MODIFIER_CMD_MAC wxT( "Cmd+" )

#define	MODIFIER_CTRL_BASE wxT( "Ctrl+" )

#define	MODIFIER_SHIFT wxT( "Shift+" )

Functions
wxString	KeyNameFromKeyCode (int aKeycode, bool *aIsFound)
	Return the key name from the key code.

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

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

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

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

void	ReadHotKeyConfigIntoActions (const wxString &aFileName, std::vector< TOOL_ACTION * > &aActions)
	Read 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	ReadLegacyHotkeyConfig (const wxString &aAppname, std::map< std::string, int > &aMap)
	Read configuration data and fill the current hotkey list with hotkeys.

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

Variables
static struct hotkey_name_descr	hotkeyNameList []

Macro Definition Documentation

◆ KEY_NON_FOUND

#define KEY_NON_FOUND -1

Definition at line 63 of file hotkeys_basic.cpp.

◆ MODIFIER_ALT

#define MODIFIER_ALT wxT( "Alt+" )

Definition at line 157 of file hotkeys_basic.cpp.

◆ MODIFIER_CMD_MAC

#define MODIFIER_CMD_MAC wxT( "Cmd+" )

Definition at line 159 of file hotkeys_basic.cpp.

◆ MODIFIER_CTRL

#define MODIFIER_CTRL wxT( "Ctrl+" )

Definition at line 156 of file hotkeys_basic.cpp.

◆ MODIFIER_CTRL_BASE

#define MODIFIER_CTRL_BASE wxT( "Ctrl+" )

Definition at line 160 of file hotkeys_basic.cpp.

◆ MODIFIER_SHIFT

#define MODIFIER_SHIFT wxT( "Shift+" )

Definition at line 161 of file hotkeys_basic.cpp.

Function Documentation

◆ AddHotkeyName()

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

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.

Definition at line 223 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 324 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 261 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 BOOST_AUTO_TEST_CASE(), ReadHotKeyConfig(), ReadLegacyHotkeyConfigFile(), and WIDGET_HOTKEY_LIST::WIDGET_HOTKEY_LIST().

◆ KeyNameFromKeyCode()

wxString KeyNameFromKeyCode	(	int	aKeycode,
		bool *	aIsFound = `nullptr`
	)

Return the key name 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).