 * KIWAY Milestone A): Make major modules into DLL/DSOs.
! The initial testing of this commit should be done using a Debug build so that
all the wxASSERT()s are enabled. Also, be sure and keep enabled the
USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it
off is senseless anyways. If you want stable code, go back to a prior version,
the one tagged with "stable".
* Relocate all functionality out of the wxApp derivative into more finely
targeted purposes:
a) DLL/DSO specific
b) PROJECT specific
c) EXE or process specific
d) configuration file specific data
e) configuration file manipulations functions.
All of this functionality was blended into an extremely large wxApp derivative
and that was incompatible with the desire to support multiple concurrently
loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects.
An amazing amount of organization come from simply sorting each bit of
functionality into the proper box.
* Switch to wxConfigBase from wxConfig everywhere except instantiation.
* Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD,
PGM_SINGLE_TOP,
* Remove "Return" prefix on many function names.
* Remove obvious comments from CMakeLists.txt files, and from else() and endif()s.
* Fix building boost for use in a DSO on linux.
* Remove some of the assumptions in the CMakeLists.txt files that windows had
to be the host platform when building windows binaries.
* Reduce the number of wxStrings being constructed at program load time via
static construction.
* Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that
these functions are useful even when the wxConfigBase comes from another
source, as is the case in the KICAD_MANAGER_FRAME.
* Move the setting of the KIPRJMOD environment variable into class PROJECT,
so that it can be moved into a project variable soon, and out of FP_LIB_TABLE.
* Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all
its child wxFrames and wxDialogs now have a Kiway() member function which
returns a KIWAY& that that window tree branch is in support of. This is like
wxWindows DNA in that child windows get this member with proper value at time
of construction.
* Anticipate some of the needs for milestones B) and C) and make code
adjustments now in an effort to reduce work in those milestones.
* No testing has been done for python scripting, since milestone C) has that
being largely reworked and re-thought-out.
12 years ago |
|
/*
* This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2004-2019 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 <map>
#include <common.h>
#define DEFAULT_HOTKEY_FILENAME_EXT wxT( "hotkeys" )
#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
/**
* Function KeyCodeFromKeyName * return the key code from its user-friendly key name (ie: "Ctrl+M") */int KeyCodeFromKeyName( const wxString& keyname );
/**
* Function KeyNameFromKeyCode * 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 );
/**
* An helper enum for AddHotkeyName function * 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 * 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};
/**
* AddHotkeyName * @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);
/**
* Function DisplayHotkeyList * Displays 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, TOOL_MANAGER* aToolMgr );
/**
* Function ReadotKeyConfig * Reads a hotkey config file into a map. If aFileName is empty it will read in the defualt * hotkeys file. * @param aHotKeys */void ReadHotKeyConfig( wxString aFileName, std::map<std::string, int>& aHotKeys );
/**
* Function WriteHotKeyConfig * Updates the hotkeys config file with the hotkeys from the given actions map. */int WriteHotKeyConfig( const std::map<std::string, TOOL_ACTION*>& aActionMap );
/**
* Function ReadLegacyHotkeyConfigFile * Read hotkey configuration for a given app, * possibly before the frame for that app has been created * @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 );
/**
* Function ReadLegacyHotkeyConfig * 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
|
