KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_editor_move_tool.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019 CERN
5 * Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef SYMBOL_EDITOR_MOVE_TOOL_H
26#define SYMBOL_EDITOR_MOVE_TOOL_H
27
28#include <tools/ee_tool_base.h>
29#include <symbol_edit_frame.h>
30
33
34
35class SYMBOL_EDITOR_MOVE_TOOL : public EE_TOOL_BASE<SYMBOL_EDIT_FRAME>
36{
37public:
40
42 bool Init() override;
43
45 void Reset( RESET_REASON aReason ) override;
46
50 int Main( const TOOL_EVENT& aEvent );
51
58 int AlignElements( const TOOL_EVENT& aEvent );
59
60private:
61 bool doMoveSelection( const TOOL_EVENT& aEvent, SCH_COMMIT* aCommit );
62
63 void moveItem( EDA_ITEM* aItem, const VECTOR2I& aDelta );
64
66 void setTransitions() override;
67
68private:
70
75};
76
77#endif // SYMBOL_EDITOR_MOVE_TOOL_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
bool doMoveSelection(const TOOL_EVENT &aEvent, SCH_COMMIT *aCommit)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
void moveItem(EDA_ITEM *aItem, const VECTOR2I &aDelta)
Set up handlers for various events.
bool Init() override
Init() is called once upon a registration of the tool.
int Main(const TOOL_EVENT &aEvent)
Run an interactive move of the selected items, or the item under the cursor.
int AlignElements(const TOOL_EVENT &aEvent)
Align selected elements to the grid.
bool m_moveInProgress
Last cursor position (needed for getModificationPoint() to avoid changes of edit reference point).
The symbol library editor main window.
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:167
void Reset() override