KiCad PCB EDA Suite
Loading...
Searching...
No Matches
hotkeys_basic.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2004-2021 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef HOTKEYS_BASIC_H
25#define HOTKEYS_BASIC_H
26
27#include <wx/string.h>
28#include <map>
29#include <vector>
30
31#define EESCHEMA_HOTKEY_NAME wxT( "Eeschema" )
32#define PCBNEW_HOTKEY_NAME wxT( "PcbNew" )
33
34// A define to allow translation of Hot Key message Info in hotkey help menu
35// We do not want to use the _( x ) usual macro from wxWidgets, which calls wxGetTranslation(),
36// because the English string is used in key file configuration
37// The translated string is used only when displaying the help window.
38// Therefore translation tools have to use the "_" and the "_HKI" prefix to extract
39// strings to translate
40#include <i18n_utility.h> // _HKI definition
41
42class TOOL_ACTION;
43class TOOL_MANAGER;
44class EDA_BASE_FRAME;
45
46
47/*
48 * Keep these out of the ASCII range, and out of the WXK range
49 */
50#define PSEUDO_WXK_CLICK 400
51#define PSEUDO_WXK_DBLCLICK 401
52#define PSEUDO_WXK_WHEEL 402
53
57int KeyCodeFromKeyName( const wxString& keyname );
58
65wxString KeyNameFromKeyCode( int aKeycode, bool* aIsFound = nullptr );
66
76{
79};
80
87wxString AddHotkeyName( const wxString& aText, int aHotKey,
89
97void DisplayHotkeyList( EDA_BASE_FRAME* aFrame );
98
104void ReadHotKeyConfig( const wxString& aFileName,
105 std::map<std::string, std::pair<int, int>>& aHotKeys );
106
112void ReadHotKeyConfigIntoActions( const wxString& aFileName, std::vector<TOOL_ACTION*>& aActions );
113
117int WriteHotKeyConfig( const std::vector<TOOL_ACTION*>& aActions );
118
126int ReadLegacyHotkeyConfigFile( const wxString& aFilename, std::map<std::string, int>& aMap );
127
134int ReadLegacyHotkeyConfig( const wxString& aAppname, std::map<std::string, int>& aMap );
135
136#endif // HOTKEYS_BASIC_H
The base frame for deriving all KiCad main window classes.
Represent a single user action.
Definition: tool_action.h:269
Master controller class:
Definition: tool_manager.h:62
void DisplayHotkeyList(EDA_BASE_FRAME *aFrame)
Display the current hotkey list.
int ReadLegacyHotkeyConfigFile(const wxString &aFilename, std::map< std::string, int > &aMap)
Read hotkey configuration for a given app.
void ReadHotKeyConfig(const wxString &aFileName, std::map< std::string, std::pair< int, int > > &aHotKeys)
Reads a hotkey config file into a map.
wxString AddHotkeyName(const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle=IS_HOTKEY)
HOTKEY_ACTION_TYPE
In menus we can add a hot key, or an accelerator, or sometimes just a comment.
Definition: hotkeys_basic.h:76
@ IS_HOTKEY
Definition: hotkeys_basic.h:77
@ IS_COMMENT
Definition: hotkeys_basic.h:78
int ReadLegacyHotkeyConfig(const wxString &aAppname, std::map< std::string, int > &aMap)
Read configuration data and fill the current hotkey list with hotkeys.
int WriteHotKeyConfig(const std::vector< TOOL_ACTION * > &aActions)
Update the hotkeys config file with the hotkeys from the given actions map.
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.
void ReadHotKeyConfigIntoActions(const wxString &aFileName, std::vector< TOOL_ACTION * > &aActions)
Reads a hotkey config file into a list of actions.
Some functions to handle hotkeys in KiCad.