KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023 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#define SKIP_TEARDROPS 0x0020
45
46class BOARD_COMMIT : public COMMIT
47{
48public:
50 BOARD_COMMIT( TOOL_BASE* aTool );
52
53 virtual ~BOARD_COMMIT() {}
54
55 BOARD* GetBoard() const;
56
57 virtual void Push( const wxString& aMessage = wxEmptyString, int aCommitFlags = 0 ) override;
58
59 virtual void Revert() override;
60 COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType,
61 BASE_SCREEN* aScreen = nullptr ) override;
62 COMMIT& Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType,
63 BASE_SCREEN* aScreen = nullptr ) override;
64 COMMIT& Stage( const PICKED_ITEMS_LIST& aItems,
65 UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED,
66 BASE_SCREEN* aScreen = nullptr ) override;
67
68 static EDA_ITEM* MakeImage( EDA_ITEM* aItem );
69
70private:
71 EDA_ITEM* parentObject( EDA_ITEM* aItem ) const override;
72
73 EDA_ITEM* makeImage( EDA_ITEM* aItem ) const override;
74
75 void dirtyIntersectingZones( BOARD_ITEM* item, int aChangeType );
76
77private:
81};
82
83#endif
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
void dirtyIntersectingZones(BOARD_ITEM *item, int aChangeType)
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) override
EDA_ITEM * parentObject(EDA_ITEM *aItem) const override
virtual ~BOARD_COMMIT()
Definition: board_commit.h:53
BOARD * GetBoard() const
virtual void Revert() override
static EDA_ITEM * MakeImage(EDA_ITEM *aItem)
bool m_isBoardEditor
Definition: board_commit.h:79
EDA_ITEM * makeImage(EDA_ITEM *aItem) const override
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:78
bool m_isFootprintEditor
Definition: board_commit.h:80
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:281
Represent a set of changes (additions, deletions or modifications) of a data model (e....
Definition: commit.h:74
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:88
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:57
CHANGE_TYPE
Types of changes.
Definition: commit.h:41
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...