KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
BOARD_COMMIT Class Reference

#include <board_commit.h>

Inheritance diagram for BOARD_COMMIT:
COMMIT

Public Member Functions

 BOARD_COMMIT (EDA_DRAW_FRAME *aFrame)
 
 BOARD_COMMIT (TOOL_BASE *aTool)
 
 BOARD_COMMIT (TOOL_MANAGER *aMgr)
 
 BOARD_COMMIT (TOOL_MANAGER *aMgr, bool aIsBoardEditor)
 
virtual ~BOARD_COMMIT ()
 
BOARD * GetBoard () const
 
virtual void Push (const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
 Revert the commit by restoring the modified items state.
 
virtual void Revert () override
 
COMMIT & Stage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) override
 
COMMIT & Stage (std::vector< EDA_ITEM * > &container, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr) override
 
COMMIT & Stage (const PICKED_ITEMS_LIST &aItems, UNDO_REDO aModFlag=UNDO_REDO::UNSPECIFIED, BASE_SCREEN *aScreen=nullptr) override
 Execute the changes.
 
COMMIT & Add (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Notify observers that aItem has been added.
 
COMMIT & Added (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Remove a new item from the model.
 
COMMIT & Remove (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Notify observers that aItem has been removed.
 
COMMIT & Removed (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Modify a given item in the model.
 
COMMIT & Modify (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Create an undo entry for an item that has been already modified.
 
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.
 
bool Empty () const
 Returns status of an item.
 
int GetStatus (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 
EDA_ITEM * GetFirst () const
 

Static Public Member Functions

static EDA_ITEM * MakeImage (EDA_ITEM *aItem)
 

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.
 
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
 

Private Member Functions

EDA_ITEM * parentObject (EDA_ITEM *aItem) const override
 
EDA_ITEM * makeImage (EDA_ITEM *aItem) const override
 
void dirtyIntersectingZones (BOARD_ITEM *item, int aChangeType)
 

Private Attributes

TOOL_MANAGER * m_toolMgr
 
bool m_isBoardEditor
 
bool m_isFootprintEditor
 

Detailed Description

Definition at line 46 of file board_commit.h.

Constructor & Destructor Documentation

◆ BOARD_COMMIT() [1/4]

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME *  aFrame)

Definition at line 59 of file board_commit.cpp.

◆ BOARD_COMMIT() [2/4]

BOARD_COMMIT::BOARD_COMMIT ( TOOL_BASE *  aTool)

Definition at line 46 of file board_commit.cpp.

References m_isBoardEditor, and m_isFootprintEditor.

◆ BOARD_COMMIT() [3/4]

BOARD_COMMIT::BOARD_COMMIT ( TOOL_MANAGER *  aMgr)

Definition at line 67 of file board_commit.cpp.

References FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, TOOL_MANAGER::GetToolHolder(), EDA_BASE_FRAME::IsType(), m_isBoardEditor, and m_isFootprintEditor.

◆ BOARD_COMMIT() [4/4]

BOARD_COMMIT::BOARD_COMMIT ( TOOL_MANAGER *  aMgr,
bool  aIsBoardEditor 
)

Definition at line 80 of file board_commit.cpp.

◆ ~BOARD_COMMIT()

virtual BOARD_COMMIT::~BOARD_COMMIT ( )
inlinevirtual

Definition at line 54 of file board_commit.h.

Member Function Documentation

◆ Add()

COMMIT & COMMIT::Add ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
inlineinherited

Notify observers that aItem has been added.

Definition at line 80 of file commit.h.

References CHT_ADD, and COMMIT::Stage().

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), RULE_AREA_CREATE_HELPER::commitRuleArea(), ZONE_CREATE_HELPER::commitZone(), MULTICHANNEL_TOOL::copyRuleAreaContents(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditStart(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), GRAPHICS_CLEANER::fixBoardOutlines(), GROUP_TOOL::Group(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), SCH_DRAWING_TOOLS::ImportGraphics(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCBNEW_JOBS_HANDLER::JobExportDrc(), EE_SELECTION_TOOL::Main(), GRAPHICS_CLEANER::mergeRects(), ARRAY_TOOL::onDialogClosed(), 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(), MULTICHANNEL_TOOL::RepeatLayout(), PCB_EDIT_FRAME::ResolveDRCExclusions(), Revert(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

◆ Added()

COMMIT & COMMIT::Added ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
inlineinherited

Remove a new item from the model.

Definition at line 86 of file commit.h.

References CHT_ADD, CHT_DONE, and COMMIT::Stage().

Referenced by SCH_EDIT_FRAME::AddJunction(), TEARDROP_MANAGER::AddTeardropsOnTracks(), SCH_EDIT_FRAME::BreakSegment(), SCH_EDIT_TOOL::ChangeTextType(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_DRAWING_TOOLS::ImportSheet(), 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()

void COMMIT::clear ( )
inlineprotectedinherited

Definition at line 165 of file commit.h.

References COMMIT::m_changedItems, COMMIT::m_changes, and COMMIT::m_deletedItems.

Referenced by Push(), SCH_COMMIT::pushLibEdit(), SCH_COMMIT::pushSchEdit(), SCH_COMMIT::Revert(), Revert(), and SCH_COMMIT::revertLibEdit().

◆ convert() [1/2]

UNDO_REDO COMMIT::convert ( CHANGE_TYPE  aType) const
protectedinherited

Definition at line 200 of file commit.cpp.

References CHT_ADD, CHT_GROUP, CHT_MODIFY, CHT_REMOVE, and CHT_UNGROUP.

◆ convert() [2/2]

CHANGE_TYPE COMMIT::convert ( UNDO_REDO  aType) const
protectedinherited

Definition at line 186 of file commit.cpp.

References CHT_ADD, CHT_GROUP, CHT_MODIFY, CHT_REMOVE, and CHT_UNGROUP.

◆ createModified()

COMMIT & COMMIT::createModified ( EDA_ITEM *  aItem,
EDA_ITEM *  aCopy,
int  aExtraFlags = 0,
BASE_SCREEN *  aScreen = nullptr 
)
protectedinherited

Definition at line 138 of file commit.cpp.

References CHT_MODIFY, COMMIT::m_changedItems, COMMIT::makeEntry(), and COMMIT::parentObject().

Referenced by COMMIT::Modified(), and COMMIT::Stage().

◆ dirtyIntersectingZones()

void BOARD_COMMIT::dirtyIntersectingZones ( BOARD_ITEM *  item,
int  aChangeType 
)
private

Definition at line 128 of file board_commit.cpp.

References LSET::AllCuMask(), dirtyIntersectingZones(), ZONE_FILLER_TOOL::DirtyZone(), Edge_Cuts, EDA_ITEM::GetBoundingBox(), BOARD_ITEM::GetLayerSet(), TOOL_MANAGER::GetModel(), TOOL_MANAGER::GetTool(), m_toolMgr, Margin, PCB_ZONE_T, LSET::PhysicalLayersMask(), BOARD_ITEM::RunOnChildren(), EDA_ITEM::Type(), and BOARD::Zones().

Referenced by dirtyIntersectingZones(), and Push().

◆ Empty()

bool COMMIT::Empty ( ) const
inlineinherited

Returns status of an item.

Definition at line 144 of file commit.h.

References COMMIT::m_changes.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SCH_EDIT_TOOL::editFieldText(), EDIT_TOOL::Flip(), GENERATOR_TOOL::GenEditAction(), SCH_EDITOR_CONTROL::IncrementAnnotations(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), EE_POINT_EDITOR::Main(), EE_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), HIERARCHY_PANE::onTreeEditFinished(), 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_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLECELL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and SCH_EDIT_TOOL::UnsetAttribute().

◆ findEntry()

COMMIT::COMMIT_LINE * COMMIT::findEntry ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
protectedinherited

Search for an entry describing change for a particular item.

Returns
null if there is no related entry.

Definition at line 174 of file commit.cpp.

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

◆ GetBoard()

BOARD * BOARD_COMMIT::GetBoard ( ) const

Definition at line 88 of file board_commit.cpp.

References TOOL_MANAGER::GetModel(), and m_toolMgr.

Referenced by GRAPHICS_CLEANER::CleanupBoard().

◆ GetFirst()

EDA_ITEM * COMMIT::GetFirst ( ) const
inlineinherited

Definition at line 152 of file commit.h.

References COMMIT::m_changes.

◆ GetStatus()

int COMMIT::GetStatus ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
inherited

Definition at line 130 of file commit.cpp.

References COMMIT::findEntry(), COMMIT::COMMIT_LINE::m_type, and COMMIT::parentObject().

Referenced by MULTICHANNEL_TOOL::copyRuleAreaContents(), GENERATOR_TOOL::GENERATOR_TOOL(), GRAPHICS_CLEANER::mergePads(), BOARD_EDITOR_CONTROL::modifyLockSelected(), Revert(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ makeEntry()

void COMMIT::makeEntry ( EDA_ITEM *  aItem,
CHANGE_TYPE  aType,
EDA_ITEM *  aCopy = nullptr,
BASE_SCREEN *  aScreen = nullptr 
)
protectedvirtualinherited

Definition at line 154 of file commit.cpp.

References CHT_MODIFY, CHT_TYPE, COMMIT::m_changedItems, COMMIT::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 COMMIT::createModified(), and COMMIT::Stage().

◆ MakeImage()

EDA_ITEM * BOARD_COMMIT::MakeImage ( EDA_ITEM *  aItem)
static

Definition at line 611 of file board_commit.cpp.

References EDA_ITEM::Clone(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), EDA_ITEM::SetFlags(), and UR_TRANSIENT.

Referenced by makeImage(), and PCB_BASE_EDIT_FRAME::saveCopyInUndoList().

◆ makeImage()

EDA_ITEM * BOARD_COMMIT::makeImage ( EDA_ITEM *  aItem) const
overrideprivatevirtual

Implements COMMIT.

Definition at line 605 of file board_commit.cpp.

References MakeImage().

◆ Modified()

COMMIT & COMMIT::Modified ( EDA_ITEM *  aItem,
EDA_ITEM *  aCopy,
BASE_SCREEN *  aScreen = nullptr 
)
inlineinherited

Definition at line 112 of file commit.h.

References COMMIT::createModified().

Referenced by DIALOG_CHANGE_SYMBOLS::processSymbols(), COMMIT::Stage(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ Modify()

COMMIT & COMMIT::Modify ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
inlineinherited

Create an undo entry for an item that has been already modified.

Requires a copy done before the modification.

Definition at line 105 of file commit.h.

References CHT_MODIFY, and COMMIT::Stage().

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::applyChangelist(), SCH_EDIT_TOOL::AutoplaceFields(), AR_AUTOPLACER::AutoplaceFootprints(), SCH_EDIT_FRAME::BreakSegment(), PCB_POINT_EDITOR::chamferCorner(), SCH_EDIT_TOOL::ChangeBodyStyle(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), MULTICHANNEL_TOOL::copyRuleAreaContents(), 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(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), EDIT_TOOL::DragArcTrack(), RECTANGLE_POINT_EDIT_BEHAVIOR::dragPinsOnEdge(), DRAWING_TOOL::DrawVia(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), 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_EDIT_FRAME::FlipBodyStyle(), GENERATOR_TOOL::GENERATOR_TOOL(), SCH_MOVE_TOOL::getConnectedDragItems(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), SCH_EDITOR_CONTROL::IncrementAnnotations(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), 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(), ARRAY_TOOL::onDialogClosed(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), HIERARCHY_PANE::onTreeEditFinished(), SCH_MOVE_TOOL::orthoLineDrag(), EDIT_TOOL::PackAndMoveFootprints(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), CN_CONNECTIVITY_ALGO::propagateConnections(), SCH_EDIT_TOOL::Properties(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), EE_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), HIERARCHY_PANE::renameIdenticalSheets(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), 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(), SCH_SYMBOL::SyncOtherUnits(), 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_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLECELL_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_FIELD_PROPERTIES::UpdateField(), PCB_POINT_EDITOR::updateItem(), SCH_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), LINE_POINT_EDIT_BEHAVIOR::UpdateItem(), DIALOG_UNUSED_PAD_LAYERS::updatePadsAndVias(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), GLOBAL_EDIT_TOOL::ZonesManager(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ parentObject()

EDA_ITEM * BOARD_COMMIT::parentObject ( EDA_ITEM *  aItem) const
overrideprivatevirtual

Implements COMMIT.

Definition at line 599 of file board_commit.cpp.

◆ Push()

void BOARD_COMMIT::Push ( const wxString &  aMessage = wxEmptyString,
int  aFlags = 0 
)
overridevirtual

Revert the commit by restoring the modified items state.

Implements COMMIT.

Definition at line 165 of file board_commit.cpp.

References BOARD::Add(), FOOTPRINT::Add(), KIGFX::VIEW::Add(), PCB_GROUP::AddItem(), APPEND_UNDO, PCB_BASE_FRAME::AppendCopyToUndoList(), AS_GLOBAL, B_Mask, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_GROUP, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, CHT_UNGROUP, COMMIT::clear(), EDA_ITEM::ClearEditFlags(), convert, dirtyIntersectingZones(), COMMIT::Empty(), F_Mask, PCB_BASE_FRAME::GetCanvas(), EDA_ITEM::GetClass(), BOARD::GetConnectivity(), PCB_SELECTION_TOOL::GetEnteredGroup(), BOARD::GetFirstFootprint(), EDA_ITEM::GetFlags(), TOOL_MANAGER::GetModel(), BOARD::GetMsgPanelInfo(), BOARD_ITEM::GetParentFootprint(), BOARD_ITEM::GetParentGroup(), PCB_BASE_FRAME::GetPcbNewSettings(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetView(), group, PCB_BASE_FRAME::HideSolderMask(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), PCB_GROUP::IsGroupableType(), BOARD_ITEM::IsOnLayer(), EDA_ITEM::IsSelected(), PCBNEW_SETTINGS::m_AutoRefillZones, COMMIT::m_changes, COMMIT::COMMIT_LINE::m_copy, PCBNEW_SETTINGS::m_Display, m_isBoardEditor, m_isFootprintEditor, COMMIT::COMMIT_LINE::m_item, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_Live3DRefresh, m_toolMgr, COMMIT::COMMIT_LINE::m_type, EDA_ITEM::m_Uuid, BOARD::OnItemsCompositeUpdate(), PCB_BASE_FRAME::OnModify(), BOARD::OnRatsnestChanged(), pad, FOOTPRINT::Pads(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_MARKER_T, PCB_NETINFO_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, TOOL_MANAGER::PostAction(), TOOL_MANAGER::PostEvent(), TOOL_MANAGER::ProcessEvent(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), BOARD::Remove(), FOOTPRINT::Remove(), KIGFX::VIEW::Remove(), PCB_GROUP::RemoveItem(), SELECTION_TOOL::RemoveItemFromSel(), TEARDROP_MANAGER::RemoveTeardrops(), BOARD_ITEM::RunOnDescendants(), PCB_BASE_FRAME::SaveCopyInUndoList(), EVENTS::SelectedItemsModified, EDA_ITEM::SetFlags(), ITEM_PICKER::SetGroupId(), ITEM_PICKER::SetLink(), EDA_DRAW_FRAME::SetMsgPanel(), SKIP_CONNECTIVITY, SKIP_SET_DIRTY, SKIP_TEARDROPS, SKIP_UNDO, STRUCT_DELETED, TA_MODEL_CHANGE, TC_MESSAGE, EDA_ITEM::Type(), UNIMPLEMENTED_FOR, EVENTS::UnselectedEvent, KIGFX::VIEW::Update(), PCB_BASE_FRAME::Update3DView(), BOARD::UpdateRatsnestExclusions(), TEARDROP_MANAGER::UpdateTeardrops(), UR_TRANSIENT, via, ZONE_FILL_OP, PCB_ACTIONS::zoneFillDirty, and BOARD::Zones().

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_CONTROL::AppendBoard(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), AUTOPLACE_TOOL::autoplace(), PCB_POINT_EDITOR::chamferCorner(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), ZONE_CREATE_HELPER::commitZone(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawTable(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EditPad(), PCB_GENERATOR::EditPush(), PCB_TUNING_PATTERN::EditPush(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), KI_TEST::FillZones(), EDIT_TOOL::Flip(), GROUP_TOOL::Group(), EDIT_TOOL::Increment(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCBNEW_JOBS_HANDLER::JobExportDrc(), EDIT_TOOL::JustifyText(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::movePoint(), ARRAY_TOOL::onDialogClosed(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::PackAndMoveFootprints(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ZONE_CREATE_HELPER::performZoneCutout(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PAD_TOOL::pushPadSettings(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), PCB_TUNING_PATTERN::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), MULTICHANNEL_TOOL::RepeatLayout(), PCB_EDIT_FRAME::ResolveDRCExclusions(), EDIT_TOOL::Rotate(), PCB_EDIT_FRAME::RunActionPlugin(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), DRAWING_TOOL::SetAnchor(), EDIT_TOOL::Swap(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), GROUP_TOOL::Ungroup(), BOARD_NETLIST_UPDATER::UpdateNetlist(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillDirty(), BOARD_EDITOR_CONTROL::ZoneMerge(), GLOBAL_EDIT_TOOL::ZonesManager(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ Remove()

COMMIT & COMMIT::Remove ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
inlineinherited

Notify observers that aItem has been removed.

Definition at line 92 of file commit.h.

References CHT_REMOVE, and COMMIT::Stage().

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), GRAPHICS_CLEANER::cleanupShapes(), MULTICHANNEL_TOOL::copyRuleAreaContents(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), API_HANDLER_PCB::deleteItemsInternal(), 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(), GROUP_TOOL::Ungroup(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ Removed()

COMMIT & COMMIT::Removed ( EDA_ITEM *  aItem,
BASE_SCREEN *  aScreen = nullptr 
)
inlineinherited

Modify a given item in the model.

Must be called before modification is performed.

Definition at line 98 of file commit.h.

References CHT_DONE, CHT_REMOVE, and COMMIT::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()

void BOARD_COMMIT::Revert ( )
overridevirtual

Implements COMMIT.

Definition at line 624 of file board_commit.cpp.

References BOARD::Add(), COMMIT::Add(), KIGFX::VIEW::Add(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::GetClass(), BOARD::GetConnectivity(), BOARD::GetItem(), TOOL_MANAGER::GetModel(), BOARD_ITEM::GetParentFootprint(), BOARD_ITEM::GetParentGroup(), COMMIT::GetStatus(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetView(), group, BOARD::IncrementTimeStamp(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), COMMIT::m_changes, COMMIT::COMMIT_LINE::m_copy, m_isBoardEditor, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_parent, m_toolMgr, COMMIT::COMMIT_LINE::m_type, BOARD::OnItemsCompositeUpdate(), BOARD::OnRatsnestChanged(), PCB_FOOTPRINT_T, TOOL_MANAGER::PostEvent(), PCB_SELECTION_TOOL::RebuildSelection(), BOARD::Remove(), KIGFX::VIEW::Remove(), EVENTS::SelectedItemsModified, BOARD_ITEM::SetParentGroup(), BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), UNIMPLEMENTED_FOR, and BOARD::UpdateRatsnestExclusions().

Referenced by PCB_CONTROL::AppendBoard(), AUTOPLACE_TOOL::autoplace(), ZONE_FILLER_TOOL::CheckAllZones(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::Duplicate(), PCB_GENERATOR::EditRevert(), PCB_TUNING_PATTERN::EditRevert(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), mergeZones(), EDIT_TOOL::Move(), PCB_POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::PackAndMoveFootprints(), PCB_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), MULTICHANNEL_TOOL::RepeatLayout(), ZONE_FILLER_TOOL::ZoneFill(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ Stage() [1/3]

COMMIT & BOARD_COMMIT::Stage ( const PICKED_ITEMS_LIST &  aItems,
UNDO_REDO  aModFlag = UNDO_REDO::UNSPECIFIED,
BASE_SCREEN *  aScreen = nullptr 
)
overridevirtual

Execute the changes.

Reimplemented from COMMIT.

Definition at line 121 of file board_commit.cpp.

References COMMIT::Stage().

◆ Stage() [2/3]

COMMIT & BOARD_COMMIT::Stage ( EDA_ITEM *  aItem,
CHANGE_TYPE  aChangeType,
BASE_SCREEN *  aScreen = nullptr 
)
overridevirtual

Reimplemented from COMMIT.

Definition at line 94 of file board_commit.cpp.

References CHT_MODIFY, group, COMMIT::Stage(), and Stage().

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), EDIT_TOOL::DeleteItems(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCenters(), ALIGN_DISTRIBUTE_TOOL::doDistributeGaps(), PCB_TUNING_PATTERN::EditPush(), GROUP_TOOL::Group(), PCB_POINT_EDITOR::movePoint(), DRAWING_TOOL::PlaceImportedGraphics(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), PCB_TUNING_PATTERN::Remove(), GROUP_TOOL::RemoveFromGroup(), MULTICHANNEL_TOOL::RepeatLayout(), Stage(), GROUP_TOOL::Ungroup(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ Stage() [3/3]

COMMIT & BOARD_COMMIT::Stage ( std::vector< EDA_ITEM * > &  container,
CHANGE_TYPE  aChangeType,
BASE_SCREEN *  aScreen = nullptr 
)
overridevirtual

Reimplemented from COMMIT.

Definition at line 114 of file board_commit.cpp.

References COMMIT::Stage().

◆ StageItems()

template<class Range >
COMMIT & COMMIT::StageItems ( const Range &  aRange,
CHANGE_TYPE  aChangeType 
)
inlineinherited

Add a change of the item aItem of type aChangeType to the change list.

Definition at line 119 of file commit.h.

References COMMIT::Stage().

Member Data Documentation

◆ m_changedItems

std::set<EDA_ITEM*> COMMIT::m_changedItems
protectedinherited

Definition at line 193 of file commit.h.

Referenced by COMMIT::clear(), COMMIT::createModified(), and COMMIT::makeEntry().

◆ m_changes

std::vector<COMMIT_LINE> COMMIT::m_changes
protectedinherited

Definition at line 195 of file commit.h.

Referenced by COMMIT::clear(), COMMIT::Empty(), COMMIT::findEntry(), COMMIT::GetFirst(), COMMIT::makeEntry(), Push(), SCH_COMMIT::pushLibEdit(), SCH_COMMIT::pushSchEdit(), SCH_COMMIT::Revert(), Revert(), SCH_COMMIT::revertLibEdit(), and COMMIT::~COMMIT().

◆ m_deletedItems

std::set<EDA_ITEM*> COMMIT::m_deletedItems
protectedinherited

Definition at line 194 of file commit.h.

Referenced by COMMIT::clear(), and COMMIT::Stage().

◆ m_isBoardEditor

bool BOARD_COMMIT::m_isBoardEditor
private

Definition at line 80 of file board_commit.h.

Referenced by BOARD_COMMIT(), Push(), and Revert().

◆ m_isFootprintEditor

bool BOARD_COMMIT::m_isFootprintEditor
private

Definition at line 81 of file board_commit.h.

Referenced by BOARD_COMMIT(), and Push().

◆ m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr
private

Definition at line 79 of file board_commit.h.

Referenced by dirtyIntersectingZones(), GetBoard(), Push(), and Revert().

The documentation for this class was generated from the following files: