KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_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-2024 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 SCHEMATIC_COMMIT_H
27#define SCHEMATIC_COMMIT_H
28
29#include <commit.h>
30
32class TOOL_MANAGER;
33class SCH_EDIT_FRAME;
34class SCH_BASE_FRAME;
35class EDA_DRAW_FRAME;
36class TOOL_BASE;
37
38template<class T>
39class EE_TOOL_BASE;
40
41#define SKIP_UNDO 0x0001
42#define APPEND_UNDO 0x0002
43#define SKIP_SET_DIRTY 0x0004
44
45class SCH_COMMIT : public COMMIT
46{
47public:
48 SCH_COMMIT( TOOL_MANAGER* aToolMgr );
49 SCH_COMMIT( EDA_DRAW_FRAME* aFrame );
51
52 virtual ~SCH_COMMIT();
53
54 virtual void Push( const wxString& aMessage = wxT( "A commit" ),
55 int aCommitFlags = 0 ) override;
56
57 virtual void Revert() override;
58 COMMIT& Stage( EDA_ITEM *aItem, CHANGE_TYPE aChangeType,
59 BASE_SCREEN *aScreen = nullptr ) override;
60 COMMIT& Stage( std::vector<EDA_ITEM*> &container, CHANGE_TYPE aChangeType,
61 BASE_SCREEN *aScreen = nullptr ) override;
62 COMMIT& Stage( const PICKED_ITEMS_LIST &aItems, UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED,
63 BASE_SCREEN *aScreen = nullptr ) override;
64
65private:
66 EDA_ITEM* parentObject( EDA_ITEM* aItem ) const override;
67
68 EDA_ITEM* makeImage( EDA_ITEM* aItem ) const override;
69
70 void pushLibEdit( const wxString& aMessage, int aCommitFlags );
71 void pushSchEdit( const wxString& aMessage, int aCommitFlags );
72
73 void revertLibEdit();
74
75private:
78};
79
80#endif
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
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 foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:48
A holder to handle information on schematic or board items.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
bool m_isLibEditor
Definition: sch_commit.h:77
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
Definition: sch_commit.cpp:403
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) override
Definition: sch_commit.cpp:68
virtual void Revert() override
Definition: sch_commit.cpp:481
TOOL_MANAGER * m_toolMgr
Definition: sch_commit.h:76
virtual ~SCH_COMMIT()
Definition: sch_commit.cpp:63
void pushLibEdit(const wxString &aMessage, int aCommitFlags)
Definition: sch_commit.cpp:117
void revertLibEdit()
Definition: sch_commit.cpp:455
EDA_ITEM * makeImage(EDA_ITEM *aItem) const override
Definition: sch_commit.cpp:426
EDA_ITEM * parentObject(EDA_ITEM *aItem) const override
Definition: sch_commit.cpp:412
void pushSchEdit(const wxString &aMessage, int aCommitFlags)
Definition: sch_commit.cpp:175
Schematic editor (Eeschema) main window.
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...