#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, 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

virtual EDA_ITEM *	ResolveItem (KIID &aID) override
	Search for an item in this commit that matches the provided KIID.

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)

void	Unmodify (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 44 of file board_commit.h.

Constructor & Destructor Documentation

◆ BOARD_COMMIT() [1/4]

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME * aFrame )

Definition at line 76 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 62 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 85 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 100 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 52 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 74 of file commit.h.

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

◆ Added()

COMMIT & COMMIT::Added	(	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, 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_DRAWING_TOOLS::DrawSheet(), SCH_MOVE_TOOL::finalizeMoveOperation(), 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(), SCH_DRAWING_TOOLS::SingleClickPlace(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ clear()

void COMMIT::clear ( )

inlineprotectedinherited

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

Definition at line 162 of file commit.h.

References m_addedItems, m_changedItems, m_deletedItems, and m_entries.

Referenced by BOARD_COMMIT::Push(), SCH_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), 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 288 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 276 of file commit.cpp.

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

◆ Empty()

bool COMMIT::Empty ( ) const

inlineinherited

Definition at line 142 of file commit.h.

References m_entries.

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

References m_entries.

Referenced by GetStatus(), and SCH_COMMIT::RemovedForCleanup().

◆ GetBoard()

BOARD * BOARD_COMMIT::GetBoard ( ) const

Definition at line 109 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 150 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 232 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(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::ChangeTextType(), SCHEMATIC::CleanUp(), VIA_STITCH_TOOL::ClearStitchViaExclusions(), MULTICHANNEL_TOOL::copyRuleAreaContents(), VIA_STITCH_TOOL::ExcludeStitchVia(), 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 240 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(), BOARD_COMMIT::Stage(), and Stage().

◆ MakeImage()

EDA_ITEM * BOARD_COMMIT::MakeImage ( EDA_ITEM * aItem )

static

Definition at line 823 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 817 of file board_commit.cpp.

References MakeImage().

Referenced by Stage().

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

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

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SYMBOL_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 102 of file commit.h.

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

◆ propagateDamage()

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

private

Definition at line 152 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 196 of file board_commit.cpp.

References BOARD::Add(), KIGFX::PCB_VIEW::Add(), LSET::AllCuMask(), 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, copy, DELETED, ZONE_FILLER_TOOL::DirtyZone(), Edge_Cuts, COMMIT::Empty(), F_Mask, KIGFX::GEOMETRY, GetAppSettings(), GetBoard(), PCB_BASE_FRAME::GetCanvas(), KIGFX::VIEW_ITEM::GetClass(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), PCB_SELECTION_TOOL::GetEnteredGroup(), BOARD::GetFirstFootprint(), EDA_ITEM::GetFlags(), SELECTION::GetItems(), BOARD::GetMsgPanelInfo(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParentFootprint(), EDA_ITEM::GetParentGroup(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_SELECTION_TOOL::GetSelection(), KIGFX::VIEW::HasItem(), PCB_BASE_FRAME::HideSolderMask(), COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), KIGFX::VIEW_ITEM::IsBOARD_ITEM(), BOARD_ITEM::IsGroupableType(), isNoGeometryItem(), BOARD_ITEM::IsOnLayer(), EDA_ITEM::IsSelected(), KIGFX::LAYERS, 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_BARCODE_T, PCB_CONSTRAINT_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DRILL_CHART_T, PCB_DRILL_MAP_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GRID_ITEM_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(), PCB_SELECTION_TOOL::RebuildSelection(), RECURSE, PCB_DRAW_PANEL_GAL::RedrawRatsnest(), RefreshDrillMapOutlines(), PCB_BASE_FRAME::RefreshDrillSymbols(), PCB_ACTIONS::rehatchShapes, BOARD::Remove(), KIGFX::PCB_VIEW::Remove(), EDA_GROUP::RemoveItem(), SELECTION_TOOL::RemoveItemFromSel(), TEARDROP_MANAGER::RemoveTeardrops(), KIGFX::REPAINT, 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_ENTERED_GROUP, 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().

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

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

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), PCB_POINT_EDITOR::chamferCorner(), MULTICHANNEL_TOOL::copyRuleAreaContents(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), API_HANDLER_BOARD::deleteItemsInternal(), API_HANDLER_SCH::deleteItemsInternal(), SCH_EDIT_TOOL::DoDelete(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STITCH::EditFinish(), PAD_TOOL::EditPad(), BOARD::ExchangeFootprint(), PCB_VIA_STACK::ExpandMultiHopMicrovias(), SCH_EDIT_TOOL::FixERCError(), DSN::SPECCTRA_DB::FromSESSION(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), mergeZones(), EDIT_TOOL::ModifyLines(), CONVERT_TOOL::OutsetItems(), ZONE_CREATE_HELPER::performZoneCutout(), MULTICHANNEL_TOOL::pruneExistingGroups(), PCB_VIA_STACK::Regenerate(), PCB_TUNING_PATTERN::Remove(), PCB_VIA_STACK::Remove(), PCB_VIA_STITCH::Remove(), CONSTRAINT_EDIT_TOOL::removeConstraint(), CONSTRAINT_EDIT_TOOL::RemoveConstraints(), PCB_POINT_EDITOR::removeCorner(), GRAPHIC_EDIT_TOOL::runInteractive(), DIALOG_FP_EDIT_PAD_TABLE::TransferDataFromWindow(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), PCB_PROPERTIES_PANEL::valueChanged(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ Removed()

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

inlineinherited

Definition at line 92 of file commit.h.

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

Referenced by BOARD::BulkRemoveStaleTeardrops(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_FRAME::DeleteJunction(), SCH_COMMIT::RemovedForCleanup(), NETINFO_LIST::RemoveUnusedNets(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_MOVE_TOOL::trimDanglingLines(), and SCH_EDIT_FRAME::TrimWire().

◆ ResolveItem()

EDA_ITEM * BOARD_COMMIT::ResolveItem ( KIID & aID )

overridevirtual

Search for an item in this commit that matches the provided KIID.

Parameters

aID	is the KIID to search for in the committed items.

Returns: null pointer if aID is null or the item is not found.

Implements COMMIT.

Definition at line 1005 of file board_commit.cpp.

References COMMIT::m_entries, and niluuid.

◆ Revert()

void BOARD_COMMIT::Revert ( )

overridevirtual

Revert the commit by restoring the modified items state.

Implements COMMIT.

Definition at line 832 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(), KIGFX::GEOMETRY, GetBoard(), KIGFX::VIEW_ITEM::GetClass(), BOARD::GetComponentClassManager(), BOARD::GetConnectivity(), BOARD::GetFirstFootprint(), BOARD_ITEM::GetParentFootprint(), group, BOARD::IncrementTimeStamp(), INSERT, COMPONENT_CLASS_MANAGER::InvalidateComponentClasses(), isNoGeometryItem(), KIGFX::LAYERS, COMMIT::m_entries, m_isBoardEditor, m_isFootprintEditor, m_toolMgr, BOARD::OnItemsCompositeUpdate(), BOARD::OnRatsnestChanged(), PCB_DRILL_CHART_T, PCB_DRILL_MAP_T, PCB_FOOTPRINT_T, COMPONENT_CLASS_MANAGER::RebuildRequiredCaches(), BOARD::Remove(), KIGFX::VIEW::Remove(), KIGFX::REPAINT, EVENTS::SelectedItemsModified, BOARD_ITEM::SwapItemData(), EDA_ITEM::Type(), UNIMPLEMENTED_FOR, and BOARD::UpdateRatsnestExclusions().

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

References CHT_REMOVE, CHT_TYPE, COMMIT::COMMIT(), BOARD_ITEM::GetParentFootprint(), group, KIGFX::VIEW_ITEM::IsBOARD_ITEM(), COMMIT::m_deletedItems, m_isBoardEditor, COMMIT::makeEntry(), makeImage(), 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 140 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 798 of file board_commit.cpp.

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

◆ Unmodify()

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

inherited

Definition at line 197 of file commit.cpp.

References CHT_MODIFY, CHT_TYPE, m_changedItems, COMMIT::COMMIT_LINE::m_copy, m_entries, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_screen, and COMMIT::COMMIT_LINE::m_type.

Referenced by PCB_VIA_STACK::Regenerate(), PCB_VIA_STACK::Remove(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ Unstage()

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

inherited

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

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

◆ m_changedItems

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

protectedinherited

Definition at line 189 of file commit.h.

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

◆ m_deletedItems

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

protectedinherited

Definition at line 190 of file commit.h.

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

◆ m_entries

std::vector<COMMIT_LINE> COMMIT::m_entries

protectedinherited

Definition at line 191 of file commit.h.

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

◆ m_isBoardEditor

bool BOARD_COMMIT::m_isBoardEditor

private

Definition at line 82 of file board_commit.h.

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

◆ m_isFootprintEditor

bool BOARD_COMMIT::m_isFootprintEditor

private

Definition at line 83 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 81 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:

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]

◆ Empty()

◆ findEntry()

◆ GetBoard()

◆ GetFirst()

◆ GetStatus()

◆ makeEntry()

◆ MakeImage()

◆ makeImage()

◆ Modified()

◆ Modify()

◆ propagateDamage()

◆ Push()

◆ Remove()

◆ Removed()

◆ ResolveItem()

◆ Revert()

◆ Stage() [1/3]

◆ Stage() [2/3]

◆ Stage() [3/3]

◆ undoLevelItem()

◆ Unmodify()

◆ Unstage()

Member Data Documentation

◆ m_addedItems

◆ m_changedItems

◆ m_deletedItems

◆ m_entries

◆ m_isBoardEditor

◆ m_isFootprintEditor

◆ m_toolMgr