Represent a set of changes (additions, deletions or modifications) of a data model (e.g. More...
#include <commit.h>
Classes | |
| struct | COMMIT_LINE |
Public Member Functions | |
| COMMIT () | |
| virtual | ~COMMIT () |
| Add a new item to the model. More... | |
| COMMIT & | Add (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| Notify observers that aItem has been added. More... | |
| COMMIT & | Added (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| Remove a new item from the model. More... | |
| COMMIT & | Remove (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| Notify observers that aItem has been removed. More... | |
| COMMIT & | Removed (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| Modify a given item in the model. More... | |
| COMMIT & | Modify (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| Create an undo entry for an item that has been already modified. More... | |
| COMMIT & | Modified (EDA_ITEM *aItem, EDA_ITEM *aCopy, BASE_SCREEN *aScreen=nullptr) |
| template<class Range > | |
| COMMIT & | StageItems (const Range &aRange, CHANGE_TYPE aChangeType) |
| Add a change of the item aItem of type aChangeType to the change list. More... | |
| virtual COMMIT & | Stage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) |
| virtual COMMIT & | Stage (std::vector< EDA_ITEM * > &container, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) |
| virtual COMMIT & | Stage (const PICKED_ITEMS_LIST &aItems, UNDO_REDO aModFlag=UNDO_REDO::UNSPECIFIED, BASE_SCREEN *aScreen=nullptr) |
| Execute the changes. More... | |
| virtual void | Push (const wxString &aMessage=wxT("A commit"), int aFlags=0)=0 |
| Revert the commit by restoring the modified items state. More... | |
| virtual void | Revert ()=0 |
| bool | Empty () const |
| Returns status of an item. More... | |
| int | GetStatus (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| EDA_ITEM * | GetFirst () const |
Protected Member Functions | |
| void | clear () |
| COMMIT & | createModified (EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0, BASE_SCREEN *aScreen=nullptr) |
| virtual void | makeEntry (EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=nullptr, BASE_SCREEN *aScreen=nullptr) |
| COMMIT_LINE * | findEntry (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr) |
| Search for an entry describing change for a particular item. More... | |
| virtual EDA_ITEM * | parentObject (EDA_ITEM *aItem) const =0 |
| virtual EDA_ITEM * | makeImage (EDA_ITEM *aItem) const =0 |
| CHANGE_TYPE | convert (UNDO_REDO aType) const |
| UNDO_REDO | convert (CHANGE_TYPE aType) const |
Protected Attributes | |
| std::set< EDA_ITEM * > | m_changedItems |
| std::set< EDA_ITEM * > | m_deletedItems |
| std::vector< COMMIT_LINE > | m_changes |
Detailed Description
Represent a set of changes (additions, deletions or modifications) of a data model (e.g.
the BOARD) class.
The class can be used to propagate changes to subscribed objects (e.g. views, ratsnest), and automatically create undo/redo points.
Constructor & Destructor Documentation
◆ COMMIT()
| COMMIT::COMMIT | ( | ) |
Definition at line 33 of file commit.cpp.
◆ ~COMMIT()
|
virtual |
Member Function Documentation
◆ Add()
|
inline |
Notify observers that aItem has been added.
Definition at line 78 of file commit.h.
References CHT_ADD, and Stage().
Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), ZONE_CREATE_HELPER::commitZone(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditStart(), PCB_EDIT_FRAME::ExchangeFootprint(), EDIT_TOOL::FilletTracks(), GRAPHICS_CLEANER::fixBoardOutlines(), DRAWING_TOOL::InteractivePlaceWithPreview(), ARRAY_CREATOR::Invoke(), PCBNEW_JOBS_HANDLER::JobExportDrc(), EE_SELECTION_TOOL::Main(), GRAPHICS_CLEANER::mergeRects(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), INTERACTIVE_PLACER_BASE::PlaceItem(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), PCB_TUNING_PATTERN::Remove(), PCB_EDIT_FRAME::ResolveDRCExclusions(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_DRAWING_TOOLS::SchImportGraphics(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().
◆ Added()
|
inline |
Remove a new item from the model.
Definition at line 84 of file commit.h.
References CHT_ADD, CHT_DONE, and Stage().
Referenced by SCH_EDIT_FRAME::AddJunction(), TEARDROP_MANAGER::AddTeardropsOnTracks(), SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_TOOL::ChangeTextType(), SCH_MOVE_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), EE_SELECTION_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and TEARDROP_MANAGER::UpdateTeardrops().
◆ clear()
|
inlineprotected |
Definition at line 163 of file commit.h.
References m_changedItems, m_changes, and m_deletedItems.
Referenced by BOARD_COMMIT::Push(), SCH_COMMIT::pushLibEdit(), SCH_COMMIT::pushSchEdit(), SCH_COMMIT::Revert(), BOARD_COMMIT::Revert(), and SCH_COMMIT::revertLibEdit().
◆ convert() [1/2]
|
protected |
Definition at line 201 of file commit.cpp.
References CHT_ADD, CHT_MODIFY, CHT_REMOVE, and KI_FALLTHROUGH.
◆ convert() [2/2]
|
protected |
Definition at line 181 of file commit.cpp.
References CHT_ADD, CHT_MODIFY, CHT_REMOVE, and KI_FALLTHROUGH.
◆ createModified()
|
protected |
Definition at line 136 of file commit.cpp.
References CHT_MODIFY, m_changedItems, makeEntry(), and parentObject().
Referenced by Modified(), and Stage().
◆ Empty()
|
inline |
Returns status of an item.
Definition at line 142 of file commit.h.
References m_changes.
Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::editFieldText(), EDIT_TOOL::Flip(), GENERATOR_TOOL::GenEditAction(), EE_POINT_EDITOR::Main(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_COMMIT::Push(), SCH_COMMIT::pushLibEdit(), SCH_COMMIT::pushSchEdit(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_COMMIT::revertLibEdit(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_TOOL::SetAttribute(), EDIT_TOOL::Swap(), SCH_EDIT_TOOL::ToggleAttribute(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().
◆ findEntry()
|
protected |
Search for an entry describing change for a particular item.
- Returns
- null if there is no related entry.
Definition at line 169 of file commit.cpp.
References m_changes.
Referenced by GetStatus().
◆ GetFirst()
|
inline |
◆ GetStatus()
| int COMMIT::GetStatus | ( | EDA_ITEM * | aItem, |
| BASE_SCREEN * | aScreen = nullptr |
||
| ) |
Definition at line 128 of file commit.cpp.
References findEntry(), COMMIT::COMMIT_LINE::m_type, and parentObject().
Referenced by GRAPHICS_CLEANER::mergePads(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().
◆ makeEntry()
|
protectedvirtual |
Definition at line 152 of file commit.cpp.
References CHT_MODIFY, CHT_TYPE, m_changedItems, m_changes, COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_screen, and COMMIT::COMMIT_LINE::m_type.
Referenced by createModified(), and Stage().
◆ makeImage()
Implemented in SCH_COMMIT, and BOARD_COMMIT.
Referenced by Stage().
◆ Modified()
|
inline |
Definition at line 110 of file commit.h.
References createModified().
Referenced by Stage(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().
◆ Modify()
|
inline |
Create an undo entry for an item that has been already modified.
Requires a copy done before the modification.
Definition at line 103 of file commit.h.
References CHT_MODIFY, and Stage().
Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), SCH_MOVE_TOOL::AlignElements(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), SCH_EDIT_TOOL::AutoplaceFields(), AR_AUTOPLACER::AutoplaceFootprints(), SCH_EDIT_FRAME::BreakSegment(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_FRAME::ConvertPart(), SCH_EDIT_FRAME::DeleteAnnotation(), EDIT_TOOL::DeleteItems(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), doPushPadProperties(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::editFieldText(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_GENERATOR::EditStart(), PCB_TUNING_PATTERN::EditStart(), PAD_TOOL::EnumeratePads(), ZONE_FILLER::Fill(), EDIT_TOOL::FilletTracks(), GRAPHICS_CLEANER::fixBoardOutlines(), EDIT_TOOL::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), ARRAY_CREATOR::Invoke(), EE_POINT_EDITOR::Main(), TRACKS_CLEANER::mergeCollinearSegments(), GRAPHICS_CLEANER::mergePads(), mergeZones(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_MOVE_TOOL::orthoLineDrag(), EDIT_TOOL::PackAndMoveFootprints(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), DIALOG_CHANGE_SYMBOLS::processSymbols(), CN_CONNECTIVITY_ALGO::propagateConnections(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), EE_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCHEMATIC::SCHEMATIC(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_FRAME::SetAltPinFunction(), DRAWING_TOOL::SetAnchor(), SCH_EDIT_TOOL::SetAttribute(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), EDIT_TOOL::Swap(), SYMBOL_EDITOR_DRAWING_TOOLS::SymbolImportGraphics(), SCH_EDIT_TOOL::ToggleAttribute(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDIT_TOOL::UnsetAttribute(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), DIALOG_UNUSED_PAD_LAYERS::updatePadsAndVias(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().
◆ parentObject()
Implemented in SCH_COMMIT, and BOARD_COMMIT.
Referenced by createModified(), GetStatus(), and Stage().
◆ Push()
|
pure virtual |
Revert the commit by restoring the modified items state.
Implemented in BOARD_COMMIT, and SCH_COMMIT.
Referenced by DIALOG_UNUSED_PAD_LAYERS::updatePadsAndVias().
◆ Remove()
|
inline |
Notify observers that aItem has been removed.
Definition at line 90 of file commit.h.
References CHT_REMOVE, and Stage().
Referenced by GRAPHICS_CLEANER::cleanupShapes(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), SCH_EDIT_TOOL::DoDelete(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::DragArcTrack(), PAD_TOOL::EditPad(), PCB_TUNING_PATTERN::EditPush(), PCB_EDIT_FRAME::ExchangeFootprint(), GRAPHICS_CLEANER::mergeRects(), mergeZones(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_GENERATOR::Remove(), PCB_TUNING_PATTERN::Remove(), PCB_POINT_EDITOR::removeCorner(), and BOARD_NETLIST_UPDATER::UpdateNetlist().
◆ Removed()
|
inline |
Modify a given item in the model.
Must be called before modification is performed.
Definition at line 96 of file commit.h.
References CHT_DONE, CHT_REMOVE, and Stage().
Referenced by SCH_EDIT_TOOL::ChangeTextType(), TRACKS_CLEANER::deleteDanglingTracks(), SCH_EDIT_FRAME::DeleteJunction(), TEARDROP_MANAGER::DeleteTrackToTrackTeardrops(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::removeItems(), TEARDROP_MANAGER::RemoveTeardrops(), NETINFO_LIST::RemoveUnusedNets(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_EDIT_FRAME::SchematicCleanUp(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_EDIT_FRAME::TrimWire(), and TEARDROP_MANAGER::UpdateTeardrops().
◆ Revert()
|
pure virtual |
Implemented in SCH_COMMIT, and BOARD_COMMIT.
◆ Stage() [1/3]
|
virtual |
Execute the changes.
Reimplemented in SCH_COMMIT, and BOARD_COMMIT.
Definition at line 101 of file commit.cpp.
References convert, copy, PICKED_ITEMS_LIST::GetCount(), PICKED_ITEMS_LIST::GetPickedItem(), PICKED_ITEMS_LIST::GetPickedItemLink(), PICKED_ITEMS_LIST::GetPickedItemStatus(), Modified(), and Stage().
◆ Stage() [2/3]
|
virtual |
Reimplemented in SCH_COMMIT, and BOARD_COMMIT.
Definition at line 48 of file commit.cpp.
References CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, createModified(), flag, m_changedItems, m_deletedItems, makeEntry(), makeImage(), and parentObject().
Referenced by Add(), Added(), Modify(), Remove(), Removed(), SCH_COMMIT::Stage(), BOARD_COMMIT::Stage(), Stage(), and StageItems().
◆ Stage() [3/3]
|
virtual |
Reimplemented in SCH_COMMIT, and BOARD_COMMIT.
Definition at line 91 of file commit.cpp.
References Stage().
◆ StageItems()
|
inline |
Add a change of the item aItem of type aChangeType to the change list.
Definition at line 117 of file commit.h.
References Stage().
Referenced by PCB_POINT_EDITOR::OnSelectionChange().
Member Data Documentation
◆ m_changedItems
|
protected |
Definition at line 191 of file commit.h.
Referenced by clear(), createModified(), makeEntry(), and Stage().
◆ m_changes
|
protected |
Definition at line 193 of file commit.h.
Referenced by clear(), Empty(), findEntry(), GetFirst(), makeEntry(), BOARD_COMMIT::Push(), SCH_COMMIT::pushLibEdit(), SCH_COMMIT::pushSchEdit(), SCH_COMMIT::Revert(), BOARD_COMMIT::Revert(), SCH_COMMIT::revertLibEdit(), and ~COMMIT().
◆ m_deletedItems
|
protected |
The documentation for this class was generated from the following files:
