haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added a few comments.

This commit is contained in:
Maciej Suminski 2013-09-06 16:01:46 +02:00
parent ab4cb862b0
commit f2b4c7a18b
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
common/tool/tool_dispatcher.cpp
View File

@ -155,7 +155,6 @@ bool TOOL_DISPATCHER::handleMouseButton( wxEvent& aEvent, int aIndex, bool aMoti
} }
else else
isClick = true; isClick = true;
if( isClick ) if( isClick )
{ {
@ -256,7 +255,7 @@ void TOOL_DISPATCHER::DispatchWxEvent( wxEvent& aEvent )
} }
void TOOL_DISPATCHER::DispatchWxCommand( wxCommandEvent &aEvent ) void TOOL_DISPATCHER::DispatchWxCommand( wxCommandEvent& aEvent )
{ {
bool activateTool = false; bool activateTool = false;
std::string toolName; std::string toolName;

6
include/tool/tool_manager.h
View File

@ -71,6 +71,8 @@ public:
* Function InvokeTool() * Function InvokeTool()
* Calls a tool by sending a tool activation event to tool of given ID or name. * Calls a tool by sending a tool activation event to tool of given ID or name.
* An user-defined parameter object can be also passed * An user-defined parameter object can be also passed
*
* @return True if the requested tool was invoked successfully.
*/ */
bool InvokeTool( TOOL_ID aToolId ); bool InvokeTool( TOOL_ID aToolId );
bool InvokeTool( const std::string& aName ); bool InvokeTool( const std::string& aName );
@ -81,6 +83,8 @@ public:
/** /**
* Function FindTool() * Function FindTool()
* Searches for a tool with given name or ID * Searches for a tool with given name or ID
*
* @return Pointer to the request tool of NULL in case of failure.
*/ */
TOOL_BASE* FindTool( int aId ) const; TOOL_BASE* FindTool( int aId ) const;
TOOL_BASE* FindTool( const std::string& aName ) const; TOOL_BASE* FindTool( const std::string& aName ) const;
@ -100,7 +104,7 @@ public:
/** /**
* Sets the work environment (model, view, view controls and the parent window). * Sets the work environment (model, view, view controls and the parent window).
* These are made available to the tool. Called by the parent frame (PCB_EDIT_FRAME) * These are made available to the tool. Called by the parent frame (PCB_EDIT_FRAME)
* when the board is set up * when the board is set up.
*/ */
void SetEnvironment( EDA_ITEM* aModel, KiGfx::VIEW* aView, void SetEnvironment( EDA_ITEM* aModel, KiGfx::VIEW* aView,
KiGfx::VIEW_CONTROLS* aViewControls, wxWindow* aFrame ); KiGfx::VIEW_CONTROLS* aViewControls, wxWindow* aFrame );