139 lines
4.3 KiB
C++
139 lines
4.3 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2013 CERN
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
*
|
|
* 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 ACTION_MANAGER_H_
|
|
#define ACTION_MANAGER_H_
|
|
|
|
#include <list>
|
|
#include <map>
|
|
#include <string>
|
|
|
|
class TOOL_BASE;
|
|
class TOOL_MANAGER;
|
|
class TOOL_ACTION;
|
|
|
|
/**
|
|
* Class ACTION_MANAGER
|
|
*
|
|
* Takes care of TOOL_ACTION objects. Registers them and allows to run them using associated
|
|
* hot keys, names or ids.
|
|
*/
|
|
class ACTION_MANAGER
|
|
{
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
* @param aToolManager is a tool manager instance that is used to pass events to tools.
|
|
*/
|
|
ACTION_MANAGER( TOOL_MANAGER* aToolManager );
|
|
|
|
/**
|
|
* Destructor.
|
|
* Unregisters every registered action.
|
|
*/
|
|
~ACTION_MANAGER();
|
|
|
|
/**
|
|
* Function RegisterAction()
|
|
* Adds a tool action to the manager and sets it up. After that is is possible to invoke
|
|
* the action using hotkeys or sending a command event with its name.
|
|
* @param aAction: action to be added. Ownership is not transferred.
|
|
*/
|
|
void RegisterAction( TOOL_ACTION* aAction );
|
|
|
|
/**
|
|
* Function UnregisterAction()
|
|
* Removes a tool action from the manager and makes it unavailable for further usage.
|
|
* @param aAction: action to be removed.
|
|
*/
|
|
void UnregisterAction( TOOL_ACTION* aAction );
|
|
|
|
/**
|
|
* Generates an unique ID from for an action with given name.
|
|
*/
|
|
static int MakeActionId( const std::string& aActionName );
|
|
|
|
/**
|
|
* Function FindAction()
|
|
* Finds an action with a given name (if there is one available).
|
|
* @param aActionName is the searched action.
|
|
* @return Pointer to a TOOL_ACTION object or NULL if there is no such action.
|
|
*/
|
|
TOOL_ACTION* FindAction( const std::string& aActionName ) const;
|
|
|
|
/**
|
|
* Function RunHotKey()
|
|
* Runs an action associated with a hotkey (if there is one available).
|
|
* @param aHotKey is the hotkey to be handled.
|
|
* @return True if there was an action associated with the hotkey, false otherwise.
|
|
*/
|
|
bool RunHotKey( int aHotKey ) const;
|
|
|
|
/**
|
|
* Function GetHotKey()
|
|
* Returns the hot key associated with a given action or 0 if there is none.
|
|
* @param aAction is the queried action.
|
|
*/
|
|
int GetHotKey( const TOOL_ACTION& aAction ) const;
|
|
|
|
/**
|
|
* Function UpdateHotKeys()
|
|
* Updates TOOL_ACTIONs hot key assignment according to the current frame's Hot Key Editor settings.
|
|
*/
|
|
void UpdateHotKeys();
|
|
|
|
/**
|
|
* Function GetActionList()
|
|
* Returns list of TOOL_ACTIONs. TOOL_ACTIONs add themselves to the list upon their
|
|
* creation.
|
|
* @return List of TOOL_ACTIONs.
|
|
*/
|
|
static std::list<TOOL_ACTION*>& GetActionList()
|
|
{
|
|
static std::list<TOOL_ACTION*> actionList;
|
|
|
|
return actionList;
|
|
}
|
|
|
|
private:
|
|
///> Resolves a reference to legacy hot key settings to a particular hot key.
|
|
///> @param aAction is the action to be resolved.
|
|
int processHotKey( TOOL_ACTION* aAction );
|
|
|
|
///> Tool manager needed to run actions
|
|
TOOL_MANAGER* m_toolMgr;
|
|
|
|
///> Map for indexing actions by their names
|
|
std::map<std::string, TOOL_ACTION*> m_actionNameIndex;
|
|
|
|
///> Map for indexing actions by their hotkeys
|
|
typedef std::map<int, std::list<TOOL_ACTION*> > HOTKEY_LIST;
|
|
HOTKEY_LIST m_actionHotKeys;
|
|
|
|
///> Quick action<->hot key lookup
|
|
std::map<int, int> m_hotkeys;
|
|
};
|
|
|
|
#endif /* ACTION_MANAGER_H_ */
|