#include <board_commit.h>

Inheritance diagram for BOARD_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
	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.

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

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.

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	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 48 of file board_commit.h.

Constructor & Destructor Documentation

◆ BOARD_COMMIT() [1/4]

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME * aFrame )

Definition at line 65 of file board_commit.cpp.

◆ BOARD_COMMIT() [2/4]

BOARD_COMMIT::BOARD_COMMIT ( TOOL_BASE * aTool )

Definition at line 52 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 73 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 86 of file board_commit.cpp.

◆ ~BOARD_COMMIT()

virtual BOARD_COMMIT::~BOARD_COMMIT ( )

inlinevirtual

Definition at line 56 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 79 of file commit.h.

References CHT_ADD, and COMMIT::Stage().

◆ Added()

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

inlineinherited

◆ clear()

void COMMIT::clear ( )

inlineprotectedinherited

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

Definition at line 173 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 208 of file commit.cpp.

References CHT_ADD, CHT_MODIFY, and CHT_REMOVE.

◆ convert() [2/2]

CHANGE_TYPE COMMIT::convert ( UNDO_REDO aType ) const

protectedinherited

Definition at line 196 of file commit.cpp.

References CHT_ADD, CHT_MODIFY, and CHT_REMOVE.

◆ createModified()

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

protectedinherited

Definition at line 150 of file commit.cpp.

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

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

◆ Empty()

bool COMMIT::Empty ( ) const

inlineinherited

Definition at line 152 of file commit.h.

References COMMIT::m_changes.

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

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

◆ GetBoard()

BOARD * BOARD_COMMIT::GetBoard ( ) const

Definition at line 94 of file board_commit.cpp.

References TOOL_MANAGER::GetModel(), and m_toolMgr.

Referenced by BOOST_AUTO_TEST_CASE(), GRAPHICS_CLEANER::CleanupBoard(), Push(), and Revert().

◆ GetFirst()

EDA_ITEM * COMMIT::GetFirst ( ) const

inlineinherited

Definition at line 160 of file commit.h.

References COMMIT::m_changes.

◆ GetStatus()

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

inherited

Returns status of an item.

Definition at line 142 of file commit.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), GENERATOR_TOOL::GENERATOR_TOOL(), GRAPHICS_CLEANER::mergePads(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), 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 167 of file commit.cpp.

References 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 655 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 649 of file board_commit.cpp.

References MakeImage().

◆ Modified()

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

inlineinherited

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

Note: Requires a copy done before the modification.

Definition at line 118 of file commit.h.

References COMMIT::createModified().

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

◆ 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 107 of file commit.h.

References CHT_MODIFY, and COMMIT::Stage().

◆ parentObject()

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

overrideprivatevirtual

Implements COMMIT.

Definition at line 643 of file board_commit.cpp.

◆ propagateDamage()

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

private

Definition at line 130 of file board_commit.cpp.

References LSET::AllCuMask(), Edge_Cuts, EDA_ITEM::GetBoundingBox(), BOARD_ITEM::GetLayerSet(), TOOL_MANAGER::GetModel(), ZONE::GetZoneName(), m_isBoardEditor, m_toolMgr, Margin, 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 177 of file board_commit.cpp.

