KiCad PCB EDA Suite
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 
30 #define EESCHEMA_HOTKEY_NAME wxT( "Eeschema" )
31 #define PCBNEW_HOTKEY_NAME wxT( "PcbNew" )
32 
33 // A define to allow translation of Hot Key message Info in hotkey help menu
34 // We do not want to use the _( x ) usual macro from wxWidgets, which calls wxGetTranslation(),
35 // because the English string is used in key file configuration
36 // The translated string is used only when displaying the help window.
37 // Therefore translation tools have to use the "_" and the "_HKI" prefix to extract
38 // strings to translate
39 #include <i18n_utility.h> // _HKI definition
40 
41 class TOOL_ACTION;
42 class TOOL_MANAGER;
43 class EDA_BASE_FRAME;
44 
45 
46 /*
47  * Keep these out of the ASCII range, and out of the WXK range
48  */
49 #define PSEUDO_WXK_CLICK 400
50 #define PSEUDO_WXK_DBLCLICK 401
51 #define PSEUDO_WXK_WHEEL 402
52 
56 int KeyCodeFromKeyName( const wxString& keyname );
57 
64 wxString KeyNameFromKeyCode( int aKeycode, bool* aIsFound = nullptr );
65 
75 {
78 };
79 
86 wxString AddHotkeyName( const wxString& aText, int aHotKey,
87  HOTKEY_ACTION_TYPE aStyle = IS_HOTKEY);
88 
96 void DisplayHotkeyList( EDA_BASE_FRAME* aFrame, TOOL_MANAGER* aToolMgr );
97 
103 void ReadHotKeyConfig( const wxString& aFileName, std::map<std::string, int>& aHotKeys );
104 
108 int WriteHotKeyConfig( const std::map<std::string, TOOL_ACTION*>& aActionMap );
109 
117 int ReadLegacyHotkeyConfigFile( const wxString& aFilename, std::map<std::string, int>& aMap );
118 
125 int ReadLegacyHotkeyConfig( const wxString& aAppname, std::map<std::string, int>& aMap );
126 
127 #endif // HOTKEYS_BASIC_H
int ReadLegacyHotkeyConfigFile(const wxString &aFilename, std::map< std::string, int > &aMap)
Read hotkey configuration for a given app.
int WriteHotKeyConfig(const std::map< std::string, TOOL_ACTION * > &aActionMap)
Update the hotkeys config file with the hotkeys from the given actions map.
wxString AddHotkeyName(const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle=IS_HOTKEY)
int ReadLegacyHotkeyConfig(const wxString &aAppname, std::map< std::string, int > &aMap)
Read configuration data and fill the current hotkey list with hotkeys.
Master controller class:
Definition: tool_manager.h:54
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound=nullptr)
Return the user friendly key name (ie: "Ctrl+M") from the key code.
void ReadHotKeyConfig(const wxString &aFileName, std::map< std::string, int > &aHotKeys)
Reads a hotkey config file into a map.
Some functions to handle hotkeys in KiCad.
int KeyCodeFromKeyName(const wxString &keyname)
Return the key code from its user-friendly key name (ie: "Ctrl+M").
The base frame for deriving all KiCad main window classes.
Represent a single user action.
Definition: tool_action.h:67
void DisplayHotkeyList(EDA_BASE_FRAME *aFrame, TOOL_MANAGER *aToolMgr)
Display the current hotkey list.
HOTKEY_ACTION_TYPE
In menus we can add a hot key, or an accelerator, or sometimes just a comment.
Definition: hotkeys_basic.h:74