Commit for the schematic and symbol editors. More...

#include <sch_commit.h>

Inheritance diagram for SCH_COMMIT:

Public Member Functions
	SCH_COMMIT (TOOL_MANAGER *aToolMgr)

	SCH_COMMIT (TOOL_MANAGER *aToolMgr, bool aIsLibEditor)

	SCH_COMMIT (EDA_DRAW_FRAME *aFrame)

	SCH_COMMIT (SCH_TOOL_BASE< SCH_BASE_FRAME > *aFrame)

virtual	~SCH_COMMIT ()

void	Push (const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
	Execute the changes.

void	Revert () override
	Revert the commit by restoring the modified items state.

void	RevertToCheckpoint (int aCheckpoint) override

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

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

void	RemovedForCleanup (SCH_ITEM aItem, SCH_SCREEN aScreen)
	Retain the pre-edit state of an item already removed from its screen by cleanup.

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)
	Notify observers that aItem has been removed.

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.

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

void	Unstage (EDA_ITEM aItem, BASE_SCREEN aScreen)

void	Unmodify (EDA_ITEM aItem, BASE_SCREEN aScreen)

int	Checkpoint ()

bool	Empty () const

int	GetStatus (EDA_ITEM aItem, BASE_SCREEN aScreen=nullptr)
	Returns status of an item.

EDA_ITEM *	GetFirst () const

Protected Member Functions
EDA_ITEM *	undoLevelItem (EDA_ITEM *aItem) const override

EDA_ITEM *	makeImage (EDA_ITEM *aItem) const override

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
void	pushLibEdit (const wxString &aMessage, int aCommitFlags)

void	pushSchEdit (const wxString &aMessage, int aCommitFlags)

void	revertLibEdit ()

Private Attributes
TOOL_MANAGER *	m_toolMgr

bool	m_isLibEditor

Detailed Description

Commit for the schematic and symbol editors.

Outside the symbol editor, Stage() bumps the connectivity revision of the staged item's screen, and the connectivity facade stops serving that screen until the next recalculation. A commit that staged an item must therefore end in Push() or Revert(). A caller that drops such a commit on purpose must request the recalculation itself.

Definition at line 53 of file sch_commit.h.

Constructor & Destructor Documentation

◆ SCH_COMMIT() [1/4]

SCH_COMMIT::SCH_COMMIT ( TOOL_MANAGER * aToolMgr )

Definition at line 46 of file sch_commit.cpp.

References COMMIT::COMMIT(), FRAME_SCH_SYMBOL_EDITOR, EDA_BASE_FRAME::IsType(), m_isLibEditor, and m_toolMgr.

◆ SCH_COMMIT() [2/4]

SCH_COMMIT::SCH_COMMIT	(	TOOL_MANAGER *	aToolMgr,
		bool	aIsLibEditor )

Definition at line 56 of file sch_commit.cpp.

References COMMIT::COMMIT(), m_isLibEditor, and m_toolMgr.

◆ SCH_COMMIT() [3/4]

SCH_COMMIT::SCH_COMMIT ( EDA_DRAW_FRAME * aFrame )

Definition at line 71 of file sch_commit.cpp.

References FRAME_SCH_SYMBOL_EDITOR, TOOLS_HOLDER::GetToolManager(), EDA_BASE_FRAME::IsType(), m_isLibEditor, and m_toolMgr.

◆ SCH_COMMIT() [4/4]

SCH_COMMIT::SCH_COMMIT ( SCH_TOOL_BASE< SCH_BASE_FRAME > * aFrame )

Definition at line 64 of file sch_commit.cpp.

References TOOL_BASE::GetManager(), SCH_TOOL_BASE< T >::IsSymbolEditor(), m_isLibEditor, and m_toolMgr.

◆ ~SCH_COMMIT()

SCH_COMMIT::~SCH_COMMIT ( )

virtual

Definition at line 78 of file sch_commit.cpp.

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

◆ Checkpoint()

int COMMIT::Checkpoint ( )

inlineinherited

Definition at line 134 of file commit.h.

References m_entries.

Referenced by API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), and API_HANDLER_SCH::handleCreateUpdateItemsInternal().

◆ clear()

void COMMIT::clear ( )

inlineprotectedinherited

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

