KiCad PCB EDA Suite
Loading...
Searching...
No Matches
group_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 The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef GROUP_TOOL_H
25#define GROUP_TOOL_H
26
27#include <tool/selection_tool.h>
28
29class COMMIT;
31
33{
34public:
35 GROUP_TOOL();
36
37 void Reset( RESET_REASON aReason ) override;
38
40 bool Init() override;
41
42 virtual int GroupProperties( const TOOL_EVENT& aEvent );
43
47 virtual int PickNewMember( const TOOL_EVENT& aEvent ) = 0;
48
50 virtual int Group( const TOOL_EVENT& aEvent ) = 0;
51
53 virtual int Ungroup( const TOOL_EVENT& aEvent );
54
56 virtual int AddToGroup( const TOOL_EVENT& aEvent );
57
59 virtual int RemoveFromGroup( const TOOL_EVENT& aEvent );
60
62 virtual int EnterGroup( const TOOL_EVENT& aEvent );
63
65 virtual int LeaveGroup( const TOOL_EVENT& aEvent );
66
67protected:
69 void setTransitions() override;
70
74
76 virtual std::shared_ptr<COMMIT> createCommit() = 0;
77
81 std::shared_ptr<COMMIT> m_commit;
82 bool m_isFootprintEditor = false;
83};
84
85#endif
Represent a set of changes (additions, deletions or modifications) of a data model (e....
Definition: commit.h:73
The base class for create windows for drawing purpose.
A set of EDA_ITEMs (i.e., without duplicates).
Definition: eda_group.h:46
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
virtual int GroupProperties(const TOOL_EVENT &aEvent)
Definition: group_tool.cpp:139
SELECTION_TOOL * m_selectionTool
Definition: group_tool.h:80
virtual int LeaveGroup(const TOOL_EVENT &aEvent)
Definition: group_tool.cpp:288
bool Init() override
Init() is called once upon a registration of the tool.
Definition: group_tool.cpp:117
virtual int RemoveFromGroup(const TOOL_EVENT &aEvent)
Restrict selection to only member of the group.
Definition: group_tool.cpp:248
DIALOG_GROUP_PROPERTIES * m_propertiesDialog
Definition: group_tool.h:79
virtual std::shared_ptr< COMMIT > createCommit()=0
virtual EDA_GROUP * getGroupFromItem(EDA_ITEM *)=0
Subclasses implement to provide correct *_COMMIT object type.
EDA_DRAW_FRAME * m_frame
Definition: group_tool.h:78
virtual int Ungroup(const TOOL_EVENT &aEvent)
Add selection to group.
Definition: group_tool.cpp:154
virtual int AddToGroup(const TOOL_EVENT &aEvent)
Remove selection from group.
Definition: group_tool.cpp:193
virtual int Group(const TOOL_EVENT &aEvent)=0
Ungroup selected items.
std::shared_ptr< COMMIT > m_commit
Definition: group_tool.h:81
virtual int PickNewMember(const TOOL_EVENT &aEvent)=0
Invoke the picker tool to select a new member of the group.
void setTransitions() override
< Set up handlers for various events.
Definition: group_tool.cpp:295
bool m_isFootprintEditor
Definition: group_tool.h:82
virtual int EnterGroup(const TOOL_EVENT &aEvent)
Leave the current group (deselect its members and select the group as a whole).
Definition: group_tool.cpp:274
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:168
void Reset() override