SCH_EDITOR_CONTROL Class Reference

Handle actions specific to the schematic editor. More...

#include <sch_editor_control.h>

Inheritance diagram for SCH_EDITOR_CONTROL:

Public Types
enum	RESET_REASON {   RUN , MODEL_RELOAD , SUPERMODEL_RELOAD , GAL_SWITCH ,   REDRAW , SHUTDOWN }
	Determine the reason of reset for a tool. More...

Public Member Functions
	SCH_EDITOR_CONTROL ()
	~SCH_EDITOR_CONTROL ()
int	New (const TOOL_EVENT &aEvent)
int	Open (const TOOL_EVENT &aEvent)
int	Save (const TOOL_EVENT &aEvent)
int	SaveAs (const TOOL_EVENT &aEvent)
int	SaveCurrSheetCopyAs (const TOOL_EVENT &aEvent)
	Saves the currently-open schematic sheet to an other name.
int	Revert (const TOOL_EVENT &aEvent)
int	ShowSchematicSetup (const TOOL_EVENT &aEvent)
int	PageSetup (const TOOL_EVENT &aEvent)
int	Print (const TOOL_EVENT &aEvent)
int	Plot (const TOOL_EVENT &aEvent)
int	Quit (const TOOL_EVENT &aEvent)
int	RescueSymbols (const TOOL_EVENT &aEvent)
	Perform rescue operations to recover old projects from before certain changes were made.
int	RemapSymbols (const TOOL_EVENT &aEvent)
bool	RescueLegacyProject (bool aRunningOnDemand)
bool	RescueSymbolLibTableProject (bool aRunningOnDemand)
	Notifies pcbnew about the selected item.
int	CrossProbeToPcb (const TOOL_EVENT &aEvent)
	Equivalent to the above, but initiated by the user.
int	ExplicitCrossProbeToPcb (const TOOL_EVENT &aEvent)
int	ExportSymbolsToLibrary (const TOOL_EVENT &aEvent)
int	SimProbe (const TOOL_EVENT &aEvent)
int	SimTune (const TOOL_EVENT &aEvent)
	Highlight net under the cursor.
int	HighlightNet (const TOOL_EVENT &aEvent)
	Remove any net highlighting.
int	ClearHighlight (const TOOL_EVENT &aEvent)
	Update net highlighting after an edit.
int	UpdateNetHighlighting (const TOOL_EVENT &aEvent)
	Launch a tool to highlight nets.
int	HighlightNetCursor (const TOOL_EVENT &aEvent)
int	AssignNetclass (const TOOL_EVENT &aEvent)
int	Undo (const TOOL_EVENT &aEvent)
int	Redo (const TOOL_EVENT &aEvent)
	Clipboard support.
int	Cut (const TOOL_EVENT &aEvent)
int	Copy (const TOOL_EVENT &aEvent)
int	CopyAsText (const TOOL_EVENT &aEvent)
int	Paste (const TOOL_EVENT &aEvent)
int	Duplicate (const TOOL_EVENT &aEvent)
int	EditWithSymbolEditor (const TOOL_EVENT &aEvent)
int	ShowCvpcb (const TOOL_EVENT &aEvent)
int	Annotate (const TOOL_EVENT &aEvent)
int	IncrementAnnotations (const TOOL_EVENT &aEvent)
int	EditSymbolFields (const TOOL_EVENT &aEvent)
int	EditSymbolLibraryLinks (const TOOL_EVENT &aEvent)
int	ShowPcbNew (const TOOL_EVENT &aEvent)
int	UpdatePCB (const TOOL_EVENT &aEvent)
int	UpdateFromPCB (const TOOL_EVENT &aEvent)
int	ImportFPAssignments (const TOOL_EVENT &aEvent)
int	ExportNetlist (const TOOL_EVENT &aEvent)
int	GenerateBOM (const TOOL_EVENT &aEvent)
int	GenerateBOMLegacy (const TOOL_EVENT &aEvent)
int	DrawSheetOnClipboard (const TOOL_EVENT &aEvent)
int	ShowSearch (const TOOL_EVENT &aEvent)
int	ShowHierarchy (const TOOL_EVENT &aEvent)
int	ShowNetNavigator (const TOOL_EVENT &aEvent)
int	ToggleProperties (const TOOL_EVENT &aEvent)
int	ToggleLibraryTree (const TOOL_EVENT &aEvent)
int	ToggleHiddenPins (const TOOL_EVENT &aEvent)
int	ToggleHiddenFields (const TOOL_EVENT &aEvent)
int	ToggleDirectiveLabels (const TOOL_EVENT &aEvent)
int	ToggleERCWarnings (const TOOL_EVENT &aEvent)
int	ToggleERCErrors (const TOOL_EVENT &aEvent)
int	ToggleERCExclusions (const TOOL_EVENT &aEvent)
int	MarkSimExclusions (const TOOL_EVENT &aEvent)
int	ToggleOPVoltages (const TOOL_EVENT &aEvent)
int	ToggleOPCurrents (const TOOL_EVENT &aEvent)
int	TogglePinAltIcons (const TOOL_EVENT &aEvent)
int	ChangeLineMode (const TOOL_EVENT &aEvent)
int	NextLineMode (const TOOL_EVENT &aEvent)
int	ToggleAnnotateAuto (const TOOL_EVENT &aEvent)
int	ToggleAnnotateRecursive (const TOOL_EVENT &aEvent)
int	TogglePythonConsole (const TOOL_EVENT &aEvent)
int	ReloadPlugins (const TOOL_EVENT &aEvent)
int	GridFeedback (const TOOL_EVENT &aEvent)
int	RepairSchematic (const TOOL_EVENT &aEvent)
void	AssignFootprints (const std::string &aChangedSetOfReferences)
SCH_ITEM *	FindSymbolAndItem (const wxString *aPath, const wxString *aReference, bool aSearchHierarchy, SCH_SEARCH_T aSearchType, const wxString &aSearchText)
	Find a symbol in the schematic and an item in this symbol and select it.
void	SetHighlightBusMembers (bool aHighlightBusMembers)
bool	GetHighlightBusMembers () const
int	PlaceLinkedDesignBlock (const TOOL_EVENT &aEvent)
int	SaveToLinkedDesignBlock (const TOOL_EVENT &aEvent)
bool	Init () override
	Init() is called once upon a registration of the tool.
void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.
bool	IsSymbolEditor () const
	Returns true if the tool is running in the symbol editor.
void	Activate ()
	Run the tool.
TOOL_MENU &	GetToolMenu ()
void	SetContextMenu (ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger=CMENU_BUTTON)
	Assign a context menu and tells when it should be activated.
void	RunMainStack (std::function< void()> aFunc)
	Call a function using the main stack.
template<class T >
void	Go (int(T::*aStateFunc)(const TOOL_EVENT &), const TOOL_EVENT_LIST &aConditions=TOOL_EVENT(TC_ANY, TA_ANY))
	Define which state (aStateFunc) to go when a certain event arrives (aConditions).
TOOL_EVENT *	Wait (const TOOL_EVENT_LIST &aEventList=TOOL_EVENT(TC_ANY, TA_ANY))
	Suspend execution of the tool until an event specified in aEventList arrives.
TOOL_TYPE	GetType () const
	Return the type of the tool.
TOOL_ID	GetId () const
	Return the unique identifier of the tool.
const std::string &	GetName () const
	Return the name of the tool.
TOOL_MANAGER *	GetManager () const
	Return the instance of TOOL_MANAGER that takes care of the tool.
bool	IsToolActive () const

Protected Member Functions
void	updateItem (EDA_ITEM *aItem, bool aUpdateRTree) const
	Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree.
void	saveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false, bool aDirtyConnectivity=true)
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to.
KIGFX::VIEW *	getView () const
	Returns the instance of #VIEW object used in the application.
KIGFX::VIEW_CONTROLS *	getViewControls () const
	Return the instance of VIEW_CONTROLS object used in the application.
template<typename T >
T *	getEditFrame () const
	Return the application window object, casted to requested user type.
template<typename T >
T *	getModel () const
	Return the model object if it matches the requested type.

Protected Attributes
SCH_EDIT_FRAME *	m_frame
KIGFX::SCH_VIEW *	m_view
SCH_SELECTION_TOOL *	m_selectionTool
bool	m_isSymbolEditor
std::unique_ptr< TOOL_MENU >	m_menu
	The functions below are not yet implemented - their interface may change.
TOOL_TYPE	m_type
TOOL_ID	m_toolId
	Unique id, assigned by a TOOL_MANAGER instance.