Definition at line 165 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(), and SCH_COMMIT::revertLibEdit().

◆ convert() [1/2]

UNDO_REDO COMMIT::convert ( CHANGE_TYPE aType ) const

protectedinherited

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

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

◆ Empty()

bool COMMIT::Empty ( ) const

inlineinherited

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

References m_entries.

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

◆ GetFirst()

EDA_ITEM * COMMIT::GetFirst ( ) const

inlineinherited

Definition at line 153 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 235 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 243 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 * SCH_COMMIT::makeImage ( EDA_ITEM * aItem ) const

overrideprotectedvirtual

Implements COMMIT.

Definition at line 644 of file sch_commit.cpp.

References EDA_ITEM::Clone(), alg::contains(), SYMBOL_EDIT_FRAME::GetCurSymbol(), LIB_SYMBOL::GetDrawItems(), m_isLibEditor, and m_toolMgr.

◆ 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 224 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().

◆ Push()

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

overridevirtual

Execute the changes.

Implements COMMIT.

Definition at line 601 of file sch_commit.cpp.

References COMMIT::clear(), COMMIT::Empty(), m_isLibEditor, m_toolMgr, pushLibEdit(), pushSchEdit(), and SKIP_SET_DIRTY.

◆ pushLibEdit()

void SCH_COMMIT::pushLibEdit	(	const wxString &	aMessage,
		int	aCommitFlags )

private

Definition at line 149 of file sch_commit.cpp.

References AS_GLOBAL, copy, COMMIT::m_entries, m_toolMgr, NO_RECURSE, LIB_SYMBOL::RunOnChildren(), EVENTS::SelectedItemsModified, SKIP_UNDO, TA_MODEL_CHANGE, and TC_MESSAGE.

Referenced by Push().

◆ pushSchEdit()

void SCH_COMMIT::pushSchEdit	(	const wxString &	aMessage,
		int	aCommitFlags )

private

Definition at line 194 of file sch_commit.cpp.

