hotkeys_basic.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004-2021 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
 
int KeyCodeFromKeyName( const wxString& keyname );
 
wxString KeyNameFromKeyCode( int aKeycode, bool* aIsFound = nullptr );
 
enum HOTKEY_ACTION_TYPE
{
    IS_HOTKEY,
    IS_COMMENT
};
 
wxString AddHotkeyName(  const wxString& aText, int aHotKey,
                         HOTKEY_ACTION_TYPE aStyle = IS_HOTKEY);
 
void DisplayHotkeyList( EDA_BASE_FRAME* aFrame );
 
void ReadHotKeyConfig( const wxString&                             aFileName,
                       std::map<std::string, std::pair<int, int>>& aHotKeys );
 
void ReadHotKeyConfigIntoActions( const wxString& aFileName, std::vector<TOOL_ACTION*>& aActions );
 
int WriteHotKeyConfig( const std::vector<TOOL_ACTION*>& aActions );
 
int ReadLegacyHotkeyConfigFile( const wxString& aFilename, std::map<std::string, int>& aMap );
 
int ReadLegacyHotkeyConfig( const wxString& aAppname, std::map<std::string, int>& aMap );
 
#endif // HOTKEYS_BASIC_H