KiCad PCB EDA Suite
Loading...
Searching...
No Matches
schematic_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) 2004 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 2004-2024 KiCad Developers, see change_log.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#include <ee_actions.h>
26#include <sch_edit_frame.h>
27#include <tool/tool_manager.h>
28#include <schematic.h>
29#include <sch_bus_entry.h>
30#include <sch_commit.h>
31#include <sch_junction.h>
32#include <sch_line.h>
33#include <sch_bitmap.h>
34#include <sch_sheet_pin.h>
35#include <sch_table.h>
38#include <tool/actions.h>
39
40
41/* Functions to undo and redo edit commands.
42 *
43 * m_UndoList and m_RedoList handle a std::vector of PICKED_ITEMS_LIST
44 * Each PICKED_ITEMS_LIST handle a std::vector of pickers (class ITEM_PICKER),
45 * that store the list of schematic items that are concerned by the command to
46 * undo or redo and is created for each command to undo (handle also a command
47 * to redo). each picker has a pointer pointing to an item to undo or redo (in
48 * fact: deleted, added or modified), and has a pointer to a copy of this item,
49 * when this item has been modified (the old values of parameters are
50 * therefore saved)
51 *
52 * there are 3 cases:
53 * - delete item(s) command
54 * - change item(s) command
55 * - add item(s) command
56 * and 2 cases for block:
57 * - move list of items
58 * - mirror (Y) list of items
59 *
60 * Undo command
61 * - delete item(s) command:
62 * => deleted items are moved in undo list
63 *
64 * - change item(s) command
65 * => A copy of item(s) is made (a DrawPickedStruct list of wrappers)
66 * the .m_Link member of each wrapper points the modified item.
67 * the .m_Item member of each wrapper points the old copy of this item.
68 *
69 * - add item(s) command
70 * =>A list of item(s) is made. The .m_Item member of each wrapper points
71 * the new item.
72 *
73 * Redo command
74 * - delete item(s) old command:
75 * => deleted items are moved into m_tree
76 *
77 * - change item(s) command
78 * => the copy of item(s) is moved in Undo list
79 *
80 * - add item(s) command
81 * => The list of item(s) is used to create a deleted list in undo
82 * list(same as a delete command)
83 *
84 * Some block operations that change items can be undone without memorized
85 * items, just the coordinates of the transform: move list of items (undo/
86 * redo is made by moving with the opposite move vector) mirror (Y) and flip
87 * list of items (undo/redo is made by mirror or flip items) so they are
88 * handled specifically.
89 *
90 * A problem is the hierarchical sheet handling.
91 * the data associated (sub-hierarchy, undo/redo list) is deleted only
92 * when the sheet is really deleted (i.e. when deleted from undo or redo list)
93 * This is handled by its destructor.
94 */
95
96
97/* Used if undo / redo command:
98 * swap data between Item and its copy, pointed by its picked item link member
99 * swapped data is data modified by editing, so not all values are swapped
100 */
101
103 UNDO_REDO aCommandType, bool aAppend,
104 bool aDirtyConnectivity )
105{
106 PICKED_ITEMS_LIST* commandToUndo = nullptr;
107
108 wxCHECK( aItem, /* void */ );
109
110 if( aDirtyConnectivity )
111 {
112 if( !aItem->IsConnectivityDirty()
113 && aItem->Connection()
114 && ( aItem->Connection()->Name() == m_highlightedConn ) )
115 {
117 }
118
119 aItem->SetConnectivityDirty();
120 }
121
123
124 // If the last stack was empty, use that one instead of creating a new stack
125 if( lastUndo )
126 {
127 if( aAppend || !lastUndo->GetCount() )
128 commandToUndo = lastUndo;
129 else
130 PushCommandToUndoList( lastUndo );
131 }
132
133 if( !commandToUndo )
134 {
135 commandToUndo = new PICKED_ITEMS_LIST();
136 }
137
138 ITEM_PICKER itemWrapper( aScreen, aItem, aCommandType );
139 itemWrapper.SetFlags( aItem->GetFlags() );
140
141 switch( aCommandType )
142 {
143 case UNDO_REDO::CHANGED: /* Create a copy of item */
144 itemWrapper.SetLink( aItem->Duplicate( true ) );
145 commandToUndo->PushItem( itemWrapper );
146 break;
147
148 case UNDO_REDO::NEWITEM:
149 case UNDO_REDO::DELETED:
150 commandToUndo->PushItem( itemWrapper );
151 break;
152
153 default:
154 wxFAIL_MSG( wxString::Format( wxT( "SaveCopyInUndoList() error (unknown code %X)" ),
155 aCommandType ) );
156 break;
157 }
158
159 if( commandToUndo->GetCount() )
160 {
161 /* Save the copy in undo list */
162 PushCommandToUndoList( commandToUndo );
163
164 /* Clear redo list, because after new save there is no redo to do */
166 }
167 else
168 {
169 delete commandToUndo;
170 }
171}
172
173
175 UNDO_REDO aTypeCommand, bool aAppend,
176 bool aDirtyConnectivity )
177{
178 PICKED_ITEMS_LIST* commandToUndo = nullptr;
179
180 if( !aItemsList.GetCount() )
181 return;
182
184
185 // If the last stack was empty, use that one instead of creating a new stack
186 if( lastUndo )
187 {
188 if( aAppend || !lastUndo->GetCount() )
189 commandToUndo = lastUndo;
190 else
191 PushCommandToUndoList( lastUndo );
192 }
193
194 if( !commandToUndo )
195 {
196 commandToUndo = new PICKED_ITEMS_LIST();
197 commandToUndo->SetDescription( aItemsList.GetDescription() );
198 }
199
200 // Copy picker list:
201 if( !commandToUndo->GetCount() )
202 commandToUndo->CopyList( aItemsList );
203 else
204 {
205 // Unless we are appending, in which case, get the picker items
206 for( unsigned ii = 0; ii < aItemsList.GetCount(); ii++ )
207 commandToUndo->PushItem( aItemsList.GetItemWrapper( ii) );
208 }
209
210 // Verify list, and creates data if needed
211 for( unsigned ii = 0; ii < commandToUndo->GetCount(); ii++ )
212 {
213 SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( commandToUndo->GetPickedItem( ii ) );
214
215 // Common items implemented in EDA_DRAW_FRAME will not be SCH_ITEMs.
216 if( !sch_item )
217 continue;
218
219 UNDO_REDO command = commandToUndo->GetPickedItemStatus( ii );
220
221 if( command == UNDO_REDO::UNSPECIFIED )
222 {
223 command = aTypeCommand;
224 commandToUndo->SetPickedItemStatus( command, ii );
225 }
226
227 switch( command )
228 {
229 case UNDO_REDO::CHANGED:
230
231 /* If needed, create a copy of item, and put in undo list
232 * in the picker, as link
233 * If this link is not null, the copy is already done
234 */
235 if( commandToUndo->GetPickedItemLink( ii ) == nullptr )
236 commandToUndo->SetPickedItemLink( sch_item->Duplicate( true ), ii );
237
238 wxASSERT( commandToUndo->GetPickedItemLink( ii ) );
239 break;
240
241 case UNDO_REDO::NEWITEM:
242 case UNDO_REDO::DELETED:
243 case UNDO_REDO::PAGESETTINGS:
244 break;
245
246 default:
247 wxFAIL_MSG( wxString::Format( wxT( "Unknown undo/redo command %d" ), command ) );
248 break;
249 }
250 }
251
252 if( commandToUndo->GetCount() )
253 {
254 /* Save the copy in undo list */
255 PushCommandToUndoList( commandToUndo );
256
257 /* Clear redo list, because after new save there is no redo to do */
259 }
260 else // Should not occur
261 {
262 delete commandToUndo;
263 }
264}
265
266
268{
269 std::vector<SCH_ITEM*> bulkAddedItems;
270 std::vector<SCH_ITEM*> bulkRemovedItems;
271 std::vector<SCH_ITEM*> bulkChangedItems;
272 std::set<SCH_TABLE*> changedTables;
273 bool dirtyConnectivity = false;
274 bool rebuildHierarchyNavigator = false;
275 SCH_CLEANUP_FLAGS connectivityCleanUp = NO_CLEANUP;
276
277 // Undo in the reverse order of list creation: (this can allow stacked changes like the
278 // same item can be changed and deleted in the same complex command).
279 // After hitting 0, subtracting 1 will roll the value over to its max representation
280 for( unsigned ii = aList->GetCount() - 1; ii < std::numeric_limits<unsigned>::max(); ii-- )
281 {
282 UNDO_REDO status = aList->GetPickedItemStatus( ii );
283 EDA_ITEM* eda_item = aList->GetPickedItem( ii );
284 SCH_SCREEN* screen = dynamic_cast<SCH_SCREEN*>( aList->GetScreenForItem( ii ) );
285
286 wxCHECK( screen, /* void */ );
287
288 eda_item->SetFlags( aList->GetPickerFlags( ii ) );
289 eda_item->ClearEditFlags();
290 eda_item->ClearTempFlags();
291
292 SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( eda_item );
293
294 // Set connectable object connectivity status.
295 auto updateConnectivityFlag = [&, this]()
296 {
297 if( schItem && schItem->IsConnectable() )
298 {
299 schItem->SetConnectivityDirty();
300
301 if( schItem->Type() == SCH_SYMBOL_T )
302 {
303 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( schItem );
304
305 wxCHECK( symbol, /* void */ );
306
307 for( SCH_PIN* pin : symbol->GetPins() )
308 pin->SetConnectivityDirty();
309 }
310 else if( schItem->Type() == SCH_SHEET_T )
311 {
312 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( schItem );
313
314 wxCHECK( sheet, /* void */ );
315
316 for( SCH_SHEET_PIN* pin : sheet->GetPins() )
317 pin->SetConnectivityDirty();
318 }
319
321 dirtyConnectivity = true;
322
323 // Do a local clean up if there are any connectable objects in the commit.
324 if( connectivityCleanUp == NO_CLEANUP )
325 connectivityCleanUp = LOCAL_CLEANUP;
326
327 // Do a full rebauild of the connectivity if there is a sheet in the commit.
328 if( schItem->Type() == SCH_SHEET_T )
329 connectivityCleanUp = GLOBAL_CLEANUP;
330 }
331 };
332
333 if( status == UNDO_REDO::NEWITEM )
334 {
335 updateConnectivityFlag();
336
337 // If we are removing the current sheet, get out first
338 if( eda_item->Type() == SCH_SHEET_T )
339 {
340 rebuildHierarchyNavigator = true;
341
342 if( static_cast<SCH_SHEET*>( eda_item )->GetScreen() == GetScreen() )
344 }
345
346 RemoveFromScreen( eda_item, screen );
347 aList->SetPickedItemStatus( UNDO_REDO::DELETED, ii );
348
349 bulkRemovedItems.emplace_back( schItem );
350 }
351 else if( status == UNDO_REDO::DELETED )
352 {
353 if( eda_item->Type() == SCH_SHEET_T )
354 rebuildHierarchyNavigator = true;
355
356 updateConnectivityFlag();
357
358 // deleted items are re-inserted on undo
359 AddToScreen( eda_item, screen );
360 aList->SetPickedItemStatus( UNDO_REDO::NEWITEM, ii );
361
362 bulkAddedItems.emplace_back( schItem );
363 }
364 else if( status == UNDO_REDO::PAGESETTINGS )
365 {
367
368 if( GetCurrentSheet() != undoSheet )
369 {
370 SetCurrentSheet( undoSheet );
372 }
373
374 // swap current settings with stored settings
375 DS_PROXY_UNDO_ITEM alt_item( this );
376 DS_PROXY_UNDO_ITEM* item = static_cast<DS_PROXY_UNDO_ITEM*>( eda_item );
377 item->Restore( this );
378 *item = std::move( alt_item );
379 }
380 else if( schItem )
381 {
382 SCH_ITEM* itemCopy = dynamic_cast<SCH_ITEM*>( aList->GetPickedItemLink( ii ) );
383
384 wxCHECK2( itemCopy, continue );
385
386 if( schItem->HasConnectivityChanges( itemCopy, &GetCurrentSheet() ) )
387 updateConnectivityFlag();
388
389 // The root sheet is a pseudo object that owns the root screen object but is not on
390 // the root screen so do not attempt to remove it from the screen it owns.
391 if( schItem != &Schematic().Root() )
392 RemoveFromScreen( schItem, screen );
393
394 switch( status )
395 {
396 case UNDO_REDO::CHANGED:
397 if( schItem->Type() == SCH_SHEET_T )
398 {
399 const SCH_SHEET* origSheet = static_cast<const SCH_SHEET*>( schItem );
400 const SCH_SHEET* copySheet = static_cast<const SCH_SHEET*>( schItem );
401
402 wxCHECK2( origSheet && copySheet, continue );
403
404 if( ( origSheet->GetName() != copySheet->GetName() )
405 || ( origSheet->GetFileName() != copySheet->GetFileName() ) )
406 {
407 rebuildHierarchyNavigator = true;
408 }
409 }
410
411 schItem->SwapData( itemCopy );
412 bulkChangedItems.emplace_back( schItem );
413
414 // Special cases for items which have instance data
415 if( schItem->GetParent() && schItem->GetParent()->Type() == SCH_SYMBOL_T
416 && schItem->Type() == SCH_FIELD_T )
417 {
418 SCH_FIELD* field = static_cast<SCH_FIELD*>( schItem );
419 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( schItem->GetParent() );
420
421 if( field->GetId() == REFERENCE_FIELD )
422 {
424 symbol->SetRef( &sheet, field->GetText() );
425 }
426
427 bulkChangedItems.emplace_back( symbol );
428 }
429
430 break;
431
432 default:
433 wxFAIL_MSG( wxString::Format( wxT( "Unknown undo/redo command %d" ),
434 aList->GetPickedItemStatus( ii ) ) );
435 break;
436 }
437
438 if( schItem->Type() == SCH_SYMBOL_T )
439 {
440 SCH_SYMBOL* sym = static_cast<SCH_SYMBOL*>( schItem );
441 sym->UpdatePins();
442 }
443
444 if( schItem != &Schematic().Root() )
445 AddToScreen( schItem, screen );
446 }
447 }
448
450
451 // Notify our listeners
452 if( bulkAddedItems.size() > 0 )
453 Schematic().OnItemsAdded( bulkAddedItems );
454
455 if( bulkRemovedItems.size() > 0 )
456 Schematic().OnItemsRemoved( bulkRemovedItems );
457
458 if( bulkChangedItems.size() > 0 )
459 Schematic().OnItemsChanged( bulkChangedItems );
460
461 if( dirtyConnectivity )
462 {
463 wxLogTrace( wxS( "CONN_PROFILE" ),
464 wxS( "Undo/redo %s clean up connectivity rebuild." ),
465 ( connectivityCleanUp == LOCAL_CLEANUP ) ? wxS( "local" ) : wxS( "global" ) );
466
467 SCH_COMMIT localCommit( m_toolManager );
468
469 RecalculateConnections( &localCommit, connectivityCleanUp );
470
471 // Update the hierarchy navigator when there are sheet changes.
472 if( connectivityCleanUp == GLOBAL_CLEANUP )
473 {
475
476 if( rebuildHierarchyNavigator )
478 }
479 }
480}
481
482
484{
486
487 // Skip empty frames
488 while( undo && !undo->GetCount() )
489 {
490 delete undo;
492 }
493
494 if( undo )
495 {
497 undo->ClearListAndDeleteItems( []( EDA_ITEM* aItem )
498 {
499 delete aItem;
500 } );
501
502 delete undo;
503
504 m_toolManager->GetTool<EE_SELECTION_TOOL>()->RebuildSelection();
505 }
506
507 GetCanvas()->Refresh();
508}
509
510
512{
513 if( aItemCount == 0 )
514 return;
515
516 UNDO_REDO_CONTAINER& list = ( whichList == UNDO_LIST ) ? m_undoList : m_redoList;
517
518 if( aItemCount < 0 )
519 {
520 list.ClearCommandList();
521 }
522 else
523 {
524 for( int ii = 0; ii < aItemCount; ii++ )
525 {
526 if( list.m_CommandsList.size() == 0 )
527 break;
528
529 PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
530 list.m_CommandsList.erase( list.m_CommandsList.begin() );
531
532 curr_cmd->ClearListAndDeleteItems( []( EDA_ITEM* aItem )
533 {
534 delete aItem;
535 } );
536 delete curr_cmd; // Delete command
537 }
538 }
539}
540
541
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.
UNDO_REDO_CONTAINER m_undoList
UNDO_REDO_LIST
Specifies whether we are interacting with the undo or redo stacks.
UNDO_REDO_CONTAINER m_redoList
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:123
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
void ClearTempFlags()
Definition: eda_item.h:149
EDA_ITEM * GetParent() const
Definition: eda_item.h:99
void ClearEditFlags()
Definition: eda_item.h:137
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:126
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:95
static TOOL_ACTION leaveSheet
Definition: ee_actions.h:217
void SetLink(EDA_ITEM *aItem)
void SetFlags(EDA_ITEM_FLAGS aFlags)
void ClearHiddenFlags()
Clear the hide flag of all items in the view.
Definition: sch_view.cpp:185
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.
void SetDescription(const wxString &aDescription)
UNDO_REDO GetPickedItemStatus(unsigned int aIdx) const
ITEM_PICKER GetItemWrapper(unsigned int aIdx) const
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
wxString GetDescription() const
unsigned GetCount() const
void CopyList(const PICKED_ITEMS_LIST &aSource)
Copy all data from aSource to the list.
bool SetPickedItemLink(EDA_ITEM *aLink, unsigned aIdx)
Set the link associated to a given picked item.
void ClearListAndDeleteItems(std::function< void(EDA_ITEM *)> aItemDeleter)
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
BASE_SCREEN * GetScreenForItem(unsigned int aIdx) const
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
void OnItemsAdded(std::vector< SCH_ITEM * > &aNewItems)
Must be used if Add() is used using a BULK_x ADD_MODE to generate a change event for listeners.
Definition: schematic.cpp:766
void OnItemsRemoved(std::vector< SCH_ITEM * > &aRemovedItems)
Must be used if Remove() is used using a BULK_x REMOVE_MODE to generate a change event for listeners.
Definition: schematic.cpp:772
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:100
SCH_SHEET & Root() const
Definition: schematic.h:105
void OnItemsChanged(std::vector< SCH_ITEM * > &aItems)
Notify the schematic and its listeners that an item on the schematic has been modified in some way.
Definition: schematic.cpp:778
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void RemoveFromScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen)
Remove an item from the screen (and view) aScreen is the screen the item is located on,...
wxString Name(bool aIgnoreSheet=false) const
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void RollbackSchematicFromUndo()
Perform an undo of the last edit WITHOUT logging a corresponding redo.
bool m_highlightedConnChanged
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SaveCopyInUndoList(SCH_SCREEN *aScreen, SCH_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, bool aAppend, bool aDirtyConnectivity=true)
Create a copy of the current schematic item, and put it in the undo list.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Free the undo or redo list from aList element.
SCHEMATIC * m_schematic
The currently loaded schematic.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
void DisplayCurrentSheet()
Draw the current sheet on the display.
void PutDataInPreviousState(PICKED_ITEMS_LIST *aList)
Restore an undo or redo command to put data pointed by aList in the previous state.
void UpdateHierarchyNavigator()
Update the hierarchy navigation tree and history.
wxString m_highlightedConn
The highlighted net or bus or empty string.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:52
int GetId() const
Definition: sch_field.h:128
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:165
virtual bool IsConnectable() const
Definition: sch_item.h:389
virtual void SwapData(SCH_ITEM *aItem)
Swap the internal data structures aItem with the schematic item.
Definition: sch_item.cpp:261
void SetConnectivityDirty(bool aDirty=true)
Definition: sch_item.h:455
bool IsConnectivityDirty() const
Definition: sch_item.h:453
virtual bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const
Check if aItem has connectivity changes against this object.
Definition: sch_item.h:472
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition: sch_item.cpp:147
SCH_ITEM * Duplicate(bool doClone=false) const
Routine to create a new copy of given item.
Definition: sch_item.cpp:94
SCH_SHEET_PATH FindSheetForScreen(const SCH_SCREEN *aScreen)
Return the first SCH_SHEET_PATH object (not necessarily the only one) using a particular screen.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
wxString GetFileName() const
Return the filename corresponding to this sheet.
Definition: sch_sheet.h:308
wxString GetName() const
Definition: sch_sheet.h:107
std::vector< SCH_SHEET_PIN * > & GetPins()
Definition: sch_sheet.h:181
Schematic symbol object.
Definition: sch_symbol.h:109
void UpdatePins()
Updates the cache of SCH_PIN objects for each pin.
Definition: sch_symbol.cpp:341
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Definition: sch_symbol.cpp:793
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve a list of the SCH_PINs for the given sheet path.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:167
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
bool PostAction(const std::string &aActionName, T aParam)
Run the specified action after the current action (coroutine) ends.
Definition: tool_manager.h:230
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
SCH_CLEANUP_FLAGS
@ LOCAL_CLEANUP
@ NO_CLEANUP
@ GLOBAL_CLEANUP
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
@ SCH_SYMBOL_T
Definition: typeinfo.h:160
@ SCH_FIELD_T
Definition: typeinfo.h:159
@ SCH_SHEET_T
Definition: typeinfo.h:162
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...