KiCad PCB EDA Suite
board_commit.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) 2016 CERN
5 * Copyright (C) 2016-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Tomasz Wlostowski <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#ifndef BOARD_COMMIT_H
27#define BOARD_COMMIT_H
28
29#include <commit.h>
30
31class BOARD_ITEM;
32class BOARD;
34class PCB_TOOL_BASE;
35class TOOL_MANAGER;
36class EDA_DRAW_FRAME;
37class TOOL_BASE;
38
39#define SKIP_UNDO 0x0001
40#define APPEND_UNDO 0x0002
41#define SKIP_SET_DIRTY 0x0004
42#define SKIP_CONNECTIVITY 0x0008
43#define ZONE_FILL_OP 0x0010
44
45class BOARD_COMMIT : public COMMIT
46{
47public:
48 BOARD_COMMIT( TOOL_MANAGER* aToolMgr );
51
52 virtual ~BOARD_COMMIT();
53
54 BOARD* GetBoard() const;
55
56 virtual void Push( const wxString& aMessage = wxT( "A commit" ),
57 int aCommitFlags = 0 ) override;
58
59 virtual void Revert() override;
60 COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType ) override;
61 COMMIT& Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType ) override;
62 COMMIT& Stage( const PICKED_ITEMS_LIST& aItems,
63 UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED ) override;
64
73 void SetResolveNetConflicts( bool aResolve = true ) { m_resolveNetConflicts = aResolve; }
74
75private:
76 EDA_ITEM* parentObject( EDA_ITEM* aItem ) const override;
77
78 EDA_ITEM* makeImage( EDA_ITEM* aItem ) const override;
79
81
82private:
87};
88
89#endif
virtual ~BOARD_COMMIT()
EDA_ITEM * parentObject(EDA_ITEM *aItem) const override
BOARD * GetBoard() const
void SetResolveNetConflicts(bool aResolve=true)
Sets a flag that will cause Push() to resolve net conflicts on track/via clusters instead of the defa...
Definition: board_commit.h:73
BOARD_COMMIT(TOOL_MANAGER *aToolMgr)
virtual void Revert() override
bool m_isBoardEditor
Definition: board_commit.h:85
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
EDA_ITEM * makeImage(EDA_ITEM *aItem) const override
void dirtyIntersectingZones(BOARD_ITEM *item)
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType) override
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:83
bool m_isFootprintEditor
Definition: board_commit.h:84
bool m_resolveNetConflicts
Definition: board_commit.h:86
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:58
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
Represent a set of changes (additions, deletions or modifications) of a data model (e....
Definition: commit.h:72
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
A holder to handle information on schematic or board items.
Base abstract interface for all kinds of tools.
Definition: tool_base.h:66
Master controller class:
Definition: tool_manager.h:55
CHANGE_TYPE
Types of changes.
Definition: commit.h:39
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...