Commit f2b4c7a1 authored by Maciej Suminski's avatar Maciej Suminski

Added a few comments.

parent ab4cb862
......@@ -156,7 +156,6 @@ bool TOOL_DISPATCHER::handleMouseButton( wxEvent& aEvent, int aIndex, bool aMoti
else
isClick = true;
if( isClick )
{
if( st->triggerContextMenu && !mods )
......@@ -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;
std::string toolName;
......
......@@ -71,6 +71,8 @@ public:
* Function InvokeTool()
* 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
*
* @return True if the requested tool was invoked successfully.
*/
bool InvokeTool( TOOL_ID aToolId );
bool InvokeTool( const std::string& aName );
......@@ -81,6 +83,8 @@ public:
/**
* Function FindTool()
* 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( const std::string& aName ) const;
......@@ -100,7 +104,7 @@ public:
/**
* 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)
* when the board is set up
* when the board is set up.
*/
void SetEnvironment( EDA_ITEM* aModel, KiGfx::VIEW* aView,
KiGfx::VIEW_CONTROLS* aViewControls, wxWindow* aFrame );
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment