KiCad PCB EDA Suite
global_edit_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-2021 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 GLOBAL_EDIT_TOOL_H
25 #define GLOBAL_EDIT_TOOL_H
26 
27 #include <math/vector2d.h>
28 #include <tools/pcb_tool_base.h>
30 #include <status_popup.h>
31 
32 
33 class BOARD_COMMIT;
34 class BOARD_ITEM;
35 class CONNECTIVITY_DATA;
36 
37 
39 {
40 public:
42 
44  void Reset( RESET_REASON aReason ) override;
45 
47  bool Init() override;
48 
55  int ExchangeFootprints( const TOOL_EVENT& aEvent );
56 
57  int SwapLayers( const TOOL_EVENT& aEvent );
58 
59  int EditTracksAndVias( const TOOL_EVENT& aEvent );
60  int EditTextAndGraphics( const TOOL_EVENT& aEvent );
61  int GlobalDeletions( const TOOL_EVENT& aEvent );
62  int CleanupTracksAndVias( const TOOL_EVENT& aEvent );
63  int CleanupGraphics( const TOOL_EVENT& aEvent );
64  int RemoveUnusedPads( const TOOL_EVENT& aEvent );
65 
66 private:
67  bool swapBoardItem( BOARD_ITEM* aItem, PCB_LAYER_ID* aLayerMap );
68 
70  void setTransitions() override;
71 
72 private:
74  std::unique_ptr<BOARD_COMMIT> m_commit;
75 };
76 
77 #endif
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
int SwapLayers(const TOOL_EVENT &aEvent)
int EditTracksAndVias(const TOOL_EVENT &aEvent)
PCB_LAYER_ID
A quick note on layer IDs:
int RemoveUnusedPads(const TOOL_EVENT &aEvent)
Generic, UI-independent tool event.
Definition: tool_event.h:173
bool swapBoardItem(BOARD_ITEM *aItem, PCB_LAYER_ID *aLayerMap)
Set up handlers for various events.
PCB_SELECTION_TOOL * m_selectionTool
bool Init() override
Init() is called once upon a registration of the tool.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int GlobalDeletions(const TOOL_EVENT &aEvent)
int CleanupGraphics(const TOOL_EVENT &aEvent)
The selection tool: currently supports:
int ExchangeFootprints(const TOOL_EVENT &aEvent)
Invoke the dialog used to update or exchange the footprint definitions used for footprints.
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
int CleanupTracksAndVias(const TOOL_EVENT &aEvent)
std::unique_ptr< BOARD_COMMIT > m_commit