mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-15 02:33:15 +02:00
0b2d4d4879
Recommendation is to avoid using the year nomenclature as this information is already encoded in the git repo. Avoids needing to repeatly update. Also updates AUTHORS.txt from current repo with contributor names
137 lines
4.7 KiB
C++
137 lines
4.7 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
#ifndef HOTKEYS_BASIC_H
|
|
#define HOTKEYS_BASIC_H
|
|
|
|
#include <wx/string.h>
|
|
#include <map>
|
|
#include <vector>
|
|
|
|
#define EESCHEMA_HOTKEY_NAME wxT( "Eeschema" )
|
|
#define PCBNEW_HOTKEY_NAME wxT( "PcbNew" )
|
|
|
|
// A define to allow translation of Hot Key message Info in hotkey help menu
|
|
// We do not want to use the _( x ) usual macro from wxWidgets, which calls wxGetTranslation(),
|
|
// because the English string is used in key file configuration
|
|
// The translated string is used only when displaying the help window.
|
|
// Therefore translation tools have to use the "_" and the "_HKI" prefix to extract
|
|
// strings to translate
|
|
#include <i18n_utility.h> // _HKI definition
|
|
|
|
class TOOL_ACTION;
|
|
class TOOL_MANAGER;
|
|
class EDA_BASE_FRAME;
|
|
|
|
|
|
/*
|
|
* Keep these out of the ASCII range, and out of the WXK range
|
|
*/
|
|
#define PSEUDO_WXK_CLICK 400
|
|
#define PSEUDO_WXK_DBLCLICK 401
|
|
#define PSEUDO_WXK_WHEEL 402
|
|
|
|
/**
|
|
* Return the key code from its user-friendly key name (ie: "Ctrl+M").
|
|
*/
|
|
int KeyCodeFromKeyName( const wxString& keyname );
|
|
|
|
/**
|
|
* Return the user friendly key name (ie: "Ctrl+M") from the key code.
|
|
*
|
|
* @param aKeycode key code (ASCII value, or wxWidgets value for function keys).
|
|
* @param aIsFound a pointer to a bool to return true if found, or false.
|
|
*/
|
|
wxString KeyNameFromKeyCode( int aKeycode, bool* aIsFound = nullptr );
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
enum HOTKEY_ACTION_TYPE
|
|
{
|
|
IS_HOTKEY,
|
|
IS_COMMENT
|
|
};
|
|
|
|
/**
|
|
* @param aText the base text on which to append the hotkey.
|
|
* @param aHotKey the hotkey keycode.
|
|
* @param aStyle #IS_HOTKEY to add <tab><keyname> (shortcuts in menus, same as hotkeys).
|
|
* #IS_COMMENT to add <spaces><(keyname)> mainly in tool tips.
|
|
*/
|
|
wxString AddHotkeyName( const wxString& aText, int aHotKey,
|
|
HOTKEY_ACTION_TYPE aStyle = IS_HOTKEY);
|
|
|
|
/**
|
|
* Display the current hotkey list.
|
|
*
|
|
* @param aFrame current active frame.
|
|
* @param aToolMgr the tool manager holding the registered actions from which the hotkeys
|
|
* will be harvested.
|
|
*/
|
|
void DisplayHotkeyList( EDA_BASE_FRAME* aFrame );
|
|
|
|
/**
|
|
* Reads a hotkey config file into a map.
|
|
*
|
|
* If \a aFileName is empty it will read in the default hotkeys file.
|
|
*/
|
|
void ReadHotKeyConfig( const wxString& aFileName,
|
|
std::map<std::string, std::pair<int, int>>& aHotKeys );
|
|
|
|
/**
|
|
* Reads a hotkey config file into a list of actions
|
|
*
|
|
* If \a aFileName is empty it will read in the default hotkeys file.
|
|
*/
|
|
void ReadHotKeyConfigIntoActions( const wxString& aFileName, std::vector<TOOL_ACTION*>& aActions );
|
|
|
|
/**
|
|
* Update the hotkeys config file with the hotkeys from the given actions map.
|
|
*/
|
|
int WriteHotKeyConfig( const std::vector<TOOL_ACTION*>& aActions );
|
|
|
|
/**
|
|
* Read hotkey configuration for a given app.
|
|
*
|
|
* @param aFilename the filename to save the hotkeys as.
|
|
* @param aMap The list of keycodes mapped by legacy property names.
|
|
* @return 1 on success, 0 on failure.
|
|
*/
|
|
int ReadLegacyHotkeyConfigFile( const wxString& aFilename, std::map<std::string, int>& aMap );
|
|
|
|
/**
|
|
* Read configuration data and fill the current hotkey list with hotkeys.
|
|
*
|
|
* @param aAppname the value of the app's m_FrameName.
|
|
* @param aMap The list of keycodes mapped by legacy property names.
|
|
*/
|
|
int ReadLegacyHotkeyConfig( const wxString& aAppname, std::map<std::string, int>& aMap );
|
|
|
|
#endif // HOTKEYS_BASIC_H
|