References BOARD::Add(), FOOTPRINT::Add(), KIGFX::PCB_VIEW::Add(), APPEND_UNDO, PCB_BASE_FRAME::AppendCopyToUndoList(), AS_GLOBAL, EDA_GROUP::AsEdaItem(), B_Mask, BOARD::BoardOutline(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearEditFlags(), convert, ZONE_FILLER_TOOL::DirtyZone(), Edge_Cuts, COMMIT::Empty(), F_Mask, 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(), TOOL_MANAGER::GetModel(), BOARD::GetMsgPanelInfo(), BOARD_ITEM::GetParentFootprint(), EDA_ITEM::GetParentGroup(), PCB_BASE_FRAME::GetPcbNewSettings(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetView(), 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::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, COMMIT::Modify(), 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(), propagateDamage(), PICKED_ITEMS_LIST::PushItem(), COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), PCB_ACTIONS::rehatchShapes, BOARD::Remove(), FOOTPRINT::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, 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(), 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::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(), PCB_GENERATOR::EditPush(), PCB_TUNING_PATTERN::EditPush(), 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(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), PCB_POINT_EDITOR::OnSelectionChange(), 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(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PAD_TOOL::pushPadSettings(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), PCB_TUNING_PATTERN::Remove(), PCB_POINT_EDITOR::removeCorner(), MULTICHANNEL_TOOL::RepeatLayout(), PCB_EDIT_FRAME::ResolveDRCExclusions(), EDIT_TOOL::Rotate(), PCB_EDIT_FRAME::RunActionPlugin(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), DRAWING_TOOL::SetAnchor(), 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(), 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

Remove a new item from the model.

Notify observers that aItem has been removed

Definition at line 91 of file commit.h.

References CHT_REMOVE, and COMMIT::Stage().

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), 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(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), GRAPHICS_CLEANER::mergeRects(), mergeZones(), ZONE_CREATE_HELPER::performZoneCutout(), MULTICHANNEL_TOOL::pruneExistingGroups(), PCB_GENERATOR::Remove(), PCB_TUNING_PATTERN::Remove(), PCB_POINT_EDITOR::removeCorner(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ Removed()

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

inlineinherited

Definition at line 97 of file commit.h.

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

Referenced by BOARD::BulkRemoveStaleTeardrops(), SCH_EDIT_TOOL::ChangeTextType(), SCHEMATIC::CleanUp(), TRACKS_CLEANER::deleteDanglingTracks(), SCH_EDIT_FRAME::DeleteJunction(), TRACKS_CLEANER::mergeCollinearSegments(), TRACKS_CLEANER::removeItems(), 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 664 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(), GetBoard(), KIGFX::VIEW_ITEM::GetClass(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), TOOL_MANAGER::GetModel(), BOARD_ITEM::GetParentFootprint(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetView(), BOARD::IncrementTimeStamp(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), COMMIT::m_changes, m_isBoardEditor, m_toolMgr, BOARD::OnItemsCompositeUpdate(), BOARD::OnRatsnestChanged(), PCB_FOOTPRINT_T, TOOL_MANAGER::PostEvent(), COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), PCB_SELECTION_TOOL::RebuildSelection(), BOARD::Remove(), KIGFX::VIEW::Remove(), BOARD::ResolveItem(), EVENTS::SelectedItemsModified, BOARD_ITEM::SwapItemData(), 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(), 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 123 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`,
		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 100 of file board_commit.cpp.

References group, COMMIT::Stage(), and 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 116 of file board_commit.cpp.

References COMMIT::Stage().

◆ StageItems()

template<class Range >

COMMIT & COMMIT::StageItems	(	const Range &	aRange,
		CHANGE_TYPE	aChangeType
	)

inlineinherited

Definition at line 125 of file commit.h.

References COMMIT::Stage().

◆ Unstage()

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

inherited

Definition at line 122 of file commit.cpp.

References COMMIT::m_changes, 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_changedItems

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

protectedinherited

Definition at line 201 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 203 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(), COMMIT::Unstage(), and COMMIT::~COMMIT().

◆ m_deletedItems

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

protectedinherited

Definition at line 202 of file commit.h.

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

◆ m_isBoardEditor

bool BOARD_COMMIT::m_isBoardEditor

private

Definition at line 84 of file board_commit.h.

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

◆ m_isFootprintEditor

bool BOARD_COMMIT::m_isFootprintEditor

private

Definition at line 85 of file board_commit.h.

Referenced by BOARD_COMMIT(), and Push().

◆ m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr

private

Definition at line 83 of file board_commit.h.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BOARD_COMMIT() [1/4]

◆ BOARD_COMMIT() [2/4]

◆ BOARD_COMMIT() [3/4]

◆ BOARD_COMMIT() [4/4]

◆ ~BOARD_COMMIT()

Member Function Documentation

◆ Add()

◆ Added()

◆ clear()

◆ convert() [1/2]

◆ convert() [2/2]

◆ createModified()

◆ Empty()

◆ findEntry()

◆ GetBoard()

◆ GetFirst()

◆ GetStatus()

◆ makeEntry()

◆ MakeImage()

◆ makeImage()

◆ Modified()

◆ Modify()

◆ parentObject()

◆ propagateDamage()

◆ Push()

◆ Remove()

◆ Removed()

◆ Revert()

◆ Stage() [1/3]

◆ Stage() [2/3]

◆ Stage() [3/3]

◆ StageItems()

◆ Unstage()

Member Data Documentation

◆ m_changedItems

◆ m_changes

◆ m_deletedItems

◆ m_isBoardEditor

◆ m_isFootprintEditor

◆ m_toolMgr