std::string	m_toolName
	Names are expected to obey the format application.ToolName (eg.
TOOL_MANAGER *	m_toolMgr

Private Member Functions
bool	doCopy (bool aUseDuplicateClipboard=false)
	< copy selection to clipboard or to m_duplicateClipboard
bool	rescueProject (RESCUER &aRescuer, bool aRunningOnDemand)
bool	searchSupplementaryClipboard (const wxString &aSheetFilename, SCH_SCREEN **aScreen)
void	doCrossProbeSchToPcb (const TOOL_EVENT &aEvent, bool aForce)
void	updatePastedSymbol (SCH_SYMBOL *aSymbol, const SCH_SHEET_PATH &aPastePath, const KIID_PATH &aClipPath, bool aForceKeepAnnotations)
SCH_SHEET_PATH	updatePastedSheet (SCH_SHEET *aSheet, const SCH_SHEET_PATH &aPastePath, const KIID_PATH &aClipPath, bool aForceKeepAnnotations, SCH_SHEET_LIST *aPastedSheets, std::map< SCH_SHEET_PATH, SCH_REFERENCE_LIST > &aPastedSymbols)
void	setPastedSymbolInstances (const SCH_SCREEN *aScreen)
void	prunePastedSymbolInstances ()
	Remove all pasted symbol instances that do not belong to the current project.
bool	processCmpToFootprintLinkFile (const wxString &aFullFilename, bool aForceVisibilityState, bool aVisibilityState)
	Read the footprint info from each line in the stuff file by reference designator.
void	setTransitions () override
	This method is meant to be overridden in order to specify handlers for events.
void	resetTransitions ()
	Clear the current transition map and restores the default one created by setTransitions().
void	goInternal (TOOL_STATE_FUNC &aState, const TOOL_EVENT_LIST &aConditions)
EDA_ITEM *	getModelInternal () const
TOOLS_HOLDER *	getToolHolderInternal () const

Private Attributes
bool	m_probingPcbToSch
EDA_ITEM *	m_pickerItem
std::string	m_duplicateClipboard
bool	m_duplicateIsHoverSelection
bool	m_highlightBusMembers
std::map< wxString, SCH_SCREEN * >	m_supplementaryClipboard
std::map< KIID_PATH, SCH_SYMBOL_INSTANCE >	m_clipboardSymbolInstances
std::set< SCH_SYMBOL * >	m_pastedSymbols

Detailed Description

Handle actions specific to the schematic editor.

Definition at line 38 of file sch_editor_control.h.

Member Enumeration Documentation

RESET_REASON

enum TOOL_BASE::RESET_REASON

inherited

Determine the reason of reset for a tool.

Enumerator
RUN	Tool is invoked after being inactive.
MODEL_RELOAD	Model changes (the sheet for a schematic)
SUPERMODEL_RELOAD	For schematics, the entire schematic changed, not just the sheet.
GAL_SWITCH	Rendering engine changes.
REDRAW	Full drawing refresh.
SHUTDOWN	Tool is being shut down.

Definition at line 77 of file tool_base.h.

Constructor & Destructor Documentation

SCH_EDITOR_CONTROL()

SCH_EDITOR_CONTROL::SCH_EDITOR_CONTROL ( )

inline

Definition at line 41 of file sch_editor_control.h.

~SCH_EDITOR_CONTROL()

SCH_EDITOR_CONTROL::~SCH_EDITOR_CONTROL ( )

inline

Definition at line 49 of file sch_editor_control.h.

Member Function Documentation

Activate()

void TOOL_INTERACTIVE::Activate ( )

inherited

Run the tool.

After activation, the tool starts receiving events until it is finished.

Definition at line 65 of file tool_interactive.cpp.

References TOOL_MANAGER::InvokeTool(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), HighlightNetCursor(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), SCH_POINT_EDITOR::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDRCDialog(), SimProbe(), SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Annotate()

int SCH_EDITOR_CONTROL::Annotate

(

const TOOL_EVENT &

aEvent

)

Definition at line 2399 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::OnAnnotate().

Referenced by setTransitions().

AssignFootprints()

void SCH_EDITOR_CONTROL::AssignFootprints

(

const std::string &

aChangedSetOfReferences

)

Definition at line 45 of file assign_footprints.cpp.

References From_UTF8(), SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetField(), SCH_SHEET_LIST::GetSymbols(), SCHEMATIC::Hierarchy(), EDA_TEXT::IsVisible(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, COMMIT::Modify(), SCH_COMMIT::Push(), Scan(), SCH_EDIT_FRAME::Schematic(), SCH_FIELD::SetText(), EDA_TEXT::SetVisible(), SCH_BASE_FRAME::SyncView(), and THROW_IO_ERROR.

Referenced by SCH_EDIT_FRAME::KiwayMailIn().

AssignNetclass()

int SCH_EDITOR_CONTROL::AssignNetclass

(

const TOOL_EVENT &

aEvent

)

Definition at line 872 of file sch_editor_control.cpp.

References _, CLEAR, SCH_SELECTION_TOOL::ClearSelection(), SCH_CONNECTION::Driver(), EDA_DRAW_PANEL_GAL::ForceRefresh(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), highlightNet(), SCH_CONNECTION::IsBus(), SCH_SHEET_PATH::LastScreen(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, SCH_CONNECTION::Name(), NET_SETTINGS::ParseBusGroup(), NET_SETTINGS::ParseBusVector(), SCH_EDIT_FRAME::Schematic(), CONNECTION_SUBGRAPH::SHEET_PIN, and EDA_BASE_FRAME::ShowInfoBarError().

Referenced by setTransitions().

attachManager()

void TOOL_BASE::attachManager ( TOOL_MANAGER *  aManager )

protectedinherited

Set the TOOL_MANAGER the tool will belong to.

Called by TOOL_MANAGER::RegisterTool()

Definition at line 62 of file tool_base.cpp.

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

ChangeLineMode()

int SCH_EDITOR_CONTROL::ChangeLineMode

(

const TOOL_EVENT &

aEvent

)

Definition at line 2758 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::DRAWING::line_mode, EESCHEMA_SETTINGS::m_Drawing, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, TOOL_EVENT::Parameter(), TOOL_MANAGER::PostAction(), and ACTIONS::refreshPreview.

Referenced by setTransitions().

ClearHighlight()

int SCH_EDITOR_CONTROL::ClearHighlight

(

const TOOL_EVENT &

aEvent

)

Update net highlighting after an edit.

Definition at line 864 of file sch_editor_control.cpp.

References CLEAR, highlightNet(), and TOOL_BASE::m_toolMgr.

Referenced by setTransitions().

Copy()

int SCH_EDITOR_CONTROL::Copy

(

const TOOL_EVENT &

aEvent

)

Definition at line 1390 of file sch_editor_control.cpp.

References doCopy().

Referenced by setTransitions().

CopyAsText()

int SCH_EDITOR_CONTROL::CopyAsText

(

const TOOL_EVENT &

aEvent

)

Definition at line 1406 of file sch_editor_control.cpp.

References GetSelectedItemsAsText(), TOOL_MANAGER::GetTool(), TOOL_BASE::m_toolMgr, SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SaveClipboard(), and ACTIONS::selectionClear.

Referenced by setTransitions().

CrossProbeToPcb()

int SCH_EDITOR_CONTROL::CrossProbeToPcb

(

const TOOL_EVENT &

aEvent

)

Equivalent to the above, but initiated by the user.

Definition at line 320 of file sch_editor_control.cpp.

References doCrossProbeSchToPcb().

Referenced by setTransitions().

Cut()

int SCH_EDITOR_CONTROL::Cut

(

const TOOL_EVENT &

aEvent

)

Definition at line 1373 of file sch_editor_control.cpp.

References doCopy(), ACTIONS::doDelete, TOOL_BASE::m_toolMgr, and TOOL_MANAGER::RunAction().

Referenced by setTransitions().

doCopy()

bool SCH_EDITOR_CONTROL::doCopy ( bool  aUseDuplicateClipboard = false )

private

< copy selection to clipboard or to m_duplicateClipboard

Definition at line 1284 of file sch_editor_control.cpp.

References SCH_IO_KICAD_SEXPR::Format(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET::GetFileName(), SCH_SHEET::GetScreen(), SCH_EDIT_FRAME::GetScreen(), STRING_FORMATTER::GetString(), TOOL_MANAGER::GetTool(), m_duplicateClipboard, m_duplicateIsHoverSelection, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_supplementaryClipboard, TOOL_BASE::m_toolMgr, KICAD_FORMAT::Prettify(), SCH_SCREEN::Remove(), SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SaveClipboard(), SCH_FIELD_T, SCH_GROUP_T, SCH_MARKER_T, SCH_SHEET_T, SCH_EDIT_FRAME::Schematic(), and ACTIONS::selectionClear.

Referenced by Copy(), Cut(), and Duplicate().

doCrossProbeSchToPcb()

void SCH_EDITOR_CONTROL::doCrossProbeSchToPcb ( const TOOL_EVENT &  aEvent, bool  aForce  )

private

Definition at line 334 of file sch_editor_control.cpp.

References SCH_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), SCH_EDIT_FRAME::IsSyncingSelection(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_probingPcbToSch, TOOL_BASE::m_toolMgr, SCH_SELECTION_TOOL::RequestSelection(), and SCH_EDIT_FRAME::SendSelectItemsToPcb().

Referenced by CrossProbeToPcb(), and ExplicitCrossProbeToPcb().

DrawSheetOnClipboard()

int SCH_EDITOR_CONTROL::DrawSheetOnClipboard

(

const TOOL_EVENT &

aEvent

)

Definition at line 2557 of file sch_editor_control.cpp.

References SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), LOCAL_CLEANUP, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::RecalculateConnections().

Referenced by setTransitions().

Duplicate()

int SCH_EDITOR_CONTROL::Duplicate

(

const TOOL_EVENT &

aEvent

)

Definition at line 1364 of file sch_editor_control.cpp.

References doCopy(), and Paste().

Referenced by setTransitions().

EditSymbolFields()

int SCH_EDITOR_CONTROL::EditSymbolFields

(

const TOOL_EVENT &

aEvent

)

Definition at line 2471 of file sch_editor_control.cpp.

References SCH_EDIT_FRAME::GetSymbolFieldsTableDialog(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, DIALOG_SHIM::Show(), and DIALOG_SYMBOL_FIELDS_TABLE::ShowEditTab().

Referenced by setTransitions().

EditSymbolLibraryLinks()

int SCH_EDITOR_CONTROL::EditSymbolLibraryLinks

(

const TOOL_EVENT &

aEvent

)

Definition at line 2489 of file sch_editor_control.cpp.

References SCH_EDIT_FRAME::HardRedraw(), InvokeDialogEditSymbolsLibId(), and SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame.

Referenced by setTransitions().

EditWithSymbolEditor()

int SCH_EDITOR_CONTROL::EditWithSymbolEditor

(

const TOOL_EVENT &

aEvent

)

Definition at line 2340 of file sch_editor_control.cpp.

References _, SCH_ACTIONS::editLibSymbolWithLibEdit, SCH_ACTIONS::editWithLibEdit, FRAME_SCH_SYMBOL_EDITOR, KIWAY::GetBlockingDialog(), SCH_ITEM::GetBodyStyle(), EDA_ITEM::GetEditFlags(), SCH_SYMBOL::GetLibId(), TOOL_MANAGER::GetTool(), SCH_ITEM::GetUnit(), TOOL_EVENT::IsAction(), SYMBOL_EDIT_FRAME::IsLibraryTreeShown(), SCH_SYMBOL::IsMissingLibSymbol(), KIWAY_HOLDER::Kiway(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, KIWAY::Player(), SCH_SELECTION_TOOL::RequestSelection(), TOOL_MANAGER::RunAction(), SCH_SYMBOL_T, ACTIONS::selectionClear, EDA_BASE_FRAME::ShowInfoBarError(), ACTIONS::showSymbolEditor, and SYMBOL_EDIT_FRAME::ToggleLibraryTree().

Referenced by setTransitions().

ExplicitCrossProbeToPcb()

int SCH_EDITOR_CONTROL::ExplicitCrossProbeToPcb

(

const TOOL_EVENT &

aEvent

)

Definition at line 327 of file sch_editor_control.cpp.

References doCrossProbeSchToPcb().

Referenced by setTransitions().

ExportNetlist()

int SCH_EDITOR_CONTROL::ExportNetlist

(

const TOOL_EVENT &

aEvent

)

Definition at line 2520 of file sch_editor_control.cpp.

References InvokeDialogNetList(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and NET_PLUGIN_CHANGE.

Referenced by setTransitions().

ExportSymbolsToLibrary()

int SCH_EDITOR_CONTROL::ExportSymbolsToLibrary

(

const TOOL_EVENT &

aEvent

)

Definition at line 347 of file sch_editor_control.cpp.

References _, SCHEMATIC::BuildSheetListSortedByPageNumbers(), SCH_IO_MGR::EnumFromStr(), SCH_ITEM::ERC, SYMBOL_LIB_TABLE::FindRow(), LIB_SYMBOL::Flatten(), FN_NORMALIZE_FLAGS, SCH_REFERENCE_LIST::GetCount(), LIB_TABLE_ROW::GetFullURI(), SYMBOL_LIB_TABLE::GetGlobalLibTable(), SYMBOL_LIB_TABLE::GetGlobalTableFileName(), LIB_SYMBOL::GetLibId(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SCH_SYMBOL::GetLibSymbolRef(), LIB_SYMBOL::GetName(), LIB_TABLE_ROW::GetNickName(), PROJECT::GetProjectPath(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), SCH_SHEET_LIST::GetSymbols(), SYMBOL_LIB_TABLE_ROW::GetType(), PROJECT::IsNullProject(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, COMMIT::Modify(), KIWAY_HOLDER::Prj(), SCH_COMMIT::Push(), LIB_TABLE::Save(), SCH_EDIT_FRAME::Schematic(), PROJECT_SCH::SchSymbolLibTable(), SCH_BASE_FRAME::SelectLibrary(), LIB_ID::SetLibNickname(), SCH_SCREEN::UpdateSymbolLinks(), and IO_ERROR::What().

Referenced by setTransitions().

FindSymbolAndItem()

SCH_ITEM * SCH_EDITOR_CONTROL::FindSymbolAndItem	(	const wxString *	aPath,
		const wxString *	aReference,
		bool	aSearchHierarchy,
		SCH_SEARCH_T	aSearchType,
		const wxString &	aSearchText
	)

Find a symbol in the schematic and an item in this symbol and select it.

Parameters

aPath	The symbol path to find. Pass nullptr to search by aReference.
aReference	The symbol reference designator to find, or to display in status bar if aPath is specified
aSearchHierarchy	If false, search the current sheet only. Otherwise, the entire hierarchy
aSearchType	A SCH_SEARCH_T value used to determine what to search for.
aSearchText	The text to search for, either in value, reference or elsewhere.

Definition at line 47 of file eeschema/cross-probing.cpp.

References _, KIID::AsString(), CROSS_PROBING_SETTINGS::center_on_items, SCH_ACTIONS::changeSheet, SCH_BASE_FRAME::eeconfig(), SCH_EDIT_FRAME::FocusOnItem(), SCH_SYMBOL::GetBoundingBox(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SYMBOL::GetPin(), SCH_SYMBOL::GetRef(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), SCH_ITEM::GetUnit(), SCHEMATIC::Hierarchy(), HIGHLIGHT_PIN, SCH_SCREEN::Items(), APP_SETTINGS_BASE::m_CrossProbing, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, EDA_ITEM::m_Uuid, EE_RTREE::OfType(), path, pin, EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::RunAction(), SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), and CROSS_PROBING_SETTINGS::zoom_to_fit.

GenerateBOM()

int SCH_EDITOR_CONTROL::GenerateBOM

(

const TOOL_EVENT &

aEvent

)

Definition at line 2532 of file sch_editor_control.cpp.

References SCH_EDIT_FRAME::GetSymbolFieldsTableDialog(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, DIALOG_SHIM::Show(), and DIALOG_SYMBOL_FIELDS_TABLE::ShowExportTab().

Referenced by setTransitions().

GenerateBOMLegacy()

int SCH_EDITOR_CONTROL::GenerateBOMLegacy

(

const TOOL_EVENT &

aEvent

)

Definition at line 2550 of file sch_editor_control.cpp.

References InvokeDialogCreateBOM(), and SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame.

Referenced by setTransitions().

getEditFrame()

template<typename T >

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

Return the application window object, casted to requested user type.

Definition at line 186 of file tool_base.h.

References TOOL_BASE::getToolHolderInternal(), and T.

Referenced by ZONE_CREATE_HELPER::createNewZone(), and ZONE_CREATE_HELPER::setUniquePriority().

GetHighlightBusMembers()

bool SCH_EDITOR_CONTROL::GetHighlightBusMembers ( ) const

inline

Definition at line 179 of file sch_editor_control.h.

References m_highlightBusMembers.

GetId()

TOOL_ID TOOL_BASE::GetId ( ) const

inlineinherited

Return the unique identifier of the tool.

The identifier is set by an instance of TOOL_MANAGER.

Returns

Identifier of the tool.

Definition at line 123 of file tool_base.h.

References TOOL_BASE::m_toolId.

Referenced by TOOL_MANAGER::finishTool(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::isActive(), TOOL_MANAGER::RegisterTool(), ACTION_MANAGER::RunHotKey(), TOOL_MANAGER::runTool(), TOOL_MANAGER::saveViewControls(), and TOOL_MANAGER::ShutdownTool().

GetManager()

TOOL_MANAGER * TOOL_BASE::GetManager ( ) const

inlineinherited

Return the instance of TOOL_MANAGER that takes care of the tool.

Returns

Instance of the TOOL_MANAGER or NULL if there is no associated tool manager.

Definition at line 146 of file tool_base.h.

References TOOL_BASE::m_toolMgr.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), ZONE_CREATE_HELPER::commitZone(), ZONE_CREATE_HELPER::createNewZone(), PNS_KICAD_IFACE::DisplayItem(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), PCB_TUNING_PATTERN::EditStart(), ACTION_MENU::getToolManager(), PNS_KICAD_IFACE::GetUnits(), makeShapeModificationMenu(), ZONE_CREATE_HELPER::OnFirstPoint(), ZONE_CREATE_HELPER::performZoneCutout(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), SCH_COMMIT::SCH_COMMIT(), PCB_TUNING_PATTERN::Update(), and GLOBAL_EDIT_TOOL::ZonesManager().

getModel()

template<typename T >

T * TOOL_BASE::getModel ( ) const

inlineprotectedinherited

Return the model object if it matches the requested type.

Definition at line 198 of file tool_base.h.

References TOOL_BASE::getModelInternal(), and T.

Referenced by ZONE_CREATE_HELPER::commitZone(), and ZONE_CREATE_HELPER::createZoneFromExisting().

getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 56 of file tool_base.cpp.

References TOOL_MANAGER::GetModel(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getModel().

GetName()

const std::string & TOOL_BASE::GetName ( ) const

inlineinherited

Return the name of the tool.

Tool names are expected to obey the format: application.ToolName (eg. pcbnew.InteractiveSelection).

Returns

The name of the tool.

Definition at line 136 of file tool_base.h.

References TOOL_BASE::m_toolName.

Referenced by PCB_CONTROL::AppendBoard(), TOOL_MANAGER::dispatchInternal(), TOOL_INTERACTIVE::goInternal(), COMMON_TOOLS::GridProperties(), SCH_DRAWING_TOOLS::ImportSheet(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 50 of file tool_base.cpp.

References TOOL_MANAGER::GetToolHolder(), and TOOL_BASE::m_toolMgr.

Referenced by TOOL_BASE::getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 112 of file tool_interactive.cpp.

References TOOL_INTERACTIVE::m_menu.

Referenced by EDIT_TOOL::doMoveSelection(), GROUP_TOOL::Init(), SCH_EDIT_TABLE_TOOL::Init(), SCH_INSPECTION_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_MOVE_TOOL::Init(), SCH_POINT_EDITOR::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), SYMBOL_EDITOR_MOVE_TOOL::Init(), SYMBOL_EDITOR_PIN_TOOL::Init(), PL_EDIT_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), and PCB_POINT_EDITOR::Init().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 111 of file tool_base.h.

References TOOL_BASE::m_type.

Referenced by TOOL_MANAGER::InvokeTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), and TOOL_MANAGER::ShutdownTool().

getView()

KIGFX::VIEW * TOOL_BASE::getView ( ) const

protectedinherited

Returns the instance of #VIEW object used in the application.

It allows tools to draw.

Returns

The instance of VIEW.

Definition at line 38 of file tool_base.cpp.

References TOOL_MANAGER::GetView(), and TOOL_BASE::m_toolMgr.

Referenced by SCH_POINT_EDITOR::addCornerCondition(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), SCH_INSPECTION_TOOL::CheckSymbol(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::CollectHits(), SCH_LINE_WIRE_BUS_TOOL::computeBreakPoint(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), COMMON_TOOLS::doCenter(), PL_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), SCH_SELECTION_TOOL::GetNode(), ROUTER_TOOL::getStartLayer(), PCB_CONTROL::GridPlaceOrigin(), PCB_CONTROL::GridResetOrigin(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::handleCommonEvents(), PL_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_SELECTION_TOOL::hitTestDistance(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), SCH_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), SCH_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), SCH_SELECTION_TOOL::Reset(), SCH_TOOL_BASE< T >::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PNS::TOOL_BASE::Reset(), BOARD_EDITOR_CONTROL::Reset(), DRAWING_TOOL::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PCB_CONTROL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_EDIT_TOOL::Rotate(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), PCB_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::SelectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), SimProbe(), SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), ToggleDirectiveLabels(), ToggleERCErrors(), ToggleERCWarnings(), ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), ToggleOPCurrents(), ToggleOPVoltages(), TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_SELECTION_TOOL::UnselectAll(), PCB_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::unselectVisually(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updateItem(), UpdateNetHighlighting(), SCH_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), SCH_SELECTION_TOOL::updateSelection(), PCB_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), PCB_TEST_SELECTION_TOOL::view(), SCH_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), PCB_SELECTION_TOOL::zoomFitSelection(), GERBVIEW_SELECTION_TOOL::~GERBVIEW_SELECTION_TOOL(), PCB_SELECTION_TOOL::~PCB_SELECTION_TOOL(), and SCH_SELECTION_TOOL::~SCH_SELECTION_TOOL().

getViewControls()

KIGFX::VIEW_CONTROLS * TOOL_BASE::getViewControls ( ) const

protectedinherited

Return the instance of VIEW_CONTROLS object used in the application.

It allows tools to read & modify user input and its settings (eg. show cursor, enable snapping to grid, etc.).

Returns

The instance of VIEW_CONTROLS.

Definition at line 44 of file tool_base.cpp.

References TOOL_MANAGER::GetViewControls(), and TOOL_BASE::m_toolMgr.

Referenced by SCH_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::addCornerCondition(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), PCB_TEST_SELECTION_TOOL::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Init(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), SCH_POINT_EDITOR::makePointsAndBehavior(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::RepeatDrawItem(), PL_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::SelectNode(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), SCH_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), PCB_POINT_EDITOR::setEditedPoint(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::SyncSheetsPins(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T >

void TOOL_INTERACTIVE::Go ( int(T::*)(const TOOL_EVENT &)  aStateFunc, const TOOL_EVENT_LIST &  aConditions = TOOL_EVENT( TC_ANY, TA_ANY )  )

inherited

Define which state (aStateFunc) to go when a certain event arrives (aConditions).

No conditions means any event.

Definition at line 147 of file tool_interactive.h.

References TOOL_INTERACTIVE::goInternal(), and T.

Referenced by EDA_3D_CONTROLLER::setTransitions(), BITMAP2CMP_CONTROL::setTransitions(), DESIGN_BLOCK_CONTROL::setTransitions(), GROUP_TOOL::setTransitions(), LIBRARY_EDITOR_CONTROL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), SCH_DESIGN_BLOCK_CONTROL::setTransitions(), SCH_DRAWING_TOOLS::setTransitions(), SCH_EDIT_TABLE_TOOL::setTransitions(), SCH_EDIT_TOOL::setTransitions(), setTransitions(), SCH_FIND_REPLACE_TOOL::setTransitions(), SCH_INSPECTION_TOOL::setTransitions(), SCH_LINE_WIRE_BUS_TOOL::setTransitions(), SCH_MOVE_TOOL::setTransitions(), SCH_NAVIGATE_TOOL::setTransitions(), SCH_POINT_EDITOR::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), SYMBOL_EDITOR_CONTROL::setTransitions(), SYMBOL_EDITOR_DRAWING_TOOLS::setTransitions(), SYMBOL_EDITOR_EDIT_TOOL::setTransitions(), SYMBOL_EDITOR_MOVE_TOOL::setTransitions(), SYMBOL_EDITOR_PIN_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), EMBED_TOOL::setTransitions(), PICKER_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), ZOOM_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), PCB_CALCULATOR_CONTROL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), MICROWAVE_TOOL::setTransitions(), SCRIPTING_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), ALIGN_DISTRIBUTE_TOOL::setTransitions(), ARRAY_TOOL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDIT_TOOL::setTransitions(), FOOTPRINT_CHOOSER_SELECTION_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), FOOTPRINT_WIZARD_TOOLS::setTransitions(), GENERATOR_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), MULTICHANNEL_TOOL::setTransitions(), PAD_TOOL::setTransitions(), PCB_CONTROL::setTransitions(), PCB_DESIGN_BLOCK_CONTROL::setTransitions(), PCB_EDIT_TABLE_TOOL::setTransitions(), PCB_PICKER_TOOL::setTransitions(), PCB_POINT_EDITOR::setTransitions(), PCB_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), and PCB_TEST_SELECTION_TOOL::setTransitions().

goInternal()

void TOOL_INTERACTIVE::goInternal ( TOOL_STATE_FUNC &  aState, const TOOL_EVENT_LIST &  aConditions  )

privateinherited

Definition at line 84 of file tool_interactive.cpp.

References TOOL_BASE::GetName(), kicadTraceToolStack, TOOL_BASE::m_toolMgr, TOOL_EVENT_LIST::Names(), and TOOL_MANAGER::ScheduleNextState().

Referenced by TOOL_INTERACTIVE::Go().

GridFeedback()

int SCH_EDITOR_CONTROL::GridFeedback

(

const TOOL_EVENT &

aEvent

)

Definition at line 2906 of file sch_editor_control.cpp.

References _, EDA_DRAW_FRAME::CreateHotkeyPopup(), EDA_DRAW_FRAME::GetHotkeyPopup(), TOOL_MANAGER::GetSettings(), grid, WINDOW_SETTINGS::grid, GRID_SETTINGS::grids, GRID_SETTINGS::last_size_idx, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, APP_SETTINGS_BASE::m_Window, Pgm(), and HOTKEY_CYCLE_POPUP::Popup().

Referenced by setTransitions().

HighlightNet()

int SCH_EDITOR_CONTROL::HighlightNet

(

const TOOL_EVENT &

aEvent

)

Remove any net highlighting.

Definition at line 853 of file sch_editor_control.cpp.

References TOOL_EVENT::DisableGridSnapping(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_BASE::getViewControls(), highlightNet(), and TOOL_BASE::m_toolMgr.

Referenced by setTransitions().

HighlightNetCursor()

int SCH_EDITOR_CONTROL::HighlightNetCursor

(

const TOOL_EVENT &

aEvent

)

Definition at line 1200 of file sch_editor_control.cpp.

References TOOL_INTERACTIVE::Activate(), PICKER_TOOL_BASE::ClearHandlers(), TOOL_MANAGER::GetTool(), highlightNet(), TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, TOOL_MANAGER::RunAction(), PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetCursor(), and PICKER_TOOL_BASE::SetSnapping().

Referenced by setTransitions().

ImportFPAssignments()

int SCH_EDITOR_CONTROL::ImportFPAssignments

(

const TOOL_EVENT &

aEvent

)

Definition at line 203 of file assign_footprints.cpp.

References _, DisplayError(), FILEEXT::FootprintAssignmentFileWildcard(), SCH_BASE_FRAME::GetCanvas(), PROJECT::GetProjectFullName(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_EDIT_FRAME::OnModify(), path, KIWAY_HOLDER::Prj(), processCmpToFootprintLinkFile(), EDA_DRAW_PANEL_GAL::Refresh(), and SCH_BASE_FRAME::SyncView().

Referenced by setTransitions().

IncrementAnnotations()

int SCH_EDITOR_CONTROL::IncrementAnnotations

(

const TOOL_EVENT &

aEvent

)

Definition at line 2406 of file sch_editor_control.cpp.

References _, SCHEMATIC::CurrentSheet(), COMMIT::Empty(), From_UTF8(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetRefNumber(), SCH_SHEET_PATH::GetSymbols(), SCH_SHEET_LIST::GetSymbols(), SCHEMATIC::Hierarchy(), SCH_REFERENCE::IsSplitNeeded(), SCH_SHEET_PATH::LastScreen(), DIALOG_INCREMENT_ANNOTATIONS_BASE::m_AllSheets, DIALOG_INCREMENT_ANNOTATIONS_BASE::m_FirstRefDes, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, DIALOG_INCREMENT_ANNOTATIONS_BASE::m_Increment, SCH_EDIT_FRAME::m_schematic, COMMIT::Modify(), SCH_COMMIT::Push(), DIALOG_SHIM::SetInitialFocus(), SCH_REFERENCE::SetRef(), DIALOG_SHIM::ShowModal(), SCH_REFERENCE::Split(), and SCH_REFERENCE_LIST::SplitReferences().

Referenced by setTransitions().

Init()

bool SCH_TOOL_BASE< SCH_EDIT_FRAME >::Init ( )

inlineoverridevirtualinherited

Init() is called once upon a registration of the tool.

Returns

True if the initialization went fine, false - otherwise.

Reimplemented from TOOL_BASE.

Definition at line 65 of file sch_tool_base.h.

IsSymbolEditor()

bool SCH_TOOL_BASE< SCH_EDIT_FRAME >::IsSymbolEditor ( ) const

inlineinherited

Returns true if the tool is running in the symbol editor.

Definition at line 100 of file sch_tool_base.h.

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 32 of file tool_base.cpp.

References TOOL_MANAGER::IsToolActive(), TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::Drag(), ROUTER_TOOL::handleLayerSwitch(), EDIT_TOOL::invokeInlineRouter(), PCB_SELECTION_TOOL::Main(), BOARD_EDITOR_CONTROL::TrackWidthDec(), and BOARD_EDITOR_CONTROL::TrackWidthInc().

MarkSimExclusions()

int SCH_EDITOR_CONTROL::MarkSimExclusions

(

const TOOL_EVENT &

aEvent

)

Definition at line 2671 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), KIGFX::GEOMETRY, SCH_BASE_FRAME::GetCanvas(), SCH_DRAW_PANEL::GetView(), EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EESCHEMA_SETTINGS::APPEARANCE::mark_sim_exclusions, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, text, and KIGFX::VIEW::UpdateAllItemsConditionally().

Referenced by setTransitions().

New()

int SCH_EDITOR_CONTROL::New

(

const TOOL_EVENT &

aEvent

)

Definition at line 100 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::NewProject().

Referenced by setTransitions().

NextLineMode()

int SCH_EDITOR_CONTROL::NextLineMode

(

const TOOL_EVENT &

aEvent

)

Definition at line 2766 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::DRAWING::line_mode, EESCHEMA_SETTINGS::m_Drawing, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, TOOL_MANAGER::PostAction(), and ACTIONS::refreshPreview.

Referenced by setTransitions().

Open()

int SCH_EDITOR_CONTROL::Open

(

const TOOL_EVENT &

aEvent

)

Definition at line 107 of file sch_editor_control.cpp.

References SCH_EDIT_FRAME::LoadProject(), and SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame.

Referenced by setTransitions().

PageSetup()

int SCH_EDITOR_CONTROL::PageSetup

(

const TOOL_EVENT &

aEvent

)

Definition at line 187 of file sch_editor_control.cpp.

References _, SCH_BASE_FRAME::GetCanvas(), SCHEMATIC::GetEmbeddedFiles(), SCH_EDIT_FRAME::GetScreen(), SCH_DRAW_PANEL::GetView(), BASE_SCREEN::m_DrawingSheetFileName, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, KIGFX::VIEW::MarkDirty(), MAX_PAGE_SIZE_EESCHEMA_MILS, SCH_EDIT_FRAME::OnModify(), PICKED_ITEMS_LIST::PushItem(), EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::Schematic(), PICKED_ITEMS_LIST::SetDescription(), DIALOG_PAGES_SETTINGS::SetWksFileName(), DIALOG_SHIM::ShowModal(), and KIGFX::VIEW::UpdateAllItems().

Referenced by setTransitions().

Paste()

int SCH_EDITOR_CONTROL::Paste

(

const TOOL_EVENT &

aEvent

)

Definition at line 1607 of file sch_editor_control.cpp.

References _, COMMIT::Added(), SCH_SHEET::AddInstance(), SCH_REFERENCE_LIST::AddItem(), KIGFX::VIEW::AddToPreview(), SCH_BASE_FRAME::AddToScreen(), annotate, SCH_SCREEN::Append(), SCH_SCREEN::CheckIfOnDrawList(), SCH_SCREEN::Clear(), KIGFX::VIEW::ClearPreview(), SHAPE_POLY_SET::CVertex(), DisplayError(), ACTIONS::duplicate, SCH_BASE_FRAME::eeconfig(), end, ENDPOINT, SCH_SHEET_LIST::FillItemMap(), SCH_SHEET_LIST::FindAllSheetsForScreen(), FN_NORMALIZE_FLAGS, SCH_SHAPE::GetCenter(), ADVANCED_CFG::GetCfg(), GetClipboardUTF8(), SCH_ITEM::GetConnectionPoints(), SCH_EDIT_FRAME::GetCurrentSheet(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), EDA_SHAPE::GetEnd(), SCH_SHEET::GetField(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), GetImageFromClipboard(), SCH_SHEET::GetInstances(), SCH_SYMBOL::GetInstances(), SCH_SCREEN::GetLibSymbols(), EDA_ITEM::GetParentGroup(), SCH_SHEET::GetPins(), SCH_SYMBOL::GetPins(), EDA_SHAPE::GetPolyShape(), EDA_ITEM::GetPosition(), PROJECT::GetProjectName(), PROJECT::GetProjectPath(), EDA_SHAPE::GetRectCorners(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCH_SHEET::GetScreen(), SCH_EDIT_FRAME::GetScreen(), SCH_SELECTION_TOOL::GetSelection(), EDA_SHAPE::GetShape(), SCH_SCREEN::GetSheetNames(), EDA_SHAPE::GetStart(), SCH_SHEET_LIST::GetSymbols(), EDA_TEXT::GetText(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), group, SCH_SHEET_LIST::HasPath(), KIGFX::VIEW::Hide(), SCHEMATIC::Hierarchy(), SCH_EDIT_FRAME::InitSheet(), IS_MOVING, IS_NEW, IS_PASTED, TOOL_EVENT::IsAction(), SCH_ITEM::IsConnectable(), IsOK(), SCH_SCREEN::Items(), SCH_SHEET_PATH::Last(), SCH_SHEET_PATH::LastScreen(), SCH_IO_KICAD_SEXPR::LoadContent(), SCH_EDIT_FRAME::LoadSheetFromFile(), EESCHEMA_SETTINGS::m_AnnotatePanel, SCHEMATIC_SETTINGS::m_AnnotateStartNum, m_clipboardSymbolInstances, m_duplicateClipboard, m_duplicateIsHoverSelection, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, ADVANCED_CFG::m_MaxPastedTextLength, SCH_SHEET_INSTANCE::m_PageNumber, m_pastedSymbols, SCH_SHEET_INSTANCE::m_Path, SCH_SHEET_INSTANCE::m_ProjectName, SCHEMATIC_SETTINGS::m_refDesTracker, TOOL_BASE::m_toolMgr, EDA_ITEM::m_Uuid, SCH_SCREEN::MigrateSimModels(), SCH_ACTIONS::move, SCH_SHEET_LIST::PageNumberExists(), ACTIONS::pasteSpecial, path, pin, KIWAY_HOLDER::Prj(), SCH_SCREENS::PruneOrphanedSheetInstances(), SCH_SCREENS::PruneOrphanedSymbolInstances(), prunePastedSymbolInstances(), SCH_COMMIT::Push(), SCHEMATIC::RefreshHierarchy(), SCH_EDIT_FRAME::RefreshNetNavigator(), SCH_SHEET::RemoveInstance(), SCH_COMMIT::Revert(), SCHEMATIC::Root(), TOOL_MANAGER::RunAction(), TOOL_MANAGER::RunSynchronousAction(), SCH_GROUP_T, SCH_LINE_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), SCH_SHEET::SearchHierarchy(), searchSupplementaryClipboard(), ACTIONS::selectionClear, ACTIONS::selectItems, SCH_ITEM::SetConnectivityDirty(), SCH_ITEM::SetLastResolvedState(), SCH_SYMBOL::SetLibSymbol(), EDA_ITEM::SetParent(), setPastedSymbolInstances(), SELECTION::SetReferencePoint(), SCH_SHEET::SetScreen(), SCH_REFERENCE::SetSheetNumber(), SCH_EDIT_FRAME::SetSheetNumberAndCount(), SCH_FIELD::SetText(), SCHEMATIC::Settings(), KIGFX::VIEW::SetVisible(), DIALOG_SHIM::ShowModal(), SCH_SHEET_LIST::SortByPageNumbers(), SCH_REFERENCE_LIST::SortByReferenceOnly(), STARTPOINT, SCH_SHEET_LIST::TestForRecursion(), EDA_ITEM::Type(), SCH_SHEET_PATH::UpdateAllScreenReferences(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), updatePastedSheet(), and updatePastedSymbol().

Referenced by Duplicate(), and setTransitions().

PlaceLinkedDesignBlock()

int SCH_EDITOR_CONTROL::PlaceLinkedDesignBlock

(

const TOOL_EVENT &

aEvent

)

Definition at line 2931 of file sch_editor_control.cpp.

References _, DESIGN_BLOCK_PANE::GetDesignBlock(), SCH_EDIT_FRAME::GetDesignBlockPane(), EDA_BASE_FRAME::GetInfoBar(), SCH_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), group, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, SCH_ACTIONS::placeDesignBlock, TOOL_MANAGER::RunAction(), SCH_GROUP_T, DESIGN_BLOCK_PANE::SelectLibId(), and WX_INFOBAR::ShowMessageFor().

Referenced by setTransitions().

Plot()

int SCH_EDITOR_CONTROL::Plot

(

const TOOL_EVENT &

aEvent

)

Definition at line 303 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

Print()

int SCH_EDITOR_CONTROL::Print

(

const TOOL_EVENT &

aEvent

)

Definition at line 293 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

processCmpToFootprintLinkFile()

bool SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile ( const wxString &  aFullFilename, bool  aForceVisibilityState, bool  aVisibilityState  )

private

Read the footprint info from each line in the stuff file by reference designator.

The footprint link file (.cmp) entries created by CvPcb:

BeginCmp TimeStamp = /32307DE2/AA450F67; Reference = C1; ValeurCmp = 47uF; IdModule = CP6; EndCmp

Parameters

aFullFilename	= the full filename to read
aForceVisibilityState	= Set to true to change the footprint field visibility state to aVisibilityState. False retains the current footprint field visibility state.
aVisibilityState	True to show the footprint field or false to hide the footprint field if aForceVisibilityState is true.

Returns

bool = true if success. Set up handlers for various events.

Definition at line 123 of file assign_footprints.cpp.

References From_UTF8(), SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetField(), SCH_SHEET_LIST::GetSymbols(), SCHEMATIC::Hierarchy(), LINE_READER::Line(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, FILE_LINE_READER::ReadLine(), SCH_EDIT_FRAME::Schematic(), SCH_SYMBOL::SetFootprintFieldText(), and EDA_TEXT::SetVisible().

Referenced by ImportFPAssignments().

prunePastedSymbolInstances()

void SCH_EDITOR_CONTROL::prunePastedSymbolInstances ( )

private

Remove all pasted symbol instances that do not belong to the current project.

Warning

This should only be called when cleaning up after a paste. Otherwise it could clobber symbol instances for schematics shared across projects. Use SCH_SCREENS::PruneOrphanedSymbolInstances() to clean up invalid instance for the current project.

Definition at line 1584 of file sch_editor_control.cpp.

References PROJECT::GetProjectName(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_pastedSymbols, path, and KIWAY_HOLDER::Prj().

Referenced by Paste().

Quit()

int SCH_EDITOR_CONTROL::Quit

(

const TOOL_EVENT &

aEvent

)

Definition at line 313 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame.

Referenced by setTransitions().

Redo()

int SCH_EDITOR_CONTROL::Redo

(

const TOOL_EVENT &

aEvent

)

Clipboard support.

Definition at line 1253 of file sch_editor_control.cpp.

References AS_GLOBAL, SCH_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::GetRedoCommandCount(), TOOL_MANAGER::GetTool(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), EDA_BASE_FRAME::PopCommandFromRedoList(), TOOL_MANAGER::ProcessEvent(), EDA_BASE_FRAME::PushCommandToUndoList(), SCH_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), PICKED_ITEMS_LIST::ReversePickersListOrder(), TA_UNDO_REDO_PRE, and TC_MESSAGE.

Referenced by setTransitions().

ReloadPlugins()

int SCH_EDITOR_CONTROL::ReloadPlugins

(

const TOOL_EVENT &

aEvent

)

Definition at line 2799 of file sch_editor_control.cpp.

References Pgm().

Referenced by setTransitions().

RemapSymbols()

int SCH_EDITOR_CONTROL::RemapSymbols

(

const TOOL_EVENT &

aEvent

)

Definition at line 281 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::GetCanvas(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), and DIALOG_SHIM::ShowQuasiModal().

Referenced by setTransitions().

RepairSchematic()

int SCH_EDITOR_CONTROL::RepairSchematic

(

const TOOL_EVENT &

aEvent

)

Definition at line 2809 of file sch_editor_control.cpp.

References _, DisplayInfoMessage(), SCHEMATIC::Hierarchy(), SCH_SCREEN::Items(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EE_RTREE::OfType(), SCH_EDIT_FRAME::OnModify(), TOOL_EVENT::Parameter(), pin, SCHEMATIC::RefreshHierarchy(), SCH_GROUP_T, SCH_SYMBOL_T, and SCH_EDIT_FRAME::Schematic().

Referenced by setTransitions().

RescueLegacyProject()

bool SCH_EDITOR_CONTROL::RescueLegacyProject

(

bool

aRunningOnDemand

)

Definition at line 232 of file sch_editor_control.cpp.

References EDA_DRAW_PANEL_GAL::GetBackend(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, KIWAY_HOLDER::Prj(), rescueProject(), and SCH_EDIT_FRAME::Schematic().

Referenced by RescueSymbols().

rescueProject()

bool SCH_EDITOR_CONTROL::rescueProject ( RESCUER &  aRescuer, bool  aRunningOnDemand  )

private

Definition at line 251 of file sch_editor_control.cpp.

References EDA_BASE_FRAME::ClearUndoRedoList(), FRAME_SCH_VIEWER, RESCUER::GetCandidateCount(), SCH_BASE_FRAME::GetCanvas(), GLOBAL_CLEANUP, KIWAY_HOLDER::Kiway(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_EDIT_FRAME::OnModify(), KIWAY::Player(), SCH_EDIT_FRAME::RecalculateConnections(), EDA_DRAW_PANEL_GAL::Refresh(), RESCUER::RescueProject(), SCHEMATIC::Root(), SCH_EDIT_FRAME::Schematic(), SCH_BASE_FRAME::SyncView(), and SCH_SCREENS::UpdateSymbolLinks().

Referenced by RescueLegacyProject(), and RescueSymbolLibTableProject().

RescueSymbolLibTableProject()

bool SCH_EDITOR_CONTROL::RescueSymbolLibTableProject

(

bool

aRunningOnDemand

)

Notifies pcbnew about the selected item.

Definition at line 241 of file sch_editor_control.cpp.

References EDA_DRAW_PANEL_GAL::GetBackend(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, KIWAY_HOLDER::Prj(), rescueProject(), and SCH_EDIT_FRAME::Schematic().

Referenced by RescueSymbols().

RescueSymbols()

int SCH_EDITOR_CONTROL::RescueSymbols

(

const TOOL_EVENT &

aEvent

)

Perform rescue operations to recover old projects from before certain changes were made.

• Exports cached symbols that conflict with new symbols to a separate library.
• Exports cached symbols not found in any symbol library.
• Renames symbols named before libraries were case sensitive.

Definition at line 219 of file sch_editor_control.cpp.

References SCH_SCREENS::HasNoFullyDefinedLibIds(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, RescueLegacyProject(), RescueSymbolLibTableProject(), SCHEMATIC::Root(), and SCH_EDIT_FRAME::Schematic().

Referenced by setTransitions().

Reset()

void SCH_TOOL_BASE< SCH_EDIT_FRAME >::Reset ( RESET_REASON  aReason )

inlineoverridevirtualinherited

Bring the tool to a known, initial state.

If the tool claimed anything from the model or the view, it must release it when its reset.

Parameters

aReason

contains information about the reason of tool reset.

Implements TOOL_BASE.

Definition at line 85 of file sch_tool_base.h.

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

Clear the current transition map and restores the default one created by setTransitions().

Definition at line 77 of file tool_interactive.cpp.

References TOOL_MANAGER::ClearTransitions(), TOOL_BASE::m_toolMgr, and TOOL_INTERACTIVE::setTransitions().

Revert()

int SCH_EDITOR_CONTROL::Revert

(

const TOOL_EVENT &

aEvent

)

Definition at line 147 of file sch_editor_control.cpp.

References _, SCH_ACTIONS::changeSheet, SCH_EDIT_FRAME::GetCurrentSheet(), SCHEMATIC::GetFileName(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), TOOLS_HOLDER::GetToolManager(), IsOK(), KICTL_REVERT, SCH_SHEET_PATH::Last(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_EDIT_FRAME::OpenProjectFiles(), SCH_SHEET_PATH::push_back(), EDA_DRAW_FRAME::ReleaseFile(), SCHEMATIC::Root(), TOOL_MANAGER::RunAction(), and SCH_EDIT_FRAME::Schematic().

Referenced by setTransitions().

RunMainStack()

void TOOL_INTERACTIVE::RunMainStack ( std::function< void()>  aFunc )

inherited

Call a function using the main stack.

Parameters

aFunc

is the function to be calls.

Definition at line 106 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::RunMainStack().

Referenced by DRAWING_TOOL::PlaceText().

Save()

int SCH_EDITOR_CONTROL::Save

(

const TOOL_EVENT &

aEvent

)

Definition at line 114 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::SaveProject().

Referenced by setTransitions().

SaveAs()

int SCH_EDITOR_CONTROL::SaveAs

(

const TOOL_EVENT &

aEvent

)

Definition at line 121 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::SaveProject().

Referenced by setTransitions().

saveCopyInUndoList()

void SCH_TOOL_BASE< SCH_EDIT_FRAME >::saveCopyInUndoList ( EDA_ITEM *  aItem, UNDO_REDO  aType, bool  aAppend = false, bool  aDirtyConnectivity = true  )

inlineprotectedinherited

Definition at line 117 of file sch_tool_base.h.

SaveCurrSheetCopyAs()

int SCH_EDITOR_CONTROL::SaveCurrSheetCopyAs

(

const TOOL_EVENT &

aEvent

)

Saves the currently-open schematic sheet to an other name.

Definition at line 128 of file sch_editor_control.cpp.

References _, EnsureFileExtension(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SHEET::GetFileName(), FILEEXT::KiCadSchematicFileExtension, FILEEXT::KiCadSchematicFileWildcard(), SCH_SHEET_PATH::Last(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::saveSchematicFile().

Referenced by setTransitions().

SaveToLinkedDesignBlock()

int SCH_EDITOR_CONTROL::SaveToLinkedDesignBlock

(

const TOOL_EVENT &

aEvent

)

Definition at line 2978 of file sch_editor_control.cpp.

References _, DESIGN_BLOCK_PANE::GetDesignBlock(), SCH_EDIT_FRAME::GetDesignBlockPane(), EDA_BASE_FRAME::GetInfoBar(), SCH_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), group, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, TOOL_MANAGER::RunAction(), SCH_ACTIONS::saveSelectionToDesignBlock, SCH_GROUP_T, DESIGN_BLOCK_PANE::SelectLibId(), and WX_INFOBAR::ShowMessageFor().

Referenced by setTransitions().

searchSupplementaryClipboard()

bool SCH_EDITOR_CONTROL::searchSupplementaryClipboard ( const wxString &  aSheetFilename, SCH_SCREEN **  aScreen  )

private

Definition at line 1351 of file sch_editor_control.cpp.

References m_supplementaryClipboard.

Referenced by Paste().

SetContextMenu()

void TOOL_INTERACTIVE::SetContextMenu ( ACTION_MENU *  aMenu, CONTEXT_MENU_TRIGGER  aTrigger = CMENU_BUTTON  )

inherited

Assign a context menu and tells when it should be activated.

Parameters

aMenu	is the menu to be assigned.
aTrigger	determines conditions upon which the context menu is activated.

Definition at line 95 of file tool_interactive.cpp.

References CMENU_OFF, TOOL_BASE::m_toolMgr, TOOL_MANAGER::ScheduleContextMenu(), and ACTION_MENU::SetTool().

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), TOOL_MENU::ShowContextMenu(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

SetHighlightBusMembers()

void SCH_EDITOR_CONTROL::SetHighlightBusMembers ( bool  aHighlightBusMembers )

inline

Definition at line 174 of file sch_editor_control.h.

References m_highlightBusMembers.

setPastedSymbolInstances()

void SCH_EDITOR_CONTROL::setPastedSymbolInstances ( const SCH_SCREEN *  aScreen )

private

Definition at line 1559 of file sch_editor_control.cpp.

References SCH_SYMBOL::GetInstances(), SCH_SCREEN::Items(), m_clipboardSymbolInstances, EDA_ITEM::m_Uuid, and SCH_SYMBOL_T.

Referenced by Paste().

setTransitions()

void SCH_EDITOR_CONTROL::setTransitions ( )

overrideprivatevirtual

This method is meant to be overridden in order to specify handlers for events.

It is called every time tool is reset or finished.

Implements TOOL_INTERACTIVE.

Definition at line 3016 of file sch_editor_control.cpp.

References SCH_ACTIONS::annotate, Annotate(), SCH_ACTIONS::assignFootprints, SCH_ACTIONS::assignNetclass, AssignNetclass(), ChangeLineMode(), EVENTS::ClearedEvent, SCH_ACTIONS::clearHighlight, ClearHighlight(), Copy(), ACTIONS::copy, CopyAsText(), ACTIONS::copyAsText, CrossProbeToPcb(), Cut(), ACTIONS::cut, ACTIONS::doNew, SCH_ACTIONS::drawSheetOnClipboard, DrawSheetOnClipboard(), Duplicate(), ACTIONS::duplicate, SCH_ACTIONS::editLibSymbolWithLibEdit, SCH_ACTIONS::editSymbolFields, EditSymbolFields(), SCH_ACTIONS::editSymbolLibraryLinks, EditSymbolLibraryLinks(), SCH_ACTIONS::editWithLibEdit, EditWithSymbolEditor(), ExplicitCrossProbeToPcb(), SCH_ACTIONS::exportNetlist, ExportNetlist(), SCH_ACTIONS::exportSymbolsToLibrary, ExportSymbolsToLibrary(), SCH_ACTIONS::generateBOM, GenerateBOM(), SCH_ACTIONS::generateBOMLegacy, GenerateBOMLegacy(), TOOL_INTERACTIVE::Go(), EVENTS::GridChangedByKeyEvent, GridFeedback(), SCH_ACTIONS::highlightNet, HighlightNet(), HighlightNetCursor(), SCH_ACTIONS::highlightNetTool, SCH_ACTIONS::importFPAssignments, ImportFPAssignments(), SCH_ACTIONS::incrementAnnotations, IncrementAnnotations(), SCH_ACTIONS::lineMode45, SCH_ACTIONS::lineMode90, SCH_ACTIONS::lineModeFree, SCH_ACTIONS::lineModeNext, SCH_ACTIONS::markSimExclusions, MarkSimExclusions(), New(), NextLineMode(), Open(), ACTIONS::open, ACTIONS::pageSettings, PageSetup(), Paste(), ACTIONS::paste, ACTIONS::pasteSpecial, SCH_ACTIONS::placeLinkedDesignBlock, PlaceLinkedDesignBlock(), Plot(), ACTIONS::plot, ACTIONS::pluginsReload, EVENTS::PointSelectedEvent, Print(), ACTIONS::print, Quit(), ACTIONS::quit, Redo(), ACTIONS::redo, ReloadPlugins(), SCH_ACTIONS::remapSymbols, RemapSymbols(), SCH_ACTIONS::repairSchematic, RepairSchematic(), SCH_ACTIONS::rescueSymbols, RescueSymbols(), Revert(), ACTIONS::revert, Save(), ACTIONS::save, SaveAs(), ACTIONS::saveAs, SCH_ACTIONS::saveCurrSheetCopyAs, SaveCurrSheetCopyAs(), SCH_ACTIONS::saveToLinkedDesignBlock, SaveToLinkedDesignBlock(), SCH_ACTIONS::schematicSetup, EVENTS::SelectedEvent, EVENTS::SelectedItemsModified, SCH_ACTIONS::selectOnPCB, ShowCvpcb(), SCH_ACTIONS::showDesignBlockPanel, SCH_ACTIONS::showHierarchy, ShowHierarchy(), SCH_ACTIONS::showNetNavigator, ShowNetNavigator(), SCH_ACTIONS::showPcbNew, ShowPcbNew(), ACTIONS::showProperties, ShowSchematicSetup(), ShowSearch(), ACTIONS::showSearch, SCH_ACTIONS::simProbe, SimProbe(), SCH_ACTIONS::simTune, SimTune(), SCH_ACTIONS::toggleAnnotateAuto, ToggleAnnotateAuto(), SCH_ACTIONS::toggleDirectiveLabels, ToggleDirectiveLabels(), SCH_ACTIONS::toggleERCErrors, ToggleERCErrors(), SCH_ACTIONS::toggleERCExclusions, ToggleERCExclusions(), SCH_ACTIONS::toggleERCWarnings, ToggleERCWarnings(), SCH_ACTIONS::toggleHiddenFields, ToggleHiddenFields(), SCH_ACTIONS::toggleHiddenPins, ToggleHiddenPins(), ToggleLibraryTree(), SCH_ACTIONS::toggleOPCurrents, ToggleOPCurrents(), SCH_ACTIONS::toggleOPVoltages, ToggleOPVoltages(), SCH_ACTIONS::togglePinAltIcons, TogglePinAltIcons(), ToggleProperties(), Undo(), ACTIONS::undo, EVENTS::UnselectedEvent, UpdateFromPCB(), SCH_ACTIONS::updateNetHighlighting, UpdateNetHighlighting(), UpdatePCB(), ACTIONS::updatePcbFromSchematic, and ACTIONS::updateSchematicFromPcb.

ShowCvpcb()

int SCH_EDITOR_CONTROL::ShowCvpcb

(

const TOOL_EVENT &

aEvent

)

Definition at line 2464 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::OnOpenCvpcb().

Referenced by setTransitions().

ShowHierarchy()

int SCH_EDITOR_CONTROL::ShowHierarchy

(

const TOOL_EVENT &

aEvent

)

Definition at line 2572 of file sch_editor_control.cpp.

Referenced by setTransitions().

ShowNetNavigator()

int SCH_EDITOR_CONTROL::ShowNetNavigator

(

const TOOL_EVENT &

aEvent

)

Definition at line 2579 of file sch_editor_control.cpp.

Referenced by setTransitions().

ShowPcbNew()

int SCH_EDITOR_CONTROL::ShowPcbNew

(

const TOOL_EVENT &

aEvent

)

Definition at line 2498 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::OnOpenPcbnew().

Referenced by setTransitions().

ShowSchematicSetup()

int SCH_EDITOR_CONTROL::ShowSchematicSetup

(

const TOOL_EVENT &

aEvent

)

Definition at line 180 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

Referenced by setTransitions().

ShowSearch()

int SCH_EDITOR_CONTROL::ShowSearch

(

const TOOL_EVENT &

aEvent

)

Definition at line 2565 of file sch_editor_control.cpp.

Referenced by setTransitions().

SimProbe()

int SCH_EDITOR_CONTROL::SimProbe

(

const TOOL_EVENT &

aEvent

)

Definition at line 497 of file sch_editor_control.cpp.

References TOOL_INTERACTIVE::Activate(), SIMULATOR_FRAME::AddCurrentTrace(), SIMULATOR_FRAME::AddVoltageTrace(), SELECTION_TOOL::BrightenItem(), PICKER_TOOL_BASE::ClearHandlers(), SCH_SELECTION_TOOL::ClearSelection(), SCH_COLLECTOR::Collect(), SCH_ITEM::Connection(), NETLIST_EXPORTER_SPICE::ConvertToSpiceMarkup(), SIM_LIB_MGR::CreateModel(), SPICE_GENERATOR::CurrentNames(), DisplayErrorMessage(), SIM_MODEL::FindModelPinIndex(), FRAME_SIMULATOR, KIWAY::GetBlockingDialog(), COLLECTOR::GetCount(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SYMBOL::GetEmbeddedFiles(), SCHEMATIC::GetEmbeddedFiles(), SCH_EDIT_FRAME::GetHighlightedConnection(), WX_STRING_REPORTER::GetMessages(), SCH_SELECTION_TOOL::GetNode(), EDA_ITEM::GetParent(), SCH_SYMBOL::GetRef(), SCH_EDIT_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), WX_STRING_REPORTER::HasMessage(), HITTEST_THRESHOLD_PIXELS, EDA_ITEM::IsType(), KiROUND(), KIWAY_HOLDER::Kiway(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_pickerItem, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, name, SCH_CONNECTION::Name(), SIM_MODEL_PIN::NOT_CONNECTED, ACTIONS::pickerTool, pin, KIWAY::Player(), TOOL_MANAGER::PostAction(), KIWAY_HOLDER::Prj(), SPICE_ITEM::refName, TOOL_MANAGER::RunAction(), SCH_PIN_T, SCH_EDIT_FRAME::Schematic(), ACTIONS::selectionActivate, PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetCursor(), SIM_LIB_MGR::SetFilesStack(), PICKER_TOOL_BASE::SetFinalizeHandler(), SCH_EDIT_FRAME::SetHighlightedConnection(), PICKER_TOOL_BASE::SetMotionHandler(), PICKER_TOOL_BASE::SetSnapping(), SIM_MODEL::SpiceGenerator(), THROW_IO_ERROR, EDA_ITEM::Type(), SELECTION_TOOL::UnbrightenItem(), UnescapeString(), UpdateNetHighlighting(), and IO_ERROR::What().

Referenced by setTransitions().

SimTune()

int SCH_EDITOR_CONTROL::SimTune

(

const TOOL_EVENT &

aEvent

)

Highlight net under the cursor.

Definition at line 672 of file sch_editor_control.cpp.

References TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::BrightenItem(), PICKER_TOOL_BASE::ClearHandlers(), SCH_SELECTION_TOOL::ClearSelection(), SCH_COLLECTOR::Collect(), SCHEMATIC::CurrentSheet(), FRAME_SIMULATOR, KIWAY::GetBlockingDialog(), COLLECTOR::GetCount(), SCH_ITEM::GetParentSymbol(), SCH_EDIT_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), TOOL_BASE::getView(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), HITTEST_THRESHOLD_PIXELS, KiROUND(), KIWAY_HOLDER::Kiway(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_pickerItem, COLLECTOR::m_Threshold, TOOL_BASE::m_toolMgr, ACTIONS::pickerTool, KIWAY::Player(), TOOL_MANAGER::PostAction(), TOOL_MANAGER::RunAction(), SCH_FIELD_T, SCH_SYMBOL_T, SCH_ITEM::Schematic(), ACTIONS::selectionActivate, SCH_SELECTION_TOOL::SelectPoint(), PICKER_TOOL_BASE::SetClickHandler(), PICKER_TOOL_BASE::SetCursor(), PICKER_TOOL_BASE::SetFinalizeHandler(), PICKER_TOOL_BASE::SetMotionHandler(), PICKER_TOOL_BASE::SetSnapping(), EDA_ITEM::Type(), and SELECTION_TOOL::UnbrightenItem().

Referenced by setTransitions().

ToggleAnnotateAuto()

int SCH_EDITOR_CONTROL::ToggleAnnotateAuto

(

const TOOL_EVENT &

aEvent

)

Definition at line 2775 of file sch_editor_control.cpp.

References EESCHEMA_SETTINGS::PANEL_ANNOTATE::automatic, SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::m_AnnotatePanel, and SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame.

Referenced by setTransitions().

ToggleAnnotateRecursive()

int SCH_EDITOR_CONTROL::ToggleAnnotateRecursive

(

const TOOL_EVENT &

aEvent

)

Definition at line 2783 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), EESCHEMA_SETTINGS::m_AnnotatePanel, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and EESCHEMA_SETTINGS::PANEL_ANNOTATE::recursive.

ToggleDirectiveLabels()

int SCH_EDITOR_CONTROL::ToggleDirectiveLabels

(

const TOOL_EVENT &

aEvent

)

Definition at line 2624 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, EESCHEMA_SETTINGS::APPEARANCE::show_directive_labels, and KIGFX::VIEW::UpdateAllItems().

Referenced by setTransitions().

ToggleERCErrors()

int SCH_EDITOR_CONTROL::ToggleERCErrors

(

const TOOL_EVENT &

aEvent

)

Definition at line 2648 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), LAYER_ERC_ERR, EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::SetLayerVisible(), and EESCHEMA_SETTINGS::APPEARANCE::show_erc_errors.

Referenced by setTransitions().

ToggleERCExclusions()

int SCH_EDITOR_CONTROL::ToggleERCExclusions

(

const TOOL_EVENT &

aEvent

)

Definition at line 2660 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), and EESCHEMA_SETTINGS::APPEARANCE::show_erc_exclusions.

Referenced by setTransitions().

ToggleERCWarnings()

int SCH_EDITOR_CONTROL::ToggleERCWarnings

(

const TOOL_EVENT &

aEvent

)

Definition at line 2636 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), LAYER_ERC_WARN, EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::VIEW::SetLayerVisible(), and EESCHEMA_SETTINGS::APPEARANCE::show_erc_warnings.

Referenced by setTransitions().

ToggleHiddenFields()

int SCH_EDITOR_CONTROL::ToggleHiddenFields

(

const TOOL_EVENT &

aEvent

)

Definition at line 2612 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, EESCHEMA_SETTINGS::APPEARANCE::show_hidden_fields, and KIGFX::VIEW::UpdateAllItems().

Referenced by setTransitions().

ToggleHiddenPins()

int SCH_EDITOR_CONTROL::ToggleHiddenPins

(

const TOOL_EVENT &

aEvent

)

Definition at line 2600 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, EESCHEMA_SETTINGS::APPEARANCE::show_hidden_pins, and KIGFX::VIEW::UpdateAllItems().

Referenced by setTransitions().

ToggleLibraryTree()

int SCH_EDITOR_CONTROL::ToggleLibraryTree

(

const TOOL_EVENT &

aEvent

)

Definition at line 2593 of file sch_editor_control.cpp.

Referenced by setTransitions().

ToggleOPCurrents()

int SCH_EDITOR_CONTROL::ToggleOPCurrents

(

const TOOL_EVENT &

aEvent

)

Definition at line 2731 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), LAYER_OP_CURRENTS, EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), KIGFX::VIEW::SetLayerVisible(), and EESCHEMA_SETTINGS::APPEARANCE::show_op_currents.

Referenced by setTransitions().

ToggleOPVoltages()

int SCH_EDITOR_CONTROL::ToggleOPVoltages

(

const TOOL_EVENT &

aEvent

)

Definition at line 2718 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), TOOL_BASE::getView(), LAYER_OP_VOLTAGES, EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, EDA_DRAW_PANEL_GAL::Refresh(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), KIGFX::VIEW::SetLayerVisible(), and EESCHEMA_SETTINGS::APPEARANCE::show_op_voltages.

Referenced by setTransitions().

TogglePinAltIcons()

int SCH_EDITOR_CONTROL::TogglePinAltIcons

(

const TOOL_EVENT &

aEvent

)

Definition at line 2744 of file sch_editor_control.cpp.

References SCH_BASE_FRAME::eeconfig(), SCH_BASE_FRAME::GetCanvas(), SCH_BASE_FRAME::GetRenderSettings(), TOOL_BASE::getView(), EESCHEMA_SETTINGS::m_Appearance, SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, SCH_RENDER_SETTINGS::m_ShowPinAltIcons, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, EESCHEMA_SETTINGS::APPEARANCE::show_pin_alt_icons, and KIGFX::VIEW::UpdateAllItems().

Referenced by setTransitions().

ToggleProperties()

int SCH_EDITOR_CONTROL::ToggleProperties

(

const TOOL_EVENT &

aEvent

)

Definition at line 2586 of file sch_editor_control.cpp.

Referenced by setTransitions().

TogglePythonConsole()

int SCH_EDITOR_CONTROL::TogglePythonConsole

(

const TOOL_EVENT &

aEvent

)

Definition at line 2791 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and EDA_DRAW_FRAME::ScriptingConsoleEnableDisable().

Undo()

int SCH_EDITOR_CONTROL::Undo

(

const TOOL_EVENT &

aEvent

)

Definition at line 1223 of file sch_editor_control.cpp.

References AS_GLOBAL, SCH_BASE_FRAME::GetCanvas(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetUndoCommandCount(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, TOOL_BASE::m_toolMgr, SCH_EDIT_FRAME::OnModify(), EDA_BASE_FRAME::PopCommandFromUndoList(), TOOL_MANAGER::ProcessEvent(), EDA_BASE_FRAME::PushCommandToRedoList(), SCH_EDIT_FRAME::PutDataInPreviousState(), EDA_DRAW_PANEL_GAL::Refresh(), PICKED_ITEMS_LIST::ReversePickersListOrder(), TA_UNDO_REDO_PRE, and TC_MESSAGE.

Referenced by setTransitions().

UpdateFromPCB()

int SCH_EDITOR_CONTROL::UpdateFromPCB

(

const TOOL_EVENT &

aEvent

)

Definition at line 2512 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

updateItem()

void SCH_TOOL_BASE< SCH_EDIT_FRAME >::updateItem ( EDA_ITEM *  aItem, bool  aUpdateRTree  ) const

inlineprotectedinherited

Similar to getView()->Update(), but handles items that are redrawn by their parents and updating the SCH_SCREEN's RTree.

Similar to m_frame->SaveCopyInUndoList(), but handles items that are owned by their parents.

Definition at line 110 of file sch_tool_base.h.

UpdateNetHighlighting()

int SCH_EDITOR_CONTROL::UpdateNetHighlighting

(

const TOOL_EVENT &

aEvent

)

Launch a tool to highlight nets.

Definition at line 1036 of file sch_editor_control.cpp.

References _, EDA_ITEM::ClearBrightened(), SCHEMATIC::ConnectionGraph(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_GRAPH::GetAllSubgraphs(), SCH_BASE_FRAME::GetCanvas(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SYMBOL::GetField(), SCH_EDIT_FRAME::GetHighlightedConnection(), SCH_SHEET::GetPins(), SCH_SYMBOL::GetPins(), TOOL_BASE::getView(), EDA_ITEM::IsBrightened(), SCH_SYMBOL::IsPower(), EDA_TEXT::IsVisible(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_highlightBusMembers, pin, EDA_DRAW_PANEL_GAL::Refresh(), KIGFX::REPAINT, SCH_SHEET_T, SCH_SYMBOL_T, SCH_EDIT_FRAME::Schematic(), EDA_ITEM::SetBrightened(), and KIGFX::VIEW::Update().

Referenced by SCH_EDIT_FRAME::DisplayCurrentSheet(), setTransitions(), and SimProbe().

updatePastedSheet()

SCH_SHEET_PATH SCH_EDITOR_CONTROL::updatePastedSheet ( SCH_SHEET *  aSheet, const SCH_SHEET_PATH &  aPastePath, const KIID_PATH &  aClipPath, bool  aForceKeepAnnotations, SCH_SHEET_LIST *  aPastedSheets, std::map< SCH_SHEET_PATH, SCH_REFERENCE_LIST > &  aPastedSymbols  )

private

Definition at line 1488 of file sch_editor_control.cpp.

References SCH_SHEET_LIST::ContainsSheet(), SCH_SHEET::GetPins(), SCH_SYMBOL::GetPins(), SCH_SHEET::GetScreen(), SCH_SHEET_PATH::GetSymbols(), SCH_SCREEN::Items(), m_pastedSymbols, EDA_ITEM::m_Uuid, pin, SCH_SHEET_PATH::push_back(), SCH_SHEET_T, SCH_SYMBOL_T, updatePastedSheet(), and updatePastedSymbol().

Referenced by Paste(), and updatePastedSheet().

updatePastedSymbol()

void SCH_EDITOR_CONTROL::updatePastedSymbol ( SCH_SYMBOL *  aSymbol, const SCH_SHEET_PATH &  aPastePath, const KIID_PATH &  aClipPath, bool  aForceKeepAnnotations  )

private

Definition at line 1423 of file sch_editor_control.cpp.

References SCH_SYMBOL::AddHierarchicalReference(), KIID::AsString(), KIID_PATH::AsString(), SCH_SYMBOL::ClearAnnotation(), KIID_PATH::EndsWith(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetInstances(), PROJECT::GetProjectName(), EDA_TEXT::GetText(), SCH_ITEM::GetUnit(), SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, m_pastedSymbols, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_ProjectName, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, EDA_ITEM::m_Uuid, SCH_SHEET_PATH::Path(), KIWAY_HOLDER::Prj(), SCH_FIELD::SetText(), SCH_ITEM::SetUnit(), traceSchPaste, and UnescapeString().

Referenced by Paste(), and updatePastedSheet().

UpdatePCB()

int SCH_EDITOR_CONTROL::UpdatePCB

(

const TOOL_EVENT &

aEvent

)

Definition at line 2505 of file sch_editor_control.cpp.

References SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame, and SCH_EDIT_FRAME::OnUpdatePCB().

Referenced by setTransitions().

Wait()

TOOL_EVENT * TOOL_INTERACTIVE::Wait ( const TOOL_EVENT_LIST &  aEventList = TOOL_EVENT( TC_ANY, TA_ANY ) )

inherited

Suspend execution of the tool until an event specified in aEventList arrives.

No parameters means waiting for any event.

Definition at line 71 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr, and TOOL_MANAGER::ScheduleWait().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), ROUTER_TOOL::InlineDrag(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), PCB_SELECTION_TOOL::SelectRectArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

Member Data Documentation

m_clipboardSymbolInstances

std::map<KIID_PATH, SCH_SYMBOL_INSTANCE> SCH_EDITOR_CONTROL::m_clipboardSymbolInstances

private

Definition at line 254 of file sch_editor_control.h.

Referenced by Paste(), and setPastedSymbolInstances().

m_duplicateClipboard

std::string SCH_EDITOR_CONTROL::m_duplicateClipboard

private

Definition at line 244 of file sch_editor_control.h.

Referenced by doCopy(), and Paste().

m_duplicateIsHoverSelection

bool SCH_EDITOR_CONTROL::m_duplicateIsHoverSelection

private

Definition at line 245 of file sch_editor_control.h.

Referenced by doCopy(), and Paste().

m_frame

SCH_EDIT_FRAME * SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_frame

protectedinherited

Definition at line 172 of file sch_tool_base.h.

m_highlightBusMembers

bool SCH_EDITOR_CONTROL::m_highlightBusMembers

private

Definition at line 247 of file sch_editor_control.h.

Referenced by GetHighlightBusMembers(), SetHighlightBusMembers(), and UpdateNetHighlighting().

m_isSymbolEditor

bool SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 175 of file sch_tool_base.h.

m_menu

std::unique_ptr<TOOL_MENU> TOOL_INTERACTIVE::m_menu

protectedinherited

The functions below are not yet implemented - their interface may change.

Definition at line 125 of file tool_interactive.h.

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), TOOL_INTERACTIVE::GetToolMenu(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), EDA_3D_CONTROLLER::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), GERBVIEW_SELECTION_TOOL::Init(), PICKER_TOOL::Init(), ZOOM_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), DRAWING_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PCB_VIEWER_TOOLS::Init(), EDA_3D_CONTROLLER::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), TOOL_INTERACTIVE::TOOL_INTERACTIVE(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

m_pastedSymbols

std::set<SCH_SYMBOL*> SCH_EDITOR_CONTROL::m_pastedSymbols

private

Definition at line 256 of file sch_editor_control.h.

Referenced by Paste(), prunePastedSymbolInstances(), updatePastedSheet(), and updatePastedSymbol().

m_pickerItem

EDA_ITEM* SCH_EDITOR_CONTROL::m_pickerItem

private

Definition at line 242 of file sch_editor_control.h.

Referenced by SimProbe(), and SimTune().

m_probingPcbToSch

bool SCH_EDITOR_CONTROL::m_probingPcbToSch

private

Definition at line 241 of file sch_editor_control.h.

Referenced by doCrossProbeSchToPcb().

m_selectionTool

SCH_SELECTION_TOOL* SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_selectionTool

protectedinherited

Definition at line 174 of file sch_tool_base.h.

m_supplementaryClipboard

std::map<wxString, SCH_SCREEN*> SCH_EDITOR_CONTROL::m_supplementaryClipboard

private

Definition at line 251 of file sch_editor_control.h.

Referenced by doCopy(), and searchSupplementaryClipboard().

m_toolId

TOOL_ID TOOL_BASE::m_toolId

protectedinherited

Unique id, assigned by a TOOL_MANAGER instance.

Definition at line 215 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), TOOL_BASE::GetId(), and TOOL_BASE::IsToolActive().

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SCH_POINT_EDITOR::addCorner(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), GROUP_TOOL::AddToGroup(), SYMBOL_EDITOR_MOVE_TOOL::AlignElements(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::AppendBoard(), AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), TOOL_BASE::attachManager(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_TOOL::ChangeBodyStyle(), ChangeLineMode(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), ClearHighlight(), BOARD_INSPECTION_TOOL::ClearHighlight(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), SCH_EDIT_TABLE_TOOL::clearSelection(), PCB_EDIT_TABLE_TOOL::clearSelection(), SCH_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), CopyAsText(), SYMBOL_EDITOR_EDIT_TOOL::CopyAsText(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), SCH_GROUP_TOOL::createCommit(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createInductorBetween(), SCH_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::CursorControl(), Cut(), PCB_CONTROL::CycleLayerPresets(), SCH_EDIT_TOOL::DdAppendFile(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), doCrossProbeSchToPcb(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SCH_EDIT_TOOL::EditPageNumber(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDIT_TABLE_TOOL::EditTable(), PCB_EDIT_TABLE_TOOL::EditTable(), EditWithSymbolEditor(), SCH_SELECTION_TOOL::EnterGroup(), PCB_SELECTION_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), PAD_TOOL::EnumeratePads(), SCH_INSPECTION_TOOL::ExcludeMarker(), KICAD_MANAGER_CONTROL::Execute(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), EDA_3D_CONTROLLER::ExportImage(), ZONE_FILLER_TOOL::FillAllZones(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), FindSymbolAndItem(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), TOOL_BASE::GetManager(), TOOL_BASE::getModelInternal(), DRAWING_TOOL::getSourceZoneForAction(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), TOOL_BASE::getToolHolderInternal(), SCH_EDIT_TABLE_TOOL::getToolMgr(), PCB_EDIT_TABLE_TOOL::getToolMgr(), TOOL_BASE::getView(), TOOL_BASE::getViewControls(), TOOL_INTERACTIVE::goInternal(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), GridFeedback(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridOrigin(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), SCH_GROUP_TOOL::Group(), PCB_GROUP_TOOL::Group(), PCB_CONTROL::HighContrastModeCycle(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), GROUP_TOOL::Init(), SCH_EDIT_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), ROUTER_TOOL::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), DRAWING_TOOL::Init(), EDIT_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GENERATOR_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_EDIT_TOOL::InteractiveDelete(), SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), TOOL_BASE::IsToolActive(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EDA_3D_CONTROLLER::Main(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SCH_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), NextLineMode(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), SCH_GROUP_TOOL::PickNewMember(), PCB_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PlaceLinkedDesignBlock(), PCB_CONTROL::PlaceLinkedDesignBlock(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), SCH_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDA_3D_CONTROLLER::ReloadBoard(), EDIT_TOOL::Remove(), SCH_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), MULTICHANNEL_TOOL::repeatLayout(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), EDA_3D_CONTROLLER::Reset(), COMMON_TOOLS::Reset(), PNS::TOOL_BASE::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), COMMON_TOOLS::ResetLocalCoords(), TOOL_INTERACTIVE::resetTransitions(), ROUTER_TOOL::restoreSelection(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), TOOL_INTERACTIVE::RunMainStack(), DRC_TOOL::RunTests(), SaveToLinkedDesignBlock(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectColumns(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), PCB_SELECTION_TOOL::selectNet(), SCH_SELECTION_TOOL::SelectNext(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::SelectPolyArea(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::SelectRectArea(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), SCH_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), SCH_EDIT_TOOL::SetAttribute(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), PCB_SELECTION_TOOL::SetSelectPoly(), PCB_SELECTION_TOOL::SetSelectRect(), DRC_TOOL::ShowDRCDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SimProbe(), SimTune(), SCH_DRAWING_TOOLS::SingleClickPlace(), PCB_CONTROL::SnapMode(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), EDIT_TOOL::Swap(), SCH_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), EDA_3D_CONTROLLER::ToggleVisibility(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), SCH_LINE_WIRE_BUS_TOOL::UnfoldBus(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), SCH_SELECTION_TOOL::UnselectAll(), PCB_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), PCB_POINT_EDITOR::updateItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), MULTICHANNEL_TOOL::UpdatePickedItem(), PNS::TOOL_BASE::updateStartItem(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), TOOL_INTERACTIVE::Wait(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), ZONE_FILLER_TOOL::ZoneFill(), BOARD_EDITOR_CONTROL::ZoneMerge(), and ZONE_FILLER_TOOL::ZoneUnfill().

m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

Names are expected to obey the format application.ToolName (eg.

pcbnew.InteractiveSelection).

Definition at line 219 of file tool_base.h.

Referenced by TOOL_BASE::GetName().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by TOOL_BASE::GetType().

m_view

KIGFX::SCH_VIEW* SCH_TOOL_BASE< SCH_EDIT_FRAME >::m_view

protectedinherited

Definition at line 173 of file sch_tool_base.h.

---

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

• sch_editor_control.h
• eeschema/cross-probing.cpp
• assign_footprints.cpp
• sch_editor_control.cpp