KiCad PCB EDA Suite
undo_redo_container.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) 2009 [email protected]
5 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2009-2021 KiCad Developers, see AUTHORS.txt for contributors.
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 _CLASS_UNDOREDO_CONTAINER_H
27#define _CLASS_UNDOREDO_CONTAINER_H
28
29#include <core/typeinfo.h>
30#include <eda_item_flags.h>
31#include <vector>
32
33class EDA_ITEM;
35class BASE_SCREEN;
36
37
56enum class UNDO_REDO {
57 UNSPECIFIED = 0, // illegal
58 NOP, // Undo/redo will ignore this entry. Only forces the start of a new stack
59 CHANGED, // params of items have a value changed: undo is made by exchange
60 // values with a copy of these values
61 NEWITEM, // new item, undo by changing in deleted
62 DELETED, // deleted item, undo by changing in deleted
63 LIBEDIT, // Specific to the component editor (symbol_editor creates a full copy
64 // of the current component when changed)
65 LIB_RENAME, // As LIBEDIT, but old copy should be removed from library
66 EXCHANGE_T, // Use for changing the schematic text type where swapping
67 // data structure is insufficient to restore the change.
68 DRILLORIGIN, // origin changed (like CHANGED, contains the origin and a copy)
69 GRIDORIGIN, // origin changed (like CHANGED, contains the origin and a copy)
70 PAGESETTINGS, // page settings or title block changes
71 REGROUP, // new group of items created (do not use GROUP to avoid collision
72 // with an header on msys2)
73 UNGROUP // existing group destroyed (items not destroyed)
74};
75
76
78{
79public:
80// ITEM_PICKER( EDA_ITEM* aItem = NULL, UNDO_REDO aStatus = UNSPECIFIED );
82 ITEM_PICKER( BASE_SCREEN* aScreen, EDA_ITEM* aItem,
84
85 EDA_ITEM* GetItem() const { return m_pickedItem; }
86
87 void SetItem( EDA_ITEM* aItem );
88
90
91 void SetStatus( UNDO_REDO aStatus ) { m_undoRedoStatus = aStatus; }
92
94
95 void SetFlags( EDA_ITEM_FLAGS aFlags ) { m_pickerFlags = aFlags; }
96
98
99 void SetLink( EDA_ITEM* aItem ) { m_link = aItem; }
100
101 EDA_ITEM* GetLink() const { return m_link; }
102
103 BASE_SCREEN* GetScreen() const { return m_screen; }
104
105private:
106 EDA_ITEM_FLAGS m_pickerFlags; /* a copy of m_flags member. useful in mode/drag
107 * undo/redo commands */
108 UNDO_REDO m_undoRedoStatus; /* type of operation to undo/redo for this item */
109 EDA_ITEM* m_pickedItem; /* Pointer on the schematic or board item that is concerned
110 * (picked), or in undo redo commands, the copy of an
111 * edited item. */
112 KICAD_T m_pickedItemType; /* type of schematic or board item that is concerned */
113
114 EDA_ITEM* m_link; /* Pointer on another item. Used in undo redo command
115 * used when a duplicate exists i.e. when an item is
116 * modified, and the copy of initial item exists (the
117 * duplicate) m_Item points the duplicate (i.e the old
118 * copy of an active item) and m_Link points the active
119 * item in schematic */
120
121 BASE_SCREEN* m_screen; /* For new and deleted items the screen the item should
122 * be added to/removed from. */
123
124};
125
126
133{
134private:
135 std::vector <ITEM_PICKER> m_ItemsList;
136
137public:
140
146 void PushItem( const ITEM_PICKER& aItem );
147
152
156 bool ContainsItem( const EDA_ITEM* aItem ) const;
157
162 int FindItem( const EDA_ITEM* aItem ) const;
163
167 void ClearItemsList();
168
174
178 unsigned GetCount() const
179 {
180 return m_ItemsList.size();
181 }
182
191
197 ITEM_PICKER GetItemWrapper( unsigned int aIdx ) const;
198
203 EDA_ITEM* GetPickedItem( unsigned int aIdx ) const;
204
209 BASE_SCREEN* GetScreenForItem( unsigned int aIdx ) const;
210
215 EDA_ITEM* GetPickedItemLink( unsigned int aIdx ) const;
216
222 UNDO_REDO GetPickedItemStatus( unsigned int aIdx ) const;
223
230 EDA_ITEM_FLAGS GetPickerFlags( unsigned aIdx ) const;
231
237 bool SetPickedItem( EDA_ITEM* aItem, unsigned aIdx );
238
245 bool SetPickedItem( EDA_ITEM* aItem, UNDO_REDO aStatus, unsigned aIdx );
246
254 bool SetPickedItemLink( EDA_ITEM* aLink, unsigned aIdx );
255
263 bool SetPickedItemStatus( UNDO_REDO aStatus, unsigned aIdx );
264
272 bool SetPickerFlags( EDA_ITEM_FLAGS aFlags, unsigned aIdx );
273
280 bool RemovePicker( unsigned aIdx );
281
289 void CopyList( const PICKED_ITEMS_LIST& aSource );
290};
291
292
297{
298public:
301
302 void PushCommand( PICKED_ITEMS_LIST* aCommand );
303
305
306 void ClearCommandList();
307
308 std::vector <PICKED_ITEMS_LIST*> m_CommandsList; // the list of possible undo/redo commands
309};
310
311
312#endif // _CLASS_UNDOREDO_CONTAINER_H
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
void SetItem(EDA_ITEM *aItem)
void SetLink(EDA_ITEM *aItem)
BASE_SCREEN * m_screen
EDA_ITEM * GetItem() const
KICAD_T m_pickedItemType
void SetStatus(UNDO_REDO aStatus)
BASE_SCREEN * GetScreen() const
EDA_ITEM * GetLink() const
EDA_ITEM_FLAGS GetFlags() const
EDA_ITEM_FLAGS m_pickerFlags
EDA_ITEM * m_pickedItem
UNDO_REDO m_undoRedoStatus
UNDO_REDO GetStatus() const
void SetFlags(EDA_ITEM_FLAGS aFlags)
KICAD_T GetItemType() const
A holder to handle information on schematic or board items.
bool SetPickedItemStatus(UNDO_REDO aStatus, unsigned aIdx)
Set the type of undo/redo operation for a given picked item.
EDA_ITEM_FLAGS GetPickerFlags(unsigned aIdx) const
Return the value of the picker flag.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
int FindItem(const EDA_ITEM *aItem) const
UNDO_REDO GetPickedItemStatus(unsigned int aIdx) const
ITEM_PICKER GetItemWrapper(unsigned int aIdx) const
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
std::vector< ITEM_PICKER > m_ItemsList
bool RemovePicker(unsigned aIdx)
Remove one entry (one picker) from the list of picked items.
bool ContainsItem(const EDA_ITEM *aItem) const
unsigned GetCount() const
bool SetPickedItem(EDA_ITEM *aItem, unsigned aIdx)
void CopyList(const PICKED_ITEMS_LIST &aSource)
Copy all data from aSource to the list.
void ClearListAndDeleteItems()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
void ReversePickersListOrder()
Reverse the order of pickers stored in this list.
void ClearItemsList()
Delete only the list of pickers NOT the picked data itself.
bool SetPickedItemLink(EDA_ITEM *aLink, unsigned aIdx)
Set the link associated to a given picked item.
BASE_SCREEN * GetScreenForItem(unsigned int aIdx) const
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
bool SetPickerFlags(EDA_ITEM_FLAGS aFlags, unsigned aIdx)
Set the flags of the picker (usually to the picked item m_flags value).
A holder to handle a list of undo (or redo) commands.
void PushCommand(PICKED_ITEMS_LIST *aCommand)
PICKED_ITEMS_LIST * PopCommand()
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
std::uint32_t EDA_ITEM_FLAGS
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...