References KIGFX::VIEW::Add(), EDA_GROUP::AddItem(), SCH_SCREEN::Append(), AS_GLOBAL, CHANGED, SCH_SCREEN::CheckIfOnDrawList(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, SCHEMATIC::CleanUpConnections(), COMMIT::clear(), EDA_ITEM::ClearFlags(), DELETE_REMOVED_ITEMS, DELETED, EDA_ITEM_ALL_FLAGS, COMMIT::Empty(), ENDPOINT, ADVANCED_CFG::GetCfg(), PICKED_ITEMS_LIST::GetCount(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SELECTION_TOOL::GetEnteredGroup(), EDA_ITEM::GetParentGroup(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCH_EDIT_FRAME::GetScreen(), GLOBAL_CLEANUP, group, SCH_ITEM::HasConnectivityChanges(), SCH_SHEET::HasHierarchyChanges(), SCH_SHEET::HasPinIdentityChanges(), index, SCH_ITEM::IsConnectable(), SCH_ITEM::IsConnectivityDirty(), SCH_SCREEN::IsConnectivitySource(), SCH_ITEM::IsGroupableType(), EDA_ITEM::IsSelected(), LOCAL_CLEANUP, ADVANCED_CFG::m_ConnectivityEngine, COMMIT::COMMIT_LINE::m_copy, COMMIT::m_entries, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_screen, m_toolMgr, COMMIT::COMMIT_LINE::m_type, COMMIT::Modify(), NEWITEM, NO_CLEANUP, NO_RECURSE, SCHEMATIC::OnItemsAdded(), SCHEMATIC::OnItemsChanged(), SCHEMATIC::OnItemsRemoved(), SCH_SCREEN::PruneUnusedLibSymbol(), PICKED_ITEMS_LIST::PushItem(), SCH_EDIT_FRAME::RecalculateConnections(), SCHEMATIC::RecalculateConnections(), SCHEMATIC::RefreshHierarchy(), KIGFX::VIEW::Remove(), SCH_SCREEN::Remove(), SELECTION_TOOL::RemoveItemFromSel(), SCH_ITEM::RunOnChildren(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_FIELD_T, SCH_LINE_T, SCH_RULE_AREA_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_ITEM::Schematic(), SELECTED, EVENTS::SelectedItemsModified, PICKED_ITEMS_LIST::SetDescription(), ITEM_PICKER::SetLink(), SKIP_CONNECTIVITY, SKIP_SET_DIRTY, SKIP_UNDO, STARTPOINT, TA_MODEL_CHANGE, TC_MESSAGE, EDA_ITEM::Type(), EVENTS::UnselectedEvent, UNSPECIFIED, SCH_SCREEN::Update(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), SCH_EDIT_FRAME::UpdateHopOveredWires(), and SCH_EDIT_FRAME::UpdateItem().

Referenced by Push().

◆ Remove()

COMMIT & COMMIT::Remove	(	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_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_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_DATA_TEST_CASE_F(), 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_TUNING_PATTERN::Remove(), PCB_VIA_STACK::Remove(), PCB_VIA_STITCH::Remove(), CONSTRAINT_EDIT_TOOL::removeConstraint(), CONSTRAINT_EDIT_TOOL::RemoveConstraints(), PCB_POINT_EDITOR::removeCorner(), BOARD_COMMIT::RemoveOrDiscard(), 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

Notify observers that aItem has been removed.

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

◆ RemovedForCleanup()

void SCH_COMMIT::RemovedForCleanup	(	SCH_ITEM *	aItem,
		SCH_SCREEN *	aScreen )

Retain the pre-edit state of an item already removed from its screen by cleanup.

Definition at line 133 of file sch_commit.cpp.

References SCH_SCREEN::CheckIfOnDrawList(), CHT_MODIFY, CHT_TYPE, COMMIT::findEntry(), COMMIT::Removed(), EDA_ITEM::SetFlags(), STRUCT_DELETED, and SCH_ITEM::SwapItemData().

Referenced by SCHEMATIC::CleanUp().

◆ ResolveItem()

EDA_ITEM * SCH_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 878 of file sch_commit.cpp.

References COMMIT::m_entries, and niluuid.

◆ Revert()

void SCH_COMMIT::Revert ( )

overridevirtual

Revert the commit by restoring the modified items state.

Implements COMMIT.

Definition at line 702 of file sch_commit.cpp.

References RevertToCheckpoint().

Referenced by SCH_DRAWING_TOOLS::ImportSheet(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), and SCH_MOVE_TOOL::restartMoveOperation().

◆ revertLibEdit()

void SCH_COMMIT::revertLibEdit ( )

private

Definition at line 679 of file sch_commit.cpp.

References COMMIT::clear(), copy, COMMIT::Empty(), COMMIT::m_entries, m_toolMgr, TOOL_BASE::MODEL_RELOAD, SCH_SELECTION_TOOL::RebuildSelection(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

Referenced by RevertToCheckpoint().

◆ RevertToCheckpoint()

void SCH_COMMIT::RevertToCheckpoint ( int aCheckpoint )

overridevirtual

Implements COMMIT.

Definition at line 708 of file sch_commit.cpp.

References KIGFX::VIEW::Add(), SCH_SCREEN::Append(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, EDA_ITEM::ClearFlags(), EDA_ITEM::ClearSelected(), SCHEMATIC::ConnectionGraph(), copy, SCH_FIELD::GetId(), EDA_ITEM::GetParent(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCH_FIELD::GetText(), SCHEMATIC::Hierarchy(), EDA_ITEM::IsSelected(), COMMIT::COMMIT_LINE::m_copy, COMMIT::m_entries, m_isLibEditor, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_screen, m_toolMgr, COMMIT::COMMIT_LINE::m_type, NO_CLEANUP, NO_RECURSE, SCHEMATIC::OnItemsAdded(), SCHEMATIC::OnItemsChanged(), SCHEMATIC::OnItemsRemoved(), pin, SCH_SCREEN::PruneUnusedLibSymbol(), SCH_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_FRAME::RecalculateConnections(), REFERENCE, KIGFX::VIEW::Remove(), SCH_SCREEN::Remove(), CONNECTION_GRAPH::RemoveItem(), revertLibEdit(), SCH_ITEM::RunOnChildren(), SCH_FIELD_T, SCH_SYMBOL_T, SCH_ITEM::Schematic(), SCH_ITEM::SetConnectivityDirty(), SCH_SYMBOL::SetRef(), STRUCT_DELETED, SCH_ITEM::SwapItemData(), EDA_ITEM::Type(), SCH_SCREEN::Update(), and SCH_SYMBOL::UpdatePins().

Referenced by API_HANDLER_SCH::handleCreateUpdateItemsInternal(), and Revert().

◆ Stage() [1/3]

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

virtualinherited

Reimplemented in BOARD_COMMIT.

Definition at line 150 of file commit.cpp.

References CHANGED, COMMIT(), convert, copy, PICKED_ITEMS_LIST::GetCount(), PICKED_ITEMS_LIST::GetPickedItem(), PICKED_ITEMS_LIST::GetPickedItemLink(), PICKED_ITEMS_LIST::GetPickedItemStatus(), Modified(), Stage(), and UNSPECIFIED.

◆ Stage() [2/3]

COMMIT & SCH_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 83 of file sch_commit.cpp.

References SCH_SCREEN::BumpConnectivityRevision(), EDA_ITEM::ClearSelected(), COMMIT::COMMIT(), SCH_ITEM::GetParentScreen(), group, EDA_ITEM::HasFlag(), SCH_SCREEN::IsConnectivitySource(), EDA_ITEM::IsSelected(), m_isLibEditor, RECURSE, SELECTED_BY_DRAG, EDA_ITEM::SetSelected(), COMMIT::Stage(), Stage(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_MOVE_TOOL::moveSelectionToSheet(), Stage(), and Stage().

◆ Stage() [3/3]

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

overridevirtual

Reimplemented from COMMIT.

Definition at line 124 of file sch_commit.cpp.

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

◆ undoLevelItem()

EDA_ITEM * SCH_COMMIT::undoLevelItem ( EDA_ITEM * aItem ) const

overrideprotectedvirtual

Implements COMMIT.

Definition at line 624 of file sch_commit.cpp.

References EDA_ITEM::GetParent(), EDA_ITEM::IsType(), m_isLibEditor, and m_toolMgr.

◆ Unmodify()

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

inherited

Definition at line 200 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 CHT_ADD, CHT_TYPE, m_addedItems, 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 BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::ChangeTextType(), and BOARD_COMMIT::RemoveOrDiscard().

Member Data Documentation

◆ m_addedItems

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

protectedinherited

Definition at line 191 of file commit.h.

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

◆ m_changedItems

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

protectedinherited

Definition at line 192 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 193 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 194 of file commit.h.

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

◆ m_isLibEditor

bool SCH_COMMIT::m_isLibEditor

private

Definition at line 91 of file sch_commit.h.

Referenced by makeImage(), Push(), RevertToCheckpoint(), SCH_COMMIT(), SCH_COMMIT(), SCH_COMMIT(), SCH_COMMIT(), Stage(), and undoLevelItem().

◆ m_toolMgr

TOOL_MANAGER* SCH_COMMIT::m_toolMgr

private

Definition at line 90 of file sch_commit.h.

Referenced by makeImage(), Push(), pushLibEdit(), pushSchEdit(), revertLibEdit(), RevertToCheckpoint(), SCH_COMMIT(), SCH_COMMIT(), SCH_COMMIT(), SCH_COMMIT(), and undoLevelItem().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCH_COMMIT() [1/4]

◆ SCH_COMMIT() [2/4]

◆ SCH_COMMIT() [3/4]

◆ SCH_COMMIT() [4/4]

◆ ~SCH_COMMIT()

Member Function Documentation

◆ Add()

◆ Added()

◆ Checkpoint()

◆ clear()

◆ convert() [1/2]

◆ convert() [2/2]

◆ Empty()

◆ findEntry()

◆ GetFirst()

◆ GetStatus()

◆ makeEntry()

◆ makeImage()

◆ Modified()

◆ Modify()

◆ Push()

◆ pushLibEdit()

◆ pushSchEdit()

◆ Remove()

◆ Removed()

◆ RemovedForCleanup()

◆ ResolveItem()

◆ Revert()

◆ revertLibEdit()

◆ RevertToCheckpoint()

◆ Stage() [1/3]

◆ Stage() [2/3]

◆ Stage() [3/3]

◆ undoLevelItem()

◆ Unmodify()

◆ Unstage()

Member Data Documentation

◆ m_addedItems

◆ m_changedItems

◆ m_deletedItems

◆ m_entries

◆ m_isLibEditor

◆ m_toolMgr