SCH_COMMIT Class Reference

#include <sch_commit.h>

Inheritance diagram for SCH_COMMIT:

Public Member Functions
	SCH_COMMIT (TOOL_MANAGER *aToolMgr)
	SCH_COMMIT (EDA_DRAW_FRAME *aFrame)
	SCH_COMMIT (SCH_TOOL_BASE< SCH_BASE_FRAME > *aFrame)
virtual	~SCH_COMMIT ()
virtual void	Push (const wxString &aMessage=wxT("A commit"), 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

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

Definition at line 45 of file sch_commit.h.

Constructor & Destructor Documentation

SCH_COMMIT() [1/3]

SCH_COMMIT::SCH_COMMIT

(

TOOL_MANAGER *

aToolMgr

)

Definition at line 42 of file sch_commit.cpp.

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

SCH_COMMIT() [2/3]

SCH_COMMIT::SCH_COMMIT

(

EDA_DRAW_FRAME *

aFrame

)

Definition at line 58 of file sch_commit.cpp.

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

SCH_COMMIT() [3/3]

SCH_COMMIT::SCH_COMMIT

(

SCH_TOOL_BASE< SCH_BASE_FRAME > *

aFrame

)

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

References CHT_ADD, and COMMIT::Stage().

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), PCB_CONTROL::AppendBoard(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), RULE_AREA_CREATE_HELPER::commitRuleArea(), ZONE_CREATE_HELPER::commitZone(), MULTICHANNEL_TOOL::copyRuleAreaContents(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditStart(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), GRAPHICS_CLEANER::fixBoardOutlines(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), SCH_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), PCBNEW_JOBS_HANDLER::JobExportDrc(), SCH_SELECTION_TOOL::Main(), GRAPHICS_CLEANER::mergeRects(), ARRAY_TOOL::onDialogClosed(), ZONE_CREATE_HELPER::performZoneCutout(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), INTERACTIVE_PLACER_BASE::PlaceItem(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), BACK_ANNOTATE::processNetNameChange(), PCB_TUNING_PATTERN::Remove(), MULTICHANNEL_TOOL::RepeatLayout(), PCB_EDIT_FRAME::ResolveDRCExclusions(), BOARD_COMMIT::Revert(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_EDITOR_CONTROL::ZoneDuplicate().

Added()

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

inlineinherited

Notify observers that aItem has been added.

Definition at line 85 of file commit.h.

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

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

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 BOARD_COMMIT::Push(), pushLibEdit(), pushSchEdit(), Revert(), BOARD_COMMIT::Revert(), and 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.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SCH_EDIT_TOOL::editFieldText(), EDIT_TOOL::Flip(), GENERATOR_TOOL::GenEditAction(), SCH_EDITOR_CONTROL::IncrementAnnotations(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), HIERARCHY_PANE::onTreeEditFinished(), BOARD_COMMIT::Push(), pushLibEdit(), pushSchEdit(), SCHEMATIC::RecalculateConnections(), revertLibEdit(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_TOOL::SetAttribute(), EDIT_TOOL::Swap(), 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 184 of file commit.cpp.

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

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 * SCH_COMMIT::makeImage ( EDA_ITEM *  aItem ) const

overrideprivatevirtual

Implements COMMIT.

Definition at line 512 of file sch_commit.cpp.

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

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

Referenced by SCH_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), SCH_EDIT_FRAME::AnnotateSymbols(), PCB_CONTROL::AppendBoard(), BACK_ANNOTATE::applyChangelist(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_EDITOR_CONTROL::AssignFootprints(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::AutoplaceFields(), AR_AUTOPLACER::AutoplaceFootprints(), BOOST_AUTO_TEST_CASE(), SCHEMATIC::BreakSegment(), PCB_POINT_EDITOR::chamferCorner(), SCH_EDIT_TOOL::ChangeBodyStyle(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), PCB_CONTROL::CollectAndEmbed3DModels(), MULTICHANNEL_TOOL::copyRuleAreaContents(), SCH_EDIT_FRAME::DeleteAnnotation(), EDIT_TOOL::DeleteItems(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), doPushPadProperties(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), EDIT_TOOL::DragArcTrack(), RECTANGLE_POINT_EDIT_BEHAVIOR::dragPinsOnEdge(), DRAWING_TOOL::DrawVia(), 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_GENERATOR::EditStart(), PCB_TUNING_PATTERN::EditStart(), PAD_TOOL::EnumeratePads(), PCB_EDIT_FRAME::ExchangeFootprint(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), ZONE_FILLER::Fill(), EDIT_TOOL::FilletTracks(), GRAPHICS_CLEANER::fixBoardOutlines(), EDIT_TOOL::Flip(), SCH_EDIT_FRAME::FlipBodyStyle(), GENERATOR_TOOL::GENERATOR_TOOL(), SCH_MOVE_TOOL::getConnectedDragItems(), API_HANDLER_SCH::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), SCH_EDITOR_CONTROL::IncrementAnnotations(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), SCH_POINT_EDITOR::Main(), TRACKS_CLEANER::mergeCollinearSegments(), GRAPHICS_CLEANER::mergePads(), mergeZones(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), 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(), BACK_ANNOTATE::processNetNameChange(), CN_CONNECTIVITY_ALGO::propagateConnections(), SCH_EDIT_TOOL::Properties(), MULTICHANNEL_TOOL::pruneExistingGroups(), BOARD_COMMIT::Push(), pushSchEdit(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), SCH_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), HIERARCHY_PANE::renameIdenticalSheets(), MULTICHANNEL_TOOL::RepeatLayout(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCHEMATIC::SCHEMATIC(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_FRAME::SetAltPinFunction(), DRAWING_TOOL::SetAnchor(), SCH_EDIT_TOOL::SetAttribute(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), COMMIT::Stage(), EDIT_TOOL::Swap(), SCH_SYMBOL::SyncOtherUnits(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLECELL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_FIELD_PROPERTIES::UpdateField(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), BOARD_NETLIST_UPDATER::updateGroups(), PCB_POINT_EDITOR::updateItem(), SCH_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), LINE_POINT_EDIT_BEHAVIOR::UpdateItem(), DIALOG_UNUSED_PAD_LAYERS::updatePadsAndVias(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), GLOBAL_EDIT_TOOL::ZonesManager(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

parentObject()

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

overrideprivatevirtual

Implements COMMIT.

Definition at line 498 of file sch_commit.cpp.

References EDA_ITEM::GetParent(), TOOL_MANAGER::GetToolHolder(), LIB_SYMBOL_T, m_isLibEditor, m_toolMgr, SCH_SYMBOL_T, and EDA_ITEM::Type().

Push()

void SCH_COMMIT::Push ( const wxString &  aMessage = wxT("A commit"), int  aFlags = 0  )

overridevirtual

Execute the changes.

Implements COMMIT.

Definition at line 489 of file sch_commit.cpp.

References m_isLibEditor, pushLibEdit(), and pushSchEdit().

Referenced by SCH_POINT_EDITOR::addCorner(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), BACK_ANNOTATE::applyChangelist(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::CleanupSheetPins(), RULE_AREA_CREATE_HELPER::commitRuleArea(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDIT_TOOL::EditPageNumber(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SCH_EDIT_FRAME::FlipBodyStyle(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), SCH_EDITOR_CONTROL::IncrementAnnotations(), SCH_EDIT_TOOL::JustifyText(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), DIALOG_ANNOTATE::OnAnnotateClick(), DIALOG_CHANGE_SYMBOLS::onOkButtonClicked(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), HIERARCHY_PANE::onRightClick(), HIERARCHY_PANE::onTreeEditFinished(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), SCH_DRAWING_TOOLS::PlaceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::Properties(), SCHEMATIC::RecalculateConnections(), SCH_POINT_EDITOR::removeCorner(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), SCH_EDIT_FRAME::SelectUnit(), SCH_EDIT_FRAME::SetAltPinFunction(), SCH_EDIT_TOOL::SetAttribute(), SCH_DRAWING_TOOLS::SingleClickPlace(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLECELL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_PROPERTIES_PANEL::valueChanged().

pushLibEdit()

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

private

Definition at line 129 of file sch_commit.cpp.

References AS_GLOBAL, COMMIT::clear(), copy, COMMIT::Empty(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetView(), COMMIT::m_changes, m_toolMgr, SYMBOL_EDIT_FRAME::OnModify(), TOOL_MANAGER::PostEvent(), TOOL_MANAGER::ProcessEvent(), SYMBOL_EDIT_FRAME::PushSymbolToUndoList(), LIB_SYMBOL::RunOnChildren(), EVENTS::SelectedItemsModified, SKIP_SET_DIRTY, SKIP_UNDO, TA_MODEL_CHANGE, TC_MESSAGE, and KIGFX::VIEW::Update().

Referenced by Push().

pushSchEdit()

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

private

Definition at line 188 of file sch_commit.cpp.

References KIGFX::VIEW::Add(), EDA_GROUP::AddItem(), SCH_SCREEN::Append(), AS_GLOBAL, EDA_GROUP::AsEdaItem(), SCH_SCREEN::CheckIfOnDrawList(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearFlags(), EDA_ITEM_ALL_FLAGS, COMMIT::Empty(), ENDPOINT, SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SELECTION_TOOL::GetEnteredGroup(), EDA_ITEM::GetParentGroup(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetView(), GLOBAL_CLEANUP, group, SCH_ITEM::HasConnectivityChanges(), SCH_SHEET::HasPageNumberChanges(), SCH_ITEM::IsGroupableType(), EDA_ITEM::IsSelected(), LOCAL_CLEANUP, COMMIT::m_changes, m_toolMgr, COMMIT::Modify(), NO_CLEANUP, SCHEMATIC::OnItemsAdded(), SCHEMATIC::OnItemsChanged(), SCHEMATIC::OnItemsRemoved(), SCH_EDIT_FRAME::OnModify(), TOOL_MANAGER::PostEvent(), TOOL_MANAGER::ProcessEvent(), PICKED_ITEMS_LIST::PushItem(), SCH_EDIT_FRAME::RecalculateConnections(), EDA_DRAW_PANEL_GAL::Refresh(), SCHEMATIC::RefreshHierarchy(), SCH_SCREEN::Remove(), KIGFX::VIEW::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_SET_DIRTY, SKIP_UNDO, STARTPOINT, TA_MODEL_CHANGE, TC_MESSAGE, EDA_ITEM::Type(), EVENTS::UnselectedEvent, 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.

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 SCH_COMMIT::Revert ( )

overridevirtual

Revert the commit by restoring the modified items state.

Implements COMMIT.

Definition at line 567 of file sch_commit.cpp.

References KIGFX::VIEW::Add(), SCH_SCREEN::Append(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, COMMIT::clear(), EDA_ITEM::ClearSelected(), SCHEMATIC::ConnectionGraph(), copy, SCH_FIELD::GetId(), EDA_ITEM::GetParent(), SCH_SYMBOL::GetPins(), EDA_TEXT::GetText(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetToolHolder(), TOOL_MANAGER::GetView(), SCHEMATIC::Hierarchy(), EDA_ITEM::IsSelected(), COMMIT::m_changes, m_isLibEditor, m_toolMgr, NO_CLEANUP, SCHEMATIC::OnItemsAdded(), SCHEMATIC::OnItemsChanged(), SCHEMATIC::OnItemsRemoved(), pin, SCH_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_FRAME::RecalculateConnections(), SCH_SCREEN::Remove(), KIGFX::VIEW::Remove(), CONNECTION_GRAPH::RemoveItem(), revertLibEdit(), SCH_ITEM::RunOnChildren(), SCH_FIELD_T, SCH_SYMBOL_T, SCH_ITEM::Schematic(), SCH_ITEM::SetConnectivityDirty(), SCH_SYMBOL::SetRef(), SCH_ITEM::SwapItemData(), EDA_ITEM::Type(), SCH_SCREEN::Update(), and SCH_SYMBOL::UpdatePins().

Referenced by SCH_EDIT_TOOL::BreakWire(), SCH_MOVE_TOOL::doMoveSelection(), 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(), and SYMBOL_EDITOR_EDIT_TOOL::Paste().

revertLibEdit()

void SCH_COMMIT::revertLibEdit ( )

private

Definition at line 541 of file sch_commit.cpp.

References COMMIT::clear(), copy, COMMIT::Empty(), TOOL_MANAGER::GetTool(), TOOL_MANAGER::GetToolHolder(), COMMIT::m_changes, m_toolMgr, TOOL_BASE::MODEL_RELOAD, SCH_SELECTION_TOOL::RebuildSelection(), TOOL_MANAGER::ResetTools(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

Referenced by Revert().

Stage() [1/3]

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

overridevirtual

Reimplemented from COMMIT.

Definition at line 122 of file sch_commit.cpp.

References COMMIT::Stage().

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 70 of file sch_commit.cpp.

References CHT_MODIFY, EDA_ITEM::ClearSelected(), EDA_ITEM::GetParent(), group, EDA_ITEM::HasFlag(), EDA_ITEM::IsSelected(), EDA_ITEM::IsType(), SCH_SHEET_T, SELECTED_BY_DRAG, EDA_ITEM::SetSelected(), COMMIT::Stage(), Stage(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), 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 112 of file sch_commit.cpp.

References 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(), BOARD_COMMIT::Push(), pushLibEdit(), pushSchEdit(), Revert(), BOARD_COMMIT::Revert(), 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_isLibEditor

bool SCH_COMMIT::m_isLibEditor

private

Definition at line 77 of file sch_commit.h.

Referenced by makeImage(), parentObject(), Push(), Revert(), and SCH_COMMIT().

m_toolMgr

TOOL_MANAGER* SCH_COMMIT::m_toolMgr

private

Definition at line 76 of file sch_commit.h.

Referenced by makeImage(), parentObject(), pushLibEdit(), pushSchEdit(), Revert(), revertLibEdit(), and SCH_COMMIT().

---

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

• sch_commit.h
• sch_commit.cpp