KiCad PCB EDA Suite
pl_editor_undo_redo.cpp
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) 2013 CERN
5 * Copyright (C) 2019 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Jean-Pierre Charras, jp.charras at wanadoo.fr
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
28#include <tool/tool_manager.h>
29#include <tool/actions.h>
30
31#include "pl_editor_frame.h"
33
35{
36 PICKED_ITEMS_LIST* lastcmd = new PICKED_ITEMS_LIST();
37 DS_PROXY_UNDO_ITEM* copyItem = new DS_PROXY_UNDO_ITEM( this );
38 ITEM_PICKER wrapper( GetScreen(), copyItem, UNDO_REDO::LIBEDIT );
39
40 lastcmd->PushItem( wrapper );
41 PushCommandToUndoList( lastcmd );
42
43 // Clear redo list, because after new save there is no redo to do.
45}
46
47
48/* Redo the last edit:
49 * - Place the current edited layout in undo list
50 * - Get previous version of the current edited layput
51 */
53{
55
56 if ( GetRedoCommandCount() <= 0 )
57 return;
58
60 DS_PROXY_UNDO_ITEM* redoItem = static_cast<DS_PROXY_UNDO_ITEM*>( redoWrapper.GetItem() );
61 bool pageSettingsAndTitleBlock = redoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
62
63 PICKED_ITEMS_LIST* undoCmd = new PICKED_ITEMS_LIST();
64 DS_PROXY_UNDO_ITEM* undoItem = new DS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr );
65 ITEM_PICKER undoWrapper( GetScreen(), undoItem );
66
67 undoCmd->PushItem( undoWrapper );
68 PushCommandToUndoList( undoCmd );
69
70 selTool->ClearSelection();
71 redoItem->Restore( this, GetCanvas()->GetView() );
72 selTool->RebuildSelection();
73
74 delete redoItem;
75
76 if( pageSettingsAndTitleBlock )
77 HardRedraw(); // items based off of corners will need re-calculating
78 else
79 GetCanvas()->Refresh();
80
81 OnModify();
82}
83
84
85/* Undo the last edit:
86 * - Place the current layout in Redo list
87 * - Get previous version of the current edited layout
88 */
90{
92
93 if ( GetUndoCommandCount() <= 0 )
94 return;
95
97 DS_PROXY_UNDO_ITEM* undoItem = static_cast<DS_PROXY_UNDO_ITEM*>( undoWrapper.GetItem() );
98 bool pageSettingsAndTitleBlock = undoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
99
100 PICKED_ITEMS_LIST* redoCmd = new PICKED_ITEMS_LIST();
101 DS_PROXY_UNDO_ITEM* redoItem = new DS_PROXY_UNDO_ITEM( pageSettingsAndTitleBlock ? this : nullptr );
102 ITEM_PICKER redoWrapper( GetScreen(), redoItem );
103
104 redoCmd->PushItem( redoWrapper );
105 PushCommandToRedoList( redoCmd );
106
107 selTool->ClearSelection();
108 undoItem->Restore( this, GetCanvas()->GetView() );
109 selTool->RebuildSelection();
110
111 delete undoItem;
112
113 if( pageSettingsAndTitleBlock )
114 HardRedraw(); // items based off of corners will need re-calculating
115 else
116 GetCanvas()->Refresh();
117
118 OnModify();
119}
120
121
122/* Remove the last command in Undo List.
123 * Used to clean the uUndo stack after a cancel command
124 */
126{
128
129 if ( GetUndoCommandCount() <= 0 )
130 return;
131
132 ITEM_PICKER undoWrapper = PopCommandFromUndoList()->PopItem();
133 DS_PROXY_UNDO_ITEM* undoItem = static_cast<DS_PROXY_UNDO_ITEM*>( undoWrapper.GetItem() );
134 bool pageSettingsAndTitleBlock = undoItem->Type() == WS_PROXY_UNDO_ITEM_PLUS_T;
135
136 selTool->ClearSelection();
137 undoItem->Restore( this, GetCanvas()->GetView() );
138 selTool->RebuildSelection();
139
140 delete undoItem;
141
142 if( pageSettingsAndTitleBlock )
143 {
145 HardRedraw(); // items based off of corners will need re-calculating
146 }
147 else
148 GetCanvas()->Refresh();
149}
static TOOL_ACTION zoomFitScreen
Definition: actions.h:98
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Add a command to undo in the undo list.
virtual int GetRedoCommandCount() const
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual int GetUndoCommandCount() const
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Add a command to redo in the redo list.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
EDA_ITEM * GetItem() const
A holder to handle information on schematic or board items.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
void OnModify() override
Must be called after a change in order to set the "modify" flag.
void GetLayoutFromRedoList()
Redo the last edit:
void GetLayoutFromUndoList()
Undo the last edit:
void RollbackFromUndo()
Apply the last command in Undo List without stacking a Redo.
void SaveCopyInUndoList()
Save a copy of the description (in a S expr string) for Undo/redo commands.
void HardRedraw() override
Refresh the library tree and redraw the window.
PL_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if nee...
int ClearSelection(const TOOL_EVENT &aEvent)
void RebuildSelection()
Rebuild the selection from the flags in the view items.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:142
@ WS_PROXY_UNDO_ITEM_PLUS_T
Definition: typeinfo.h:229