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

Missing comments in the PLACEMENT_TOOL class.

This commit is contained in:
Maciej Suminski 2015-02-14 21:49:06 +01:00
parent 902d0e3f1f
commit bb861b81b2
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
pcbnew/tools/placement_tool.h
View File

@ -29,10 +29,6 @@
class SELECTION_TOOL; class SELECTION_TOOL;
/**
* TODO description
*/
class PLACEMENT_TOOL : public TOOL_INTERACTIVE class PLACEMENT_TOOL : public TOOL_INTERACTIVE
{ {
public: public:
@ -45,26 +41,44 @@ public:
/// @copydoc TOOL_INTERACTIVE::Init() /// @copydoc TOOL_INTERACTIVE::Init()
bool Init(); bool Init();
/// TODO /**
* Function AlignTop()
* Sets Y coordinate of the selected items to the value of the top-most selected item Y coordinate.
*/
int AlignTop( const TOOL_EVENT& aEvent ); int AlignTop( const TOOL_EVENT& aEvent );
/// TODO /**
* Function AlignBottom()
* Sets Y coordinate of the selected items to the value of the bottom-most selected item Y coordinate.
*/
int AlignBottom( const TOOL_EVENT& aEvent ); int AlignBottom( const TOOL_EVENT& aEvent );
/// TODO /**
* Function AlignLeft()
* Sets X coordinate of the selected items to the value of the left-most selected item X coordinate.
*/
int AlignLeft( const TOOL_EVENT& aEvent ); int AlignLeft( const TOOL_EVENT& aEvent );
/// TODO /**
* Function AlignRight()
* Sets X coordinate of the selected items to the value of the right-most selected item X coordinate.
*/
int AlignRight( const TOOL_EVENT& aEvent ); int AlignRight( const TOOL_EVENT& aEvent );
/// TODO /**
* Function DistributeHorizontally()
* Distributes the selected items along the X axis.
*/
int DistributeHorizontally( const TOOL_EVENT& aEvent ); int DistributeHorizontally( const TOOL_EVENT& aEvent );
/// TODO /**
* Function DistributeVertically()
* Distributes the selected items along the Y axis.
*/
int DistributeVertically( const TOOL_EVENT& aEvent ); int DistributeVertically( const TOOL_EVENT& aEvent );
private: private:
/// TODO ///> Sets up handlers for various events.
void setTransitions(); void setTransitions();
SELECTION_TOOL* m_selectionTool; SELECTION_TOOL* m_selectionTool;