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, bool aIsFootprintEditor)
 
virtual ~BOARD_COMMIT ()
 
BOARD * GetBoard () const
 
virtual void Push (const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
 Execute the changes.
 
virtual void Revert () override
 Revert the commit by restoring the modified items state.
 
COMMIT & Stage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE) override
 Add a change of the item aItem of type aChangeType to the change list.
 
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
 
COMMIT & Add (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Add a new item to the model.
 
COMMIT & Added (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Notify observers that aItem has been added.
 
COMMIT & Remove (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Remove a new item from the model.
 
COMMIT & Removed (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 
COMMIT & Modify (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
 Modify a given item in the model.
 
COMMIT & Modified (EDA_ITEM *aItem, EDA_ITEM *aCopy, BASE_SCREEN *aScreen=nullptr)
 Create an undo entry for an item that has been already modified.
 
void Unstage (EDA_ITEM *aItem, BASE_SCREEN *aScreen)
 
bool Empty () const
 
int GetStatus (EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
 Returns status of an item.
 
EDA_ITEM * GetFirst () const
 

Static Public Member Functions

static EDA_ITEM * MakeImage (EDA_ITEM *aItem)
 

Protected Member Functions

void clear ()
 Should be called in Push() & Revert() methods.
 
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< std::pair< EDA_ITEM *, BASE_SCREEN * > > m_addedItems
 
std::set< std::pair< EDA_ITEM *, BASE_SCREEN * > > m_changedItems
 
std::set< std::pair< EDA_ITEM *, BASE_SCREEN * > > m_deletedItems
 
std::vector< COMMIT_LINE > m_entries
 

Private Member Functions

EDA_ITEM * undoLevelItem (EDA_ITEM *aItem) const override
 
EDA_ITEM * makeImage (EDA_ITEM *aItem) const override
 
void propagateDamage (BOARD_ITEM *aItem, std::vector< ZONE * > *aStaleZones, std::vector< BOX2I > &aStaleRuleAreas)
 

Private Attributes

TOOL_MANAGER * m_toolMgr
 
bool m_isBoardEditor
 
bool m_isFootprintEditor
 

Detailed Description

Definition at line 47 of file board_commit.h.

Constructor & Destructor Documentation

◆ BOARD_COMMIT() [1/4]

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME * aFrame)

Definition at line 66 of file board_commit.cpp.

References COMMIT::COMMIT(), FRAME_FOOTPRINT_EDITOR, FRAME_PCB_EDITOR, m_isBoardEditor, m_isFootprintEditor, and m_toolMgr.

◆ BOARD_COMMIT() [2/4]

BOARD_COMMIT::BOARD_COMMIT ( TOOL_BASE * aTool)

Definition at line 52 of file board_commit.cpp.

References COMMIT::COMMIT(), m_isBoardEditor, m_isFootprintEditor, and m_toolMgr.

◆ BOARD_COMMIT() [3/4]

BOARD_COMMIT::BOARD_COMMIT ( TOOL_MANAGER * aMgr)

Definition at line 75 of file board_commit.cpp.

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

◆ BOARD_COMMIT() [4/4]

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

Definition at line 90 of file board_commit.cpp.

References COMMIT::COMMIT(), m_isBoardEditor, m_isFootprintEditor, and m_toolMgr.

◆ ~BOARD_COMMIT()

virtual BOARD_COMMIT::~BOARD_COMMIT ( )
inlinevirtual

Definition at line 55 of file board_commit.h.

Member Function Documentation

◆ Add()

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

Add a new item to the model.

Definition at line 78 of file commit.h.

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

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_CONTROL::AppendBoard(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), RULE_AREA_CREATE_HELPER::commitRuleArea(), ZONE_CREATE_HELPER::commitZone(), MULTICHANNEL_TOOL::copyRuleAreaContents(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_TUNING_PATTERN::EditFinish(), PCB_TUNING_PATTERN::EditStart(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), SCH_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), PCBNEW_JOBS_HANDLER::JobExportDrc(), SCH_SELECTION_TOOL::Main(), EDIT_TOOL::ModifyLines(), ARRAY_TOOL::onDialogClosed(), CONVERT_TOOL::OutsetItems(), 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(), MULTICHANNEL_TOOL::RepeatLayout(), PCB_EDIT_FRAME::ResolveDRCExclusions(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CONVERT_TOOL::SegmentToArc(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

◆ Added()

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

Notify observers that aItem has been added.

Definition at line 84 of file commit.h.

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

Referenced by SCH_LINE_WIRE_BUS_TOOL::AddJunction(), BOOST_AUTO_TEST_CASE(), SCH_LINE_WIRE_BUS_TOOL::BreakSegment(), SCH_EDIT_TOOL::ChangeTextType(), TEARDROP_MANAGER::createAndAddTeardropWithMask(), SCH_MOVE_TOOL::doMoveSelection(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_SELECTION_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), SCH_DRAWING_TOOLS::PlaceSymbol(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ clear()

void COMMIT::clear ( )
inlineprotectedinherited

Should be called in Push() & Revert() methods.

Definition at line 157 of file commit.h.

References m_changedItems, m_deletedItems, and m_entries.

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

◆ convert() [1/2]

UNDO_REDO COMMIT::convert ( CHANGE_TYPE aType) const
protectedinherited

Definition at line 223 of file commit.cpp.

References CHANGED, CHT_ADD, CHT_MODIFY, CHT_REMOVE, DELETED, and NEWITEM.

◆ convert() [2/2]

CHANGE_TYPE COMMIT::convert ( UNDO_REDO aType) const
protectedinherited

Definition at line 211 of file commit.cpp.

References CHANGED, CHT_ADD, CHT_MODIFY, CHT_REMOVE, DELETED, and NEWITEM.

◆ Empty()

bool COMMIT::Empty ( ) const
inlineinherited

Definition at line 137 of file commit.h.

References m_entries.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::CycleBodyStyle(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDIT_TOOL::editFieldText(), EDIT_TOOL::Flip(), SCH_EDITOR_CONTROL::IncrementAnnotations(), EDIT_TOOL::JustifyText(), SCH_EDIT_TOOL::JustifyText(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), HIERARCHY_PANE::onTreeEditFinished(), BOARD_COMMIT::Push(), SCH_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), SCHEMATIC::RecalculateConnections(), SCH_COMMIT::revertLibEdit(), EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_TOOL::SetAttribute(), EDIT_TOOL::Swap(), 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(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ 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 199 of file commit.cpp.

References m_entries.

Referenced by GetStatus().

◆ GetBoard()

BOARD * BOARD_COMMIT::GetBoard ( ) const

Definition at line 99 of file board_commit.cpp.

References m_toolMgr.

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

◆ GetFirst()

EDA_ITEM * COMMIT::GetFirst ( ) const
inlineinherited

Definition at line 145 of file commit.h.

References m_entries.

◆ GetStatus()

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

Returns status of an item.

Definition at line 167 of file commit.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::ChangeTextType(), MULTICHANNEL_TOOL::copyRuleAreaContents(), GENERATOR_TOOL::GENERATOR_TOOL(), and BOARD_EDITOR_CONTROL::modifyLockSelected().

◆ makeEntry()

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

Definition at line 175 of file commit.cpp.

References CHT_ADD, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, m_addedItems, m_changedItems, COMMIT::COMMIT_LINE::m_copy, m_deletedItems, m_entries, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_screen, and COMMIT::COMMIT_LINE::m_type.

Referenced by Modified(), and Stage().

◆ MakeImage()

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

Definition at line 658 of file board_commit.cpp.

References EDA_ITEM::Clone(), EDA_ITEM::SetFlags(), and UR_TRANSIENT.

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

◆ makeImage()

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

Implements COMMIT.

Definition at line 652 of file board_commit.cpp.

References MakeImage().

◆ Modified()

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

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

Note
Requires a copy done before the modification.

Definition at line 156 of file commit.cpp.

References CHT_MODIFY, COMMIT(), makeEntry(), and undoLevelItem().

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_AUTO_TEST_CASE(), DIALOG_CHANGE_SYMBOLS::processSymbols(), and Stage().

◆ Modify()

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

Modify a given item in the model.

Note
Must be called before modification is performed.

Definition at line 106 of file commit.h.

References CHT_MODIFY, COMMIT(), NO_RECURSE, and Stage().

Referenced by PCB_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::addCorner(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), SCH_EDIT_FRAME::AnnotateSymbols(), PCB_CONTROL::AppendBoard(), BACK_ANNOTATE::applyChangelist(), SCH_EDITOR_CONTROL::AssignFootprints(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::AutoplaceFields(), AR_AUTOPLACER::AutoplaceFootprints(), BOOST_AUTO_TEST_CASE(), SCH_LINE_WIRE_BUS_TOOL::BreakSegment(), PCB_POINT_EDITOR::chamferCorner(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), PCB_CONTROL::CollectAndEmbed3DModels(), SYMBOL_EDITOR_EDIT_TOOL::ConvertStackedPins(), MULTICHANNEL_TOOL::copyRuleAreaContents(), SCH_EDIT_TOOL::CycleBodyStyle(), SCH_EDIT_FRAME::DeleteAnnotation(), EDIT_TOOL::DeleteItems(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), doPushPadProperties(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), EDIT_TOOL::DragArcTrack(), RECTANGLE_POINT_EDIT_BEHAVIOR::dragPinsOnEdge(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), PAD_TOOL::EditPad(), SCH_EDIT_TOOL::EditPageNumber(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), PAD_TOOL::EnumeratePads(), PCB_EDIT_FRAME::ExchangeFootprint(), SYMBOL_EDITOR_EDIT_TOOL::ExplodeStackedPin(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), EDIT_TOOL::FilletTracks(), EDIT_TOOL::Flip(), GENERATOR_TOOL::GENERATOR_TOOL(), SCH_MOVE_TOOL::getConnectedDragItems(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), EDIT_TOOL::Increment(), SCH_TOOL_BASE< T >::Increment(), SCH_EDITOR_CONTROL::IncrementAnnotations(), EDIT_TOOL::JustifyText(), SCH_EDIT_TOOL::JustifyText(), SCH_POINT_EDITOR::Main(), mergeZones(), EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::ModifyLines(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), moveSelectionBy(), ARRAY_TOOL::onDialogClosed(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), HIERARCHY_PANE::onRightClick(), HIERARCHY_PANE::onTreeEditFinished(), SCH_MOVE_TOOL::orthoLineDrag(), EDIT_TOOL::PackAndMoveFootprints(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), CN_CONNECTIVITY_ALGO::propagateConnections(), SCH_EDIT_TOOL::Properties(), MULTICHANNEL_TOOL::pruneExistingGroups(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), PCB_POINT_EDITOR::removeCorner(), SCH_POINT_EDITOR::removeCorner(), HIERARCHY_PANE::renameIdenticalSheets(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCHEMATIC::SCHEMATIC(), SCH_EDIT_FRAME::SelectBodyStyle(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_FRAME::SetAltPinFunction(), DRAWING_TOOL::SetAnchor(), SCH_EDIT_TOOL::SetAttribute(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), Stage(), EDIT_TOOL::Swap(), SCH_SYMBOL::SyncOtherUnits(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLECELL_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), DIALOG_FIELD_PROPERTIES::UpdateField(), LINE_POINT_EDIT_BEHAVIOR::UpdateItem(), PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), SCH_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), SHAPE_GROUP_POINT_EDIT_BEHAVIOR::UpdateItem(), PCB_POINT_EDITOR::updateItem(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), GLOBAL_EDIT_TOOL::ZonesManager(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ propagateDamage()

void BOARD_COMMIT::propagateDamage ( BOARD_ITEM * aItem,
std::vector< ZONE * > * aStaleZones,
std::vector< BOX2I > & aStaleRuleAreas )
private

Definition at line 132 of file board_commit.cpp.

References LSET::AllCuMask(), Edge_Cuts, EDA_ITEM::GetBoundingBox(), BOARD_ITEM::GetLayerSet(), m_isBoardEditor, m_toolMgr, Margin, NO_RECURSE, PCB_ZONE_T, LSET::PhysicalLayersMask(), propagateDamage(), BOARD_ITEM::RunOnChildren(), EDA_ITEM::Type(), and BOARD::Zones().

Referenced by propagateDamage(), and Push().

◆ Push()

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

Execute the changes.

Implements COMMIT.

Definition at line 176 of file board_commit.cpp.

References BOARD::Add(), KIGFX::PCB_VIEW::Add(), APPEND_UNDO, PCB_BASE_FRAME::AppendCopyToUndoList(), AS_GLOBAL, EDA_GROUP::AsEdaItem(), B_Mask, BOARD::BoardOutline(), BULK, BULK_INSERT, CHANGED, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearEditFlags(), convert, DELETED, ZONE_FILLER_TOOL::DirtyZone(), Edge_Cuts, COMMIT::Empty(), F_Mask, GetAppSettings(), GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_ITEM::GetClass(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), PCB_SELECTION_TOOL::GetEnteredGroup(), BOARD::GetFirstFootprint(), EDA_ITEM::GetFlags(), BOARD_ITEM::GetLayer(), BOARD::GetMsgPanelInfo(), EDA_ITEM::GetParentGroup(), PCB_BASE_FRAME::GetPcbNewSettings(), KIGFX::VIEW::HasItem(), PCB_BASE_FRAME::HideSolderMask(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), BOARD_ITEM::IsGroupableType(), BOARD_ITEM::IsOnLayer(), EDA_ITEM::IsSelected(), PCBNEW_SETTINGS::m_AutoRefillZones, COMMIT::COMMIT_LINE::m_copy, PCBNEW_SETTINGS::m_Display, COMMIT::m_entries, m_isBoardEditor, m_isFootprintEditor, COMMIT::COMMIT_LINE::m_item, PCBNEW_SETTINGS::DISPLAY_OPTIONS::m_Live3DRefresh, m_toolMgr, COMMIT::COMMIT_LINE::m_type, COMMIT::Modify(), NEWITEM, BOARD::OnItemsCompositeUpdate(), PCB_BASE_FRAME::OnModify(), BOARD::OnRatsnestChanged(), pad, 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_POINT_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, propagateDamage(), PICKED_ITEMS_LIST::PushItem(), COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), RECURSE, PCB_DRAW_PANEL_GAL::RedrawRatsnest(), PCB_ACTIONS::rehatchShapes, BOARD::Remove(), KIGFX::PCB_VIEW::Remove(), EDA_GROUP::RemoveItem(), SELECTION_TOOL::RemoveItemFromSel(), TEARDROP_MANAGER::RemoveTeardrops(), BOARD_ITEM::RunOnChildren(), PCB_BASE_FRAME::SaveCopyInUndoList(), EVENTS::SelectedItemsModified, PICKED_ITEMS_LIST::SetDescription(), EDA_ITEM::SetFlags(), ITEM_PICKER::SetLink(), EDA_DRAW_FRAME::SetMsgPanel(), SHOW_WITH_VIA_ALWAYS, SKIP_CONNECTIVITY, SKIP_SET_DIRTY, SKIP_TEARDROPS, SKIP_UNDO, STRUCT_DELETED, TA_MODEL_CHANGE, TC_MESSAGE, EDA_ITEM::Type(), UNIMPLEMENTED_FOR, EVENTS::UnselectedEvent, UNSPECIFIED, KIGFX::PCB_VIEW::Update(), PCB_BASE_FRAME::Update3DView(), BOARD::UpdateBoardOutline(), KIGFX::PCB_VIEW::UpdateCollidingItems(), 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::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), ZONE_FILLER_TOOL::CheckAllZones(), PCB_CONTROL::CollectAndEmbed3DModels(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), KI_TEST::FillZones(), EDIT_TOOL::Flip(), EDIT_TOOL::Increment(), 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(), PCB_POINT_EDITOR::OnSelectionChange(), CONVERT_TOOL::OutsetItems(), EDIT_TOOL::PackAndMoveFootprints(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_CONTROL::PlaceCharacteristics(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_CONTROL::PlaceStackup(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PAD_TOOL::pushPadSettings(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), GENERATOR_TOOL::RegenerateItem(), GENERATOR_TOOL::RegenerateSelected(), PCB_POINT_EDITOR::removeCorner(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), PCB_EDIT_FRAME::ResolveDRCExclusions(), EDIT_TOOL::Rotate(), PCB_EDIT_FRAME::RunActionPlugin(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), CONVERT_TOOL::SegmentToArc(), DRAWING_TOOL::SetAnchor(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), EDIT_TOOL::SimplifyPolygons(), EDIT_TOOL::Swap(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), 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

Remove a new item from the model.

Notify observers that aItem has been removed

Definition at line 90 of file commit.h.

References CHT_REMOVE, COMMIT(), and Stage().

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), API_HANDLER_PCB::deleteItemsInternal(), SCH_EDIT_TOOL::DoDelete(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::DragArcTrack(), PCB_TUNING_PATTERN::EditFinish(), PAD_TOOL::EditPad(), PCB_EDIT_FRAME::ExchangeFootprint(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), mergeZones(), EDIT_TOOL::ModifyLines(), CONVERT_TOOL::OutsetItems(), ZONE_CREATE_HELPER::performZoneCutout(), MULTICHANNEL_TOOL::pruneExistingGroups(), PCB_TUNING_PATTERN::Remove(), and PCB_POINT_EDITOR::removeCorner().

◆ Removed()

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

Definition at line 96 of file commit.h.

References CHT_DONE, CHT_REMOVE, COMMIT(), and Stage().

Referenced by BOARD::BulkRemoveStaleTeardrops(), SCH_EDIT_TOOL::ChangeTextType(), SCHEMATIC::CleanUp(), SCH_EDIT_FRAME::DeleteJunction(), SCH_MOVE_TOOL::doMoveSelection(), NETINFO_LIST::RemoveUnusedNets(), PCB_EDIT_FRAME::RunActionPlugin(), SCH_MOVE_TOOL::trimDanglingLines(), and SCH_EDIT_FRAME::TrimWire().

◆ Revert()

void BOARD_COMMIT::Revert ( )
overridevirtual

Revert the commit by restoring the modified items state.

Implements COMMIT.

Definition at line 667 of file board_commit.cpp.

References BOARD::Add(), KIGFX::VIEW::Add(), BULK, CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearEditFlags(), GetBoard(), KIGFX::VIEW_ITEM::GetClass(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), BOARD::GetFirstFootprint(), BOARD::IncrementTimeStamp(), INSERT, COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), COMMIT::m_entries, m_isBoardEditor, m_isFootprintEditor, m_toolMgr, BOARD::OnItemsCompositeUpdate(), BOARD::OnRatsnestChanged(), PCB_FOOTPRINT_T, PCB_NETINFO_T, COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), PCB_SELECTION_TOOL::RebuildSelection(), BOARD::Remove(), KIGFX::VIEW::Remove(), EVENTS::SelectedItemsModified, BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), UNIMPLEMENTED_FOR, and BOARD::UpdateRatsnestExclusions().

Referenced by PCB_CONTROL::AppendBoard(), PCB_CONTROL::ApplyDesignBlockLayout(), AUTOPLACE_TOOL::autoplace(), ZONE_FILLER_TOOL::CheckAllZones(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), ZONE_FILLER_TOOL::FillAllZones(), mergeZones(), EDIT_TOOL::ModifyLines(), EDIT_TOOL::Move(), PCB_POINT_EDITOR::OnSelectionChange(), EDIT_TOOL::PackAndMoveFootprints(), PCB_CONTROL::Paste(), BOARD_EDITOR_CONTROL::PlaceFootprint(), MULTICHANNEL_TOOL::RepeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), 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

Reimplemented from COMMIT.

Definition at line 126 of file board_commit.cpp.

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

◆ Stage() [2/3]

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

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

Reimplemented from COMMIT.

Definition at line 105 of file board_commit.cpp.

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

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), BOOST_AUTO_TEST_CASE(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCenters(), ALIGN_DISTRIBUTE_TOOL::doDistributeGaps(), PCB_POINT_EDITOR::movePoint(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), and Stage().

◆ 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 120 of file board_commit.cpp.

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

◆ undoLevelItem()

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

Implements COMMIT.

Definition at line 633 of file board_commit.cpp.

References EDA_ITEM::GetParent(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), m_isBoardEditor, PCB_TABLE_T, and EDA_ITEM::Type().

◆ Unstage()

void COMMIT::Unstage ( EDA_ITEM * aItem,
BASE_SCREEN * aScreen )
inherited

Definition at line 136 of file commit.cpp.

References EDA_ITEM::IsNew(), COMMIT::COMMIT_LINE::m_copy, m_entries, COMMIT::COMMIT_LINE::m_item, and COMMIT::COMMIT_LINE::m_screen.

Referenced by BOOST_AUTO_TEST_CASE(), and SCH_EDIT_TOOL::ChangeTextType().

Member Data Documentation

◆ m_addedItems

std::set<std::pair<EDA_ITEM*, BASE_SCREEN*> > COMMIT::m_addedItems
protectedinherited

Definition at line 182 of file commit.h.

Referenced by makeEntry(), and Stage().

◆ m_changedItems

std::set<std::pair<EDA_ITEM*, BASE_SCREEN*> > COMMIT::m_changedItems
protectedinherited

Definition at line 183 of file commit.h.

Referenced by clear(), makeEntry(), and Stage().

◆ m_deletedItems

std::set<std::pair<EDA_ITEM*, BASE_SCREEN*> > COMMIT::m_deletedItems
protectedinherited

Definition at line 184 of file commit.h.

Referenced by clear(), makeEntry(), and Stage().

◆ m_entries

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

Definition at line 185 of file commit.h.

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

◆ m_isBoardEditor

bool BOARD_COMMIT::m_isBoardEditor
private

Definition at line 83 of file board_commit.h.

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

◆ m_isFootprintEditor

bool BOARD_COMMIT::m_isFootprintEditor
private

Definition at line 84 of file board_commit.h.

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

◆ m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr
private

Definition at line 82 of file board_commit.h.

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

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