SCH_INSPECTION_TOOL Class Reference

#include <sch_inspection_tool.h>

Inheritance diagram for SCH_INSPECTION_TOOL:

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_INSPECTION_TOOL ()
	~SCH_INSPECTION_TOOL ()
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.
int	RunERC (const TOOL_EVENT &aEvent)
void	ShowERCDialog ()
int	PrevMarker (const TOOL_EVENT &aEvent)
int	NextMarker (const TOOL_EVENT &aEvent)
int	CrossProbe (const TOOL_EVENT &aEvent)
	Called when clicking on a item:
void	CrossProbe (const SCH_MARKER *aMarker)
wxString	InspectERCErrorMenuText (const std::shared_ptr< RC_ITEM > &aERCItem)
void	InspectERCError (const std::shared_ptr< RC_ITEM > &aERCItem)
int	ExcludeMarker (const TOOL_EVENT &aEvent)
int	ShowBusSyntaxHelp (const TOOL_EVENT &aEvent)
int	CheckSymbol (const TOOL_EVENT &aEvent)
int	DiffSymbol (const TOOL_EVENT &aEvent)
void	DiffSymbol (SCH_SYMBOL *aSymbol)
int	CompareSchematicWithFile (const TOOL_EVENT &aEvent)
	Diff the current schematic against a user-selected .kicad_sch file.
int	CompareSchematicWithHistory (const TOOL_EVENT &aEvent)
	Diff the current schematic against the most recent local-history commit.
int	RunSimulation (const TOOL_EVENT &aEvent)
int	ShowDatasheet (const TOOL_EVENT &aEvent)
int	UpdateMessagePanel (const TOOL_EVENT &aEvent)
	Display the selected item info (when clicking on a item)
bool	IsSymbolEditor () const
	Returns true if the tool is running in the symbol editor.
int	Increment (const TOOL_EVENT &aEvent)
int	InteractiveDelete (const TOOL_EVENT &aEvent)
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
F *	frame () const
EDA_ITEM *	getDrawParent () const
	Return the parent container for new draw-items in the active editor.
void	updateItem (EDA_ITEM *aItem, bool aUpdateRTree) const
	Similar to getView()->Update(), but also updates the SCH_SCREEN's RTree.
void	saveCopyInUndoList (EDA_ITEM *aItem, UNDO_REDO aType, bool aAppend=false, bool aDirtyConnectivity=true)
	Similar to m_frame->SaveCopyInUndoList(), but also handles connectivity.
void	attachManager (TOOL_MANAGER *aManager)
	Set the TOOL_MANAGER the tool will belong to.
KIGFX::VIEW *	getView () const
	Return the instance of KIGFX::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_BASE_FRAME *	m_frame
KIGFX::SCH_VIEW *	m_view
SCH_SELECTION_TOOL *	m_selectionTool
bool	m_isSymbolEditor
EDA_ITEM *	m_pickerItem
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
int	showSchematicComparison (const wxString &aOtherPath, const wxString &aProjectPath, const wxString &aComparisonLabel)
	Diff the schematic at aOtherPath against the live one and show the dialog.
SYMBOL_DIFF_WIDGET *	constructDiffPanel (wxPanel *aParentPanel)
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
HTML_MESSAGE_BOX *	m_busSyntaxHelp

Detailed Description

Definition at line 35 of file sch_inspection_tool.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 73 of file tool_base.h.

Constructor & Destructor Documentation

SCH_INSPECTION_TOOL()

SCH_INSPECTION_TOOL::SCH_INSPECTION_TOOL

(

)

Definition at line 67 of file sch_inspection_tool.cpp.

References m_busSyntaxHelp, and SCH_TOOL_BASE< SCH_BASE_FRAME >::SCH_TOOL_BASE().

~SCH_INSPECTION_TOOL()

SCH_INSPECTION_TOOL::~SCH_INSPECTION_TOOL ( )

inline

Definition at line 39 of file sch_inspection_tool.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 61 of file tool_interactive.cpp.

References TOOL_BASE::m_toolId, and TOOL_BASE::m_toolMgr.

Referenced by CONSTRAINT_EDIT_TOOL::AddPointConstraint(), AUTOPLACE_TOOL::autoplace(), EDIT_TOOL::copyToClipboard(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawEllipseArc(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), PAD_TOOL::EditPad(), PAD_TOOL::EnumeratePads(), PCB_CONTROL::GridPlaceOrigin(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), ROUTER_TOOL::RouteSelected(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), DRAWING_TOOL::SetAnchor(), DRC_TOOL::ShowDesignRuleEditorDialog(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), DRC_TOOL::ShowDRCDialog(), and DRC_RULE_EDITOR_TOOL::ShowDRCRuleEditorDialog().

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 58 of file tool_base.cpp.

References m_toolMgr, and TOOL_MANAGER.

Referenced by TOOL_MANAGER::RegisterTool().

CheckSymbol()

int SCH_INSPECTION_TOOL::CheckSymbol

(

const TOOL_EVENT &

aEvent

)

Definition at line 280 of file sch_inspection_tool.cpp.

References _, HTML_MESSAGE_BOX::AddHTML_Text(), CheckLibSymbol(), DisplayInfoMessage(), SCH_TOOL_BASE< SCH_BASE_FRAME >::getView(), KiROUND(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

CompareSchematicWithFile()

int SCH_INSPECTION_TOOL::CompareSchematicWithFile

(

const TOOL_EVENT &

aEvent

)

Diff the current schematic against a user-selected .kicad_sch file.

Definition at line 590 of file sch_inspection_tool.cpp.

References _, PROJECT::GetProjectFullName(), FILEEXT::KiCadSchematicFileExtension, FILEEXT::KiCadSchematicFileWildcard(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, KIWAY_HOLDER::Prj(), FILEEXT::ProjectFileExtension, EDA_BASE_FRAME::ShowInfoBarError(), and showSchematicComparison().

Referenced by setTransitions().

CompareSchematicWithHistory()

int SCH_INSPECTION_TOOL::CompareSchematicWithHistory

(

const TOOL_EVENT &

aEvent

)

Diff the current schematic against the most recent local-history commit.

Definition at line 855 of file sch_inspection_tool.cpp.

References _, SCHEMATIC::BuildSheetListSortedByPageNumbers(), KICAD_DIFF::DIFF_COLOR_THEME::comparison, KICAD_DIFF::SCH_DIFFER::Diff(), LOCAL_HISTORY::ExtractAllFilesAtCommit(), KICAD_DIFF::ExtractSchematicGeometry(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), SCHEMATIC::GetFileName(), SETTINGS_MANAGER::GetProject(), PROJECT::GetProjectFullName(), PROJECT::GetProjectPath(), EDA_BASE_FRAME::GetSettingsManager(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), LOCAL_HISTORY::GetSnapshots(), SCHEMATIC::Hierarchy(), SETTINGS_MANAGER::IsProjectLoaded(), KIWAY_HOLDER::Kiway(), SCH_SHEET_PATH::LastScreen(), SETTINGS_MANAGER::LoadProject(), EESCHEMA_HELPERS::LoadSchematic(), KIWAY::LocalHistory(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, EDA_ITEM::m_Uuid, next(), SCH_SHEET_PATH::Path(), KIWAY_HOLDER::Prj(), KICAD_DIFF::DIFF_COLOR_THEME::reference, result, SCH_EDIT_FRAME::Schematic(), KICAD_DIFF::SCH_DIFFER::SetScope(), EDA_BASE_FRAME::ShowInfoBarError(), LOCAL_HISTORY::TreeFingerprint(), and SETTINGS_MANAGER::UnloadProject().

Referenced by setTransitions().

constructDiffPanel()

SYMBOL_DIFF_WIDGET * SCH_INSPECTION_TOOL::constructDiffPanel ( wxPanel * aParentPanel )

private

Definition at line 437 of file sch_inspection_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame.

Referenced by DiffSymbol().

CrossProbe() [1/2]

void SCH_INSPECTION_TOOL::CrossProbe

(

const SCH_MARKER *

aMarker

)

Definition at line 195 of file sch_inspection_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, DIALOG_ERC::SelectMarker(), and DIALOG_SHIM::Show().

CrossProbe() [2/2]

int SCH_INSPECTION_TOOL::CrossProbe

(

const TOOL_EVENT &

aEvent

)

Called when clicking on a item:

Definition at line 171 of file sch_inspection_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SELECTION::Front(), SCH_SELECTION_TOOL::GetSelection(), SELECTION::GetSize(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, SCH_MARKER_T, DIALOG_ERC::SelectMarker(), EDA_ITEM::Type(), and UpdateMessagePanel().

Referenced by SCH_EDIT_TOOL::Properties(), and setTransitions().

DiffSymbol() [1/2]

int SCH_INSPECTION_TOOL::DiffSymbol

(

const TOOL_EVENT &

aEvent

)

Definition at line 324 of file sch_inspection_tool.cpp.

References _, DiffSymbol(), SELECTION::Empty(), SELECTION::Front(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, and SCH_SYMBOL_T.

Referenced by DiffSymbol(), InspectERCError(), and setTransitions().

DiffSymbol() [2/2]

void SCH_INSPECTION_TOOL::DiffSymbol

(

SCH_SYMBOL *

aSymbol

)

Definition at line 343 of file sch_inspection_tool.cpp.

References _, DIALOG_BOOK_REPORTER::AddBlankPage(), DIALOG_BOOK_REPORTER::AddHTMLPage(), constructDiffPanel(), DIALOG_BOOK_REPORTER::DeleteAllPages(), SYMBOL_DIFF_WIDGET::DisplayDiff(), EscapeHTML(), LIB_SYMBOL::Flatten(), WX_HTML_REPORT_BOX::Flush(), SCH_ITEM::GetBodyStyle(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetPosition(), SCH_EDIT_FRAME::GetSymbolDiffDialog(), SCH_FIELD::GetText(), SCH_ITEM::GetUnit(), LIBRARY_MANAGER_ADAPTER::HasLibrary(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, EDA_ITEM::m_Uuid, REFERENCE, WX_HTML_REPORT_BOX::Report(), SCH_EDIT_FRAME::Schematic(), SCHEMATIC::Settings(), DIALOG_BOOK_REPORTER::SetUserItemID(), DIALOG_SHIM::Show(), SCHEMATIC_SETTINGS::SymbolCompareFlags(), and PROJECT_SCH::SymbolLibAdapter().

ExcludeMarker()

int SCH_INSPECTION_TOOL::ExcludeMarker

(

const TOOL_EVENT &

aEvent

)

Definition at line 251 of file sch_inspection_tool.cpp.

References DIALOG_ERC::ExcludeMarker(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_SELECTION_TOOL::GetSelection(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, and SCH_MARKER_T.

Referenced by setTransitions().

frame()

F * SCH_TOOL_BASE< SCH_BASE_FRAME >::frame ( ) const

inlineprotectedinherited

Definition at line 73 of file sch_tool_base.h.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags(), EE_GRAPHIC_TOOL::commitItem(), SCH_INSPECTION_TOOL::CrossProbe(), SCH_INSPECTION_TOOL::CrossProbe(), EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), SCH_INSPECTION_TOOL::ExcludeMarker(), EE_GRAPHIC_TOOL::getDefaultTextSize(), EE_GRAPHIC_TOOL::ImportGraphics(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_INSPECTION_TOOL::NextMarker(), SCH_INSPECTION_TOOL::PrevMarker(), and SCH_INSPECTION_TOOL::ShowERCDialog().

getDrawParent()

EDA_ITEM * SCH_TOOL_BASE< SCH_BASE_FRAME >::getDrawParent ( ) const

protectedinherited

Return the parent container for new draw-items in the active editor.

In the schematic editor this is the SCHEMATIC, in the symbol editor it is the current LIB_SYMBOL.

Definition at line 84 of file sch_tool_base.cpp.

References getEditFrame(), m_frame, and m_isSymbolEditor.

Referenced by EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), and EE_GRAPHIC_TOOL::ImportGraphics().

getEditFrame()

template<typename T>

T * TOOL_BASE::getEditFrame ( ) const

inlineprotectedinherited

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

Definition at line 182 of file tool_base.h.

References getToolHolderInternal(), and T.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_EDITOR_CONTROL::BoardSetup(), PCB_POINT_EDITOR::chamferCorner(), PCB_POINT_EDITOR::changeArcEditMode(), ZONE_FILLER_TOOL::CheckAllZones(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), MICROWAVE_TOOL::createBaseFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createInductorBetween(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), FOOTPRINT_EDITOR_CONTROL::DefaultPadProperties(), FOOTPRINT_EDITOR_CONTROL::DeleteFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomFit(), MICROWAVE_TOOL::drawMicrowaveInductor(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PCB_SELECTION_TOOL::editFrame(), GLOBAL_EDIT_TOOL::EditTeardrops(), FOOTPRINT_EDITOR_CONTROL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), EDIT_TOOL::EditVertices(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), FOOTPRINT_WIZARD_TOOLS::frame(), PCB_SELECTION_TOOL::frame(), PCB_TEST_SELECTION_TOOL::frame(), PCB_TOOL_BASE::frame(), PCB_VIEWER_TOOLS::frame(), SCH_TOOL_BASE< T >::frame(), BOARD_EDITOR_CONTROL::GenerateDrillFiles(), BOARD_EDITOR_CONTROL::GeneratePosFile(), GLOBAL_EDIT_TOOL::GlobalDeletions(), PCB_CONTROL::GridPlaceOrigin(), BOARD_EDITOR_CONTROL::ImportNetlist(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), CONVERT_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), GERBVIEW_SELECTION_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_DESIGN_BLOCK_CONTROL::Init(), PCB_PICKER_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_TOOL_BASE::Init(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_EDITOR_CONTROL::Init(), PL_POINT_EDITOR::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), ZOOM_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GLOBAL_EDIT_TOOL::Migrate3DModels(), PCB_POINT_EDITOR::movePoint(), BOARD_EDITOR_CONTROL::OnAngleSnapModeChanged(), FOOTPRINT_EDITOR_CONTROL::OnAngleSnapModeChanged(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONVERT_TOOL::OutsetItems(), ROUTER_TOOL::performRouting(), EDIT_TOOL::pickReferencePoint(), POSITION_RELATIVE_TOOL::PositionRelative(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), BITMAP2CMP_CONTROL::Reset(), BOARD_EDITOR_CONTROL::Reset(), BOARD_INSPECTION_TOOL::Reset(), BOARD_REANNOTATE_TOOL::Reset(), COMMON_CONTROL::Reset(), COMMON_TOOLS::Reset(), CVPCB_ASSOCIATION_TOOL::Reset(), CVPCB_CONTROL::Reset(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Reset(), DESIGN_BLOCK_CONTROL::Reset(), DRAWING_TOOL::Reset(), DRC_RULE_EDITOR_TOOL::Reset(), DRC_TOOL::Reset(), EDIT_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Reset(), GERBVIEW_CONTROL::Reset(), GERBVIEW_INSPECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), GROUP_TOOL::Reset(), KICAD_MANAGER_CONTROL::Reset(), LIBRARY_EDITOR_CONTROL::Reset(), PCB_CONTROL::Reset(), PCB_POINT_EDITOR::Reset(), PCB_SELECTION_TOOL::Reset(), PL_DRAWING_TOOLS::Reset(), PL_EDIT_TOOL::Reset(), PL_EDITOR_CONTROL::Reset(), PL_POINT_EDITOR::Reset(), PL_SELECTION_TOOL::Reset(), SCH_SELECTION_TOOL::Reset(), SIMULATOR_CONTROL::Reset(), ZOOM_TOOL::Reset(), FOOTPRINT_EDITOR_CONTROL::Revert(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::saveRouterDebugLog(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_SELECTION_TOOL::selectable(), SCH_SELECTION_TOOL::SelectMultiple(), BOARD_EDITOR_CONTROL::ToggleConstraintsPanel(), BOARD_EDITOR_CONTROL::ToggleLayersManager(), BOARD_EDITOR_CONTROL::ToggleLibraryTree(), BOARD_EDITOR_CONTROL::ToggleNetInspector(), BOARD_EDITOR_CONTROL::ToggleProperties(), BOARD_EDITOR_CONTROL::ToggleSearch(), PROPERTIES_TOOL::UpdateProperties(), ZONE_FILLER_TOOL::ZoneFillDirty(), and GLOBAL_EDIT_TOOL::ZonesManager().

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 119 of file tool_base.h.

References 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 142 of file tool_base.h.

References m_toolMgr, and TOOL_MANAGER.

Referenced by MULTICHANNEL_TOOL::AutogenerateRuleAreas(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_TUNING_PATTERN::EditStart(), makeShapeModificationMenu(), PAD_TOOL::PlacePad(), MULTICHANNEL_TOOL::RepeatLayout(), 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 195 of file tool_base.h.

References getModelInternal(), and T.

Referenced by BOARD_EDITOR_CONTROL::AutoTrackWidth(), PCB_SELECTION_TOOL::board(), PCB_TEST_SELECTION_TOOL::board(), PCB_TOOL_BASE::board(), PCB_VIEWER_TOOLS::board(), COMMON_TOOLS::doCenter(), PCB_SELECTION_TOOL::filterSelection(), PCB_GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::HideLocalRatsnest(), EMBED_TOOL::Init(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceSubGrid(), PAD_TOOL::pushPadSettings(), BOARD_EDITOR_CONTROL::Reset(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), EMBED_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::selectPoint(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), and BOARD_EDITOR_CONTROL::ZoneMerge().

getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 52 of file tool_base.cpp.

References m_toolMgr.

Referenced by 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 132 of file tool_base.h.

References m_toolName.

Referenced by PCB_CONTROL::AppendBoard(), TOOL_MANAGER::dispatchInternal(), COMMON_TOOLS::GridProperties(), TOOL_MANAGER::InitTools(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::runTool(), SCH_TOOL_BASE< SCH_BASE_FRAME >::SetContextMenu(), and TOOL_MANAGER::ShutdownTool().

getToolHolderInternal()

TOOLS_HOLDER * TOOL_BASE::getToolHolderInternal ( ) const

privateinherited

Definition at line 46 of file tool_base.cpp.

References m_toolMgr.

Referenced by getEditFrame().

GetToolMenu()

TOOL_MENU & TOOL_INTERACTIVE::GetToolMenu ( )

inherited

Definition at line 108 of file tool_interactive.cpp.

References m_menu.

Referenced by BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), FOOTPRINT_CHOOSER_SELECTION_TOOL::Init(), GENERATOR_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), SCH_EDIT_TOOL::Init(), and SYMBOL_EDITOR_EDIT_TOOL::Init().

GetType()

TOOL_TYPE TOOL_BASE::GetType ( ) const

inlineinherited

Return the type of the tool.

Returns

The type of the tool.

Definition at line 107 of file tool_base.h.

References m_type.

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

getView()

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

protectedinherited

Return the instance of KIGFX::VIEW object used in the application.

It allows tools to draw.

Returns

The instance of KIGFX::VIEW.

Definition at line 34 of file tool_base.cpp.

References m_toolMgr.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), GERBVIEW_CONTROL::ClearAllLayers(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::CollectHits(), PCB_SELECTION_TOOL::CollectMultiple(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), COMMON_TOOLS::doCenter(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), 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(), PCB_SELECTION_TOOL::highlight(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), CONSTRAINT_EDIT_TOOL::hitTestBadge(), PCB_SELECTION_TOOL::hitTestDistance(), EDIT_TOOL::Init(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_PICKER_TOOL::Main(), PL_POINT_EDITOR::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::MoveExact(), PL_EDIT_TOOL::moveItem(), COMMON_TOOLS::OnGridChanged(), CONSTRAINT_EDIT_TOOL::onHoverMotion(), PCB_POINT_EDITOR::OnSelectionChange(), COMMON_TOOLS::PanControl(), CONSTRAINT_EDIT_TOOL::pcbRenderSettings(), ROUTER_TOOL::performRouting(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), GERBVIEW_CONTROL::ReloadAllLayers(), CONSTRAINT_EDIT_TOOL::repaintShadowItems(), BOARD_EDITOR_CONTROL::Reset(), CONSTRAINT_EDIT_TOOL::Reset(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_CONTROL::Reset(), PCB_POINT_EDITOR::Reset(), PCB_SELECTION_TOOL::Reset(), PL_POINT_EDITOR::Reset(), PNS::TOOL_BASE::Reset(), SCH_SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectConnection(), PCB_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectionContains(), SCH_SELECTION_TOOL::selectLasso(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), GERBVIEW_SELECTION_TOOL::selectVisually(), DRAWING_TOOL::SetAnchor(), CONSTRAINT_EDIT_TOOL::ShowConstraints(), DRAWING_TOOL::snapEventPosition(), SCH_SELECTION_TOOL::SyncSelection(), PCB_SELECTION_TOOL::unhighlight(), PCB_TEST_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), GERBVIEW_SELECTION_TOOL::unselect(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::unselectVisually(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), PL_POINT_EDITOR::updatePoints(), PCB_SELECTION_TOOL::updateSelection(), SCH_SELECTION_TOOL::updateSelection(), PNS::TOOL_BASE::updateStartItem(), PCB_SELECTION_TOOL::view(), PCB_TEST_SELECTION_TOOL::view(), PCB_TOOL_BASE::view(), PCB_VIEWER_TOOLS::view(), COMMON_TOOLS::ZoomFitBox(), PCB_SELECTION_TOOL::ZoomFitCrossProbeBBox(), SCH_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 40 of file tool_base.cpp.

References m_toolMgr.

Referenced by PCB_POINT_EDITOR::addCorner(), SCH_SELECTION_TOOL::autostartEvent(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TEST_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), EDIT_TOOL::copyToClipboard(), COMMON_TOOLS::CursorControl(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), COMMON_TOOLS::doZoomToPreset(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawLine(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNetChain(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_TOOL_BASE< T >::Increment(), EDIT_TOOL::Init(), POSITION_RELATIVE_TOOL::InteractiveOffset(), PCB_PICKER_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), PCB_POINT_EDITOR::makePoints(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), CONSTRAINT_EDIT_TOOL::onHoverMotion(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Properties(), PL_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), DIFF_PHASE_SKEW_TOOL::Reset(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_SELECTION_TOOL::selectCursor(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::SelectNode(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PCB_PICKER_TOOL::setControls(), PICKER_TOOL::setControls(), PCB_POINT_EDITOR::setEditedPoint(), PL_POINT_EDITOR::setEditedPoint(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), PCB_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PL_EDIT_TOOL::updateModificationPoint(), and COMMON_TOOLS::ZoomCenter().

Go()

template<class T>

void TOOL_INTERACTIVE::Go ( int(T::* aStateFunc )(const TOOL_EVENT &), 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 143 of file tool_interactive.h.

References goInternal(), and T.

Referenced by ALIGN_DISTRIBUTE_TOOL::setTransitions(), ARRAY_TOOL::setTransitions(), AUTOPLACE_TOOL::setTransitions(), BITMAP2CMP_CONTROL::setTransitions(), BOARD_EDITOR_CONTROL::setTransitions(), BOARD_INSPECTION_TOOL::setTransitions(), BOARD_REANNOTATE_TOOL::setTransitions(), COMMON_CONTROL::setTransitions(), COMMON_TOOLS::setTransitions(), CONSTRAINT_EDIT_TOOL::setTransitions(), CONVERT_TOOL::setTransitions(), CVPCB_ASSOCIATION_TOOL::setTransitions(), CVPCB_CONTROL::setTransitions(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::setTransitions(), DESIGN_BLOCK_CONTROL::setTransitions(), DIFF_PHASE_SKEW_TOOL::setTransitions(), DRAWING_TOOL::setTransitions(), DRC_RULE_EDITOR_TOOL::setTransitions(), DRC_TOOL::setTransitions(), EDA_3D_CONTROLLER::setTransitions(), EDIT_TOOL::setTransitions(), EMBED_TOOL::setTransitions(), FOOTPRINT_CHOOSER_SELECTION_TOOL::setTransitions(), FOOTPRINT_EDITOR_CONTROL::setTransitions(), FOOTPRINT_WIZARD_TOOLS::setTransitions(), GENERATOR_TOOL::setTransitions(), GERBVIEW_CONTROL::setTransitions(), GERBVIEW_INSPECTION_TOOL::setTransitions(), GERBVIEW_SELECTION_TOOL::setTransitions(), GLOBAL_EDIT_TOOL::setTransitions(), GRAPHIC_EDIT_TOOL::setTransitions(), GROUP_TOOL::setTransitions(), KICAD_MANAGER_CONTROL::setTransitions(), LIBRARY_EDITOR_CONTROL::setTransitions(), MATCH_PROPERTIES_TOOL::setTransitions(), MICROWAVE_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_TEST_SELECTION_TOOL::setTransitions(), PCB_VIEWER_TOOLS::setTransitions(), PICKER_TOOL::setTransitions(), PL_DRAWING_TOOLS::setTransitions(), PL_EDIT_TOOL::setTransitions(), PL_EDITOR_CONTROL::setTransitions(), PL_POINT_EDITOR::setTransitions(), PL_SELECTION_TOOL::setTransitions(), POSITION_RELATIVE_TOOL::setTransitions(), PROPERTIES_TOOL::setTransitions(), ROUTER_TOOL::setTransitions(), SCH_DESIGN_BLOCK_CONTROL::setTransitions(), SCH_SELECTION_TOOL::setTransitions(), SIMULATOR_CONTROL::setTransitions(), VIA_STITCH_TOOL::setTransitions(), ZONE_FILLER_TOOL::setTransitions(), and ZOOM_TOOL::setTransitions().

goInternal()

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

privateinherited

Definition at line 80 of file tool_interactive.cpp.

Referenced by Go().

Increment()

int SCH_TOOL_BASE< SCH_BASE_FRAME >::Increment ( const TOOL_EVENT & aEvent )

inherited

Definition at line 67 of file sch_tool_base.cpp.

References m_menu.

Init()

bool SCH_INSPECTION_TOOL::Init ( )

overridevirtual

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 73 of file sch_inspection_tool.cpp.

References CONDITIONAL_MENU::AddItem(), ACTIONS::excludeMarker, SELECTION_CONDITIONS::Idle(), SCH_TOOL_BASE< T >::Init(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, ACTIONS::showDatasheet, SCH_CONDITIONS::SingleNonExcludedMarker, and SCH_CONDITIONS::SingleSymbol.

InspectERCError()

void SCH_INSPECTION_TOOL::InspectERCError

(

const std::shared_ptr< RC_ITEM > &

aERCItem

)

Definition at line 231 of file sch_inspection_tool.cpp.

References DiffSymbol(), ERCE_BUS_TO_NET_CONFLICT, ERCE_LIB_SYMBOL_MISMATCH, SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, and SCH_ACTIONS::showBusSyntaxHelp.

Referenced by DIALOG_ERC::OnERCItemRClick().

InspectERCErrorMenuText()

wxString SCH_INSPECTION_TOOL::InspectERCErrorMenuText

(

const std::shared_ptr< RC_ITEM > &

aERCItem

)

Definition at line 216 of file sch_inspection_tool.cpp.

References SCH_ACTIONS::diffSymbol, ERCE_BUS_TO_NET_CONFLICT, ERCE_LIB_SYMBOL_MISMATCH, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and SCH_ACTIONS::showBusSyntaxHelp.

Referenced by DIALOG_ERC::OnERCItemRClick().

InteractiveDelete()

int SCH_TOOL_BASE< SCH_BASE_FRAME >::InteractiveDelete ( const TOOL_EVENT & aEvent )

inherited

Definition at line 69 of file sch_tool_base.cpp.

References ACTIONS::cancelInteractive, m_frame, m_menu, and SELECTION_CONDITIONS::ShowAlways().

IsSymbolEditor()

bool SCH_TOOL_BASE< SCH_BASE_FRAME >::IsSymbolEditor ( ) const

inherited

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

Definition at line 65 of file sch_tool_base.cpp.

Referenced by EE_GRAPHIC_TOOL::applySymbolEditorFlags(), EE_GRAPHIC_TOOL::commitItem(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::getDefaultTextSize(), EE_GRAPHIC_TOOL::getShapeLayer(), and EE_GRAPHIC_TOOL::ImportGraphics().

IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 28 of file tool_base.cpp.

References m_toolId, and m_toolMgr.

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

NextMarker()

int SCH_INSPECTION_TOOL::NextMarker

(

const TOOL_EVENT &

aEvent

)

Definition at line 153 of file sch_inspection_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, DIALOG_ERC::NextMarker(), and DIALOG_SHIM::Show().

Referenced by setTransitions().

PrevMarker()

int SCH_INSPECTION_TOOL::PrevMarker

(

const TOOL_EVENT &

aEvent

)

Definition at line 134 of file sch_inspection_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, DIALOG_ERC::PrevMarker(), and DIALOG_SHIM::Show().

Referenced by setTransitions().

Reset()

void SCH_INSPECTION_TOOL::Reset ( RESET_REASON aReason )

overridevirtual

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 90 of file sch_inspection_tool.cpp.

References SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< T >::Reset(), TOOL_BASE::SHUTDOWN, and SCH_TOOL_BASE< SCH_BASE_FRAME >::SUPERMODEL_RELOAD.

resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 73 of file tool_interactive.cpp.

RunERC()

int SCH_INSPECTION_TOOL::RunERC

(

const TOOL_EVENT &

aEvent

)

Definition at line 103 of file sch_inspection_tool.cpp.

References ShowERCDialog().

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 102 of file tool_interactive.cpp.

Referenced by DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawTable(), KICAD_MANAGER_CONTROL::NewProject(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceText(), BOARD_EDITOR_CONTROL::ShowEeschema(), and BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic().

RunSimulation()

int SCH_INSPECTION_TOOL::RunSimulation

(

const TOOL_EVENT &

aEvent

)

Definition at line 1292 of file sch_inspection_tool.cpp.

References FRAME_SIMULATOR, KIWAY::GetBlockingDialog(), KIWAY_HOLDER::Kiway(), and SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame.

Referenced by setTransitions().

saveCopyInUndoList()

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

protectedinherited

Similar to m_frame->SaveCopyInUndoList(), but also handles connectivity.

Definition at line 92 of file sch_tool_base.cpp.

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 91 of file tool_interactive.cpp.

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

Referenced by SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::DrawVia(), and PCB_SELECTION_TOOL::Main().

setTransitions()

void SCH_INSPECTION_TOOL::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 1409 of file sch_inspection_tool.cpp.

References CheckSymbol(), SCH_ACTIONS::checkSymbol, EVENTS::ClearedEvent, CompareSchematicWithFile(), SCH_ACTIONS::compareSchematicWithFile, CompareSchematicWithHistory(), SCH_ACTIONS::compareSchematicWithHistory, CrossProbe(), DiffSymbol(), SCH_ACTIONS::diffSymbol, ExcludeMarker(), ACTIONS::excludeMarker, SCH_TOOL_BASE< SCH_BASE_FRAME >::Go(), NextMarker(), ACTIONS::nextMarker, EVENTS::PointSelectedEvent, PrevMarker(), ACTIONS::prevMarker, RunERC(), SCH_ACTIONS::runERC, RunSimulation(), EVENTS::SelectedEvent, EVENTS::SelectedItemsModified, ShowBusSyntaxHelp(), SCH_ACTIONS::showBusSyntaxHelp, ShowDatasheet(), ACTIONS::showDatasheet, SCH_ACTIONS::showSimulator, EVENTS::UnselectedEvent, and UpdateMessagePanel().

ShowBusSyntaxHelp()

int SCH_INSPECTION_TOOL::ShowBusSyntaxHelp

(

const TOOL_EVENT &

aEvent

)

Definition at line 310 of file sch_inspection_tool.cpp.

References m_busSyntaxHelp, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and SCH_TEXT::ShowSyntaxHelp().

Referenced by setTransitions().

ShowDatasheet()

int SCH_INSPECTION_TOOL::ShowDatasheet

(

const TOOL_EVENT &

aEvent

)

Definition at line 1314 of file sch_inspection_tool.cpp.

References _, SCHEMATIC::CurrentSheet(), DATASHEET, datasheet, SELECTION::Empty(), FOR_GUI, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, SELECTION::Front(), GetAssociatedDocument(), LIB_SYMBOL::GetDatasheetField(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetLibSymbolRef(), SCH_FIELD::GetShownText(), SCH_FIELD::GetText(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool, SCH_SYMBOL_T, SCH_ITEM::Schematic(), and PROJECT_SCH::SchSearchS().

Referenced by setTransitions().

ShowERCDialog()

void SCH_INSPECTION_TOOL::ShowERCDialog

(

)

Definition at line 110 of file sch_inspection_tool.cpp.

References KIPLATFORM::UI::ForceFocus(), SCH_TOOL_BASE< SCH_BASE_FRAME >::frame(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, and DIALOG_SHIM::Show().

Referenced by RunERC().

showSchematicComparison()

int SCH_INSPECTION_TOOL::showSchematicComparison ( const wxString & aOtherPath, const wxString & aProjectPath, const wxString & aComparisonLabel )

private

Diff the schematic at aOtherPath against the live one and show the dialog.

Definition at line 632 of file sch_inspection_tool.cpp.

References _, SCHEMATIC::BuildSheetListSortedByPageNumbers(), KICAD_DIFF::DIFF_COLOR_THEME::comparison, KICAD_DIFF::SCH_DIFFER::Diff(), DIALOG_KICAD_DIFF::DiffCanvas(), DIALOG_KICAD_DIFF::EnableUp(), KICAD_DIFF::ExtractSchematicGeometry(), SCH_EDIT_FRAME::GetCurrentSheet(), SCH_SCREEN::GetFileName(), SCH_SHEET::GetFileName(), SCHEMATIC::GetFileName(), SETTINGS_MANAGER::GetProject(), EDA_BASE_FRAME::GetSettingsManager(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::Hierarchy(), SCH_SHEET_PATH::LastScreen(), SETTINGS_MANAGER::LoadProject(), EESCHEMA_HELPERS::LoadSchematic(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, next(), SCH_SHEET_PATH::Path(), KICAD_DIFF::DIFF_COLOR_THEME::reference, result, SCH_EDIT_FRAME::Schematic(), KICAD_DIFF::SCH_DIFFER::SetScope(), DIALOG_KICAD_DIFF::SetUpHandler(), EDA_BASE_FRAME::ShowInfoBarError(), DIALOG_SHIM::ShowModal(), and SETTINGS_MANAGER::UnloadProject().

Referenced by CompareSchematicWithFile().

updateItem()

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

protectedinherited

Similar to getView()->Update(), but also updates the SCH_SCREEN's RTree.

Definition at line 89 of file sch_tool_base.cpp.

References getView(), and m_view.

Referenced by SCH_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::removeCorner(), and SCH_POINT_EDITOR::updateParentItem().

UpdateMessagePanel()

int SCH_INSPECTION_TOOL::UpdateMessagePanel

(

const TOOL_EVENT &

aEvent

)

Display the selected item info (when clicking on a item)

Definition at line 1371 of file sch_inspection_tool.cpp.

References _, GetMsgPanelDisplayUuid(), EDA_ITEM::GetMsgPanelInfo(), SCH_SELECTION_TOOL::GetSelection(), SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame, SCH_TOOL_BASE< SCH_BASE_FRAME >::m_toolMgr, EDA_ITEM::m_Uuid, SCH_EDIT_FRAME::UpdateHierarchySelection(), and SCH_EDIT_FRAME::UpdateNetHighlightStatus().

Referenced by CrossProbe(), and 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 67 of file tool_interactive.cpp.

References TOOL_BASE::m_toolMgr.

Referenced by CONSTRAINT_EDIT_TOOL::AddPointConstraint(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), ROUTER_TOOL::InlineDrag(), POSITION_RELATIVE_TOOL::InteractiveOffset(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PCB_TEST_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_INSPECTION_TOOL::pickItemForInspection(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), SCH_SELECTION_TOOL::selectLasso(), PL_SELECTION_TOOL::selectMultiple(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectPolyArea(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), and DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew().

Member Data Documentation

m_busSyntaxHelp

HTML_MESSAGE_BOX* SCH_INSPECTION_TOOL::m_busSyntaxHelp

private

Definition at line 92 of file sch_inspection_tool.h.

Referenced by SCH_INSPECTION_TOOL(), and ShowBusSyntaxHelp().

m_frame

SCH_BASE_FRAME* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_frame

protectedinherited

Definition at line 95 of file sch_tool_base.h.

Referenced by SCH_POINT_EDITOR::addCorner(), SYMBOL_EDITOR_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_POINT_EDITOR::changeArcEditMode(), SCH_INSPECTION_TOOL::CheckSymbol(), SCH_INSPECTION_TOOL::CompareSchematicWithFile(), SCH_INSPECTION_TOOL::CompareSchematicWithHistory(), SCH_INSPECTION_TOOL::constructDiffPanel(), SCH_INSPECTION_TOOL::CrossProbe(), SCH_INSPECTION_TOOL::CrossProbe(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), SCH_INSPECTION_TOOL::DiffSymbol(), SCH_INSPECTION_TOOL::DiffSymbol(), EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_INSPECTION_TOOL::ExcludeMarker(), SYMBOL_EDITOR_CONTROL::ExportSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), SCH_FIND_REPLACE_TOOL::FindAndReplace(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), getDrawParent(), SCH_FIND_REPLACE_TOOL::HasMatch(), SYMBOL_EDITOR_CONTROL::Init(), SCH_INSPECTION_TOOL::InspectERCError(), SCH_INSPECTION_TOOL::InspectERCErrorMenuText(), InteractiveDelete(), SCH_POINT_EDITOR::Main(), SCH_POINT_EDITOR::makePointsAndBehavior(), SCH_INSPECTION_TOOL::NextMarker(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_INSPECTION_TOOL::PrevMarker(), SCH_POINT_EDITOR::removeCorner(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_FIND_REPLACE_TOOL::ReplaceAndFindNext(), SCH_INSPECTION_TOOL::Reset(), SYMBOL_EDITOR_CONTROL::Revert(), SCH_INSPECTION_TOOL::RunSimulation(), SCH_POINT_EDITOR::setEditedPoint(), SCH_INSPECTION_TOOL::ShowBusSyntaxHelp(), SCH_INSPECTION_TOOL::ShowDatasheet(), SYMBOL_EDITOR_CONTROL::ShowElectricalTypes(), SCH_INSPECTION_TOOL::ShowERCDialog(), SYMBOL_EDITOR_CONTROL::ShowPinNumbers(), SCH_INSPECTION_TOOL::showSchematicComparison(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::ToggleProperties(), SCH_FIND_REPLACE_TOOL::UpdateFind(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), SCH_POINT_EDITOR::updateParentItem(), and SCH_POINT_EDITOR::updatePoints().

m_isSymbolEditor

bool SCH_TOOL_BASE< SCH_BASE_FRAME >::m_isSymbolEditor

protectedinherited

Definition at line 98 of file sch_tool_base.h.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbol(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_POINT_EDITOR::changeArcEditMode(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SYMBOL_EDITOR_CONTROL::EditSymbol(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), SYMBOL_EDITOR_CONTROL::FlattenSymbol(), getDrawParent(), SYMBOL_EDITOR_CONTROL::Init(), SCH_POINT_EDITOR::Main(), SCH_POINT_EDITOR::makePointsAndBehavior(), SYMBOL_EDITOR_CONTROL::OpenDirectory(), SYMBOL_EDITOR_CONTROL::OpenWithTextEditor(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_EDITOR_CONTROL::Save(), SYMBOL_EDITOR_CONTROL::ToggleHiddenFields(), SYMBOL_EDITOR_CONTROL::ToggleHiddenPins(), SYMBOL_EDITOR_CONTROL::TogglePinAltIcons(), SYMBOL_EDITOR_CONTROL::ToggleSyncedPinsMode(), and SCH_POINT_EDITOR::updatePoints().

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 121 of file tool_interactive.h.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawManagedShape(), MICROWAVE_TOOL::drawMicrowaveInductor(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), PAD_TOOL::EnumeratePads(), GetToolMenu(), BOARD_EDITOR_CONTROL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Init(), DRAWING_TOOL::Init(), EDA_3D_CONTROLLER::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), GERBVIEW_SELECTION_TOOL::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(), PICKER_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), SCH_DESIGN_BLOCK_CONTROL::Init(), SCH_SELECTION_TOOL::Init(), ZOOM_TOOL::Init(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PICKER_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ZOOM_TOOL::Main(), ROUTER_TOOL::MainLoop(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE(), and TOOL_INTERACTIVE().

m_pickerItem

EDA_ITEM* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_pickerItem

protectedinherited

Definition at line 99 of file sch_tool_base.h.

m_selectionTool

SCH_SELECTION_TOOL* SCH_TOOL_BASE< SCH_BASE_FRAME >::m_selectionTool

protectedinherited

Definition at line 97 of file sch_tool_base.h.

Referenced by SCH_INSPECTION_TOOL::DiffSymbol(), EE_GRAPHIC_TOOL::DrawArc(), EE_GRAPHIC_TOOL::DrawBezier(), EE_GRAPHIC_TOOL::DrawEllipseArc(), EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_FIND_REPLACE_TOOL::getCurrentMatch(), EE_GRAPHIC_TOOL::ImportGraphics(), SCH_INSPECTION_TOOL::Init(), SCH_POINT_EDITOR::Init(), SYMBOL_EDITOR_CONTROL::Init(), SCH_POINT_EDITOR::Main(), SCH_FIND_REPLACE_TOOL::nextMatch(), SCH_INSPECTION_TOOL::ShowDatasheet(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

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(), GetId(), IsToolActive(), and TOOL_BASE().

m_toolMgr

TOOL_MANAGER* TOOL_BASE::m_toolMgr

protectedinherited

Definition at line 220 of file tool_base.h.

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), CONSTRAINT_EDIT_TOOL::AddPointConstraint(), GROUP_TOOL::AddToGroup(), PCB_CONTROL::AppendBoard(), PCB_CONTROL::ApplyDesignBlockLayout(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), attachManager(), SCH_SELECTION_TOOL::autostartEvent(), EDIT_TOOL::BooleanPolygons(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), BOARD_EDITOR_CONTROL::ChangeLineMode(), FOOTPRINT_EDITOR_CONTROL::ChangeLineMode(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), GERBVIEW_CONTROL::ClearAllLayers(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_SELECTION_TOOL::ClearSelection(), PL_SELECTION_TOOL::ClearSelection(), SCH_SELECTION_TOOL::ClearSelection(), GERBVIEW_SELECTION_TOOL::clearSelection(), PCB_EDIT_TABLE_TOOL::clearSelection(), VIA_STITCH_TOOL::ClearStitchViaExclusions(), ROUTER_TOOL::commitPendingViaStack(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), ARRAY_TOOL::CreateArray(), PCB_GROUP_TOOL::createCommit(), SCH_GROUP_TOOL::createCommit(), MICROWAVE_TOOL::createInductorBetween(), DRC_TOOL::CrossProbe(), COMMON_TOOLS::Cursor45Crosshairs(), COMMON_TOOLS::CursorControl(), COMMON_TOOLS::CursorFullCrosshairs(), COMMON_TOOLS::CursorSmallCrosshairs(), PCB_CONTROL::CycleLayerPresets(), EDIT_TOOL::DeleteItems(), BOARD_INSPECTION_TOOL::DiffFootprint(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSyncSelection(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), EDIT_TOOL::Drag(), PCB_SELECTION_TOOL::DragSelectionArea(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBarcode(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawEllipseArc(), DRAWING_TOOL::drawManagedShape(), DRAWING_TOOL::DrawRectangle(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), PCB_EDIT_TABLE_TOOL::EditTable(), PCB_SELECTION_TOOL::EnterGroup(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::EnumeratePads(), VIA_STITCH_TOOL::ExcludeStitchVia(), KICAD_MANAGER_CONTROL::Execute(), PCB_SELECTION_TOOL::ExitGroup(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::expandConnection(), EDA_3D_CONTROLLER::ExportImage(), PCB_EDIT_TABLE_TOOL::ExportTableToCSV(), PCB_SELECTION_TOOL::extendTableCellSelectionTo(), ZONE_FILLER_TOOL::FillAllZones(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), DRC_TOOL::FixDRCError(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), GetManager(), getModelInternal(), DRAWING_TOOL::getSourceZoneForAction(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), getToolHolderInternal(), PCB_EDIT_TABLE_TOOL::getToolMgr(), getView(), getViewControls(), PCB_SELECTION_TOOL::grabUnconnected(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridFastCycle(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridOrigin(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), PCB_GROUP_TOOL::Group(), SCH_GROUP_TOOL::Group(), EDIT_TOOL::HealShapes(), PCB_CONTROL::HighContrastModeCycle(), CONSTRAINT_EDIT_TOOL::HighlightConstraintMembers(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), BOARD_INSPECTION_TOOL::HighlightNetChain(), PL_EDIT_TOOL::ImportDrawingSheetContent(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), EDIT_TOOL::Increment(), SCH_TOOL_BASE< T >::Increment(), ALIGN_DISTRIBUTE_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONSTRAINT_EDIT_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(), GRAPHIC_EDIT_TOOL::Init(), GROUP_TOOL::Init(), MATCH_PROPERTIES_TOOL::Init(), PAD_TOOL::Init(), PCB_EDIT_TABLE_TOOL::Init(), PCB_POINT_EDITOR::Init(), PCB_SELECTION_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), POSITION_RELATIVE_TOOL::Init(), ROUTER_TOOL::Init(), SCH_TOOL_BASE< T >::Init(), VIA_STITCH_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), PCB_CONTROL::InteractiveDelete(), PL_EDIT_TOOL::InteractiveDelete(), SCH_TOOL_BASE< T >::InteractiveDelete(), POSITION_RELATIVE_TOOL::InteractiveOffset(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), IsToolActive(), EDIT_TOOL::JustifyText(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EDA_3D_CONTROLLER::Main(), GERBVIEW_SELECTION_TOOL::Main(), PCB_PICKER_TOOL::Main(), PCB_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), SCH_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), GENERATOR_TOOL::MakeViaStackFromSelection(), PCB_VIEWER_TOOLS::MeasureTool(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::Move(), EDIT_TOOL::MoveExact(), PCB_VIEWER_TOOLS::NextLineMode(), ARRAY_TOOL::onDialogClosed(), SELECTION_TOOL::onDisambiguationExpire(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::OptimizeSelected(), CONVERT_TOOL::OutsetItems(), PCB_CONTROL::Paste(), PL_EDIT_TOOL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), BOARD_INSPECTION_TOOL::pickItemForInspection(), CONSTRAINT_EDIT_TOOL::pickLinearConstraint(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), CONSTRAINT_EDIT_TOOL::pickShapeConstraint(), PCB_CONTROL::placeBoardItems(), PCB_CONTROL::PlaceDrillMap(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), PCB_CONTROL::PlaceLinkedDesignBlock(), DRAWING_TOOL::PlaceMicroviaStack(), DRAWING_TOOL::PlaceReferenceImage(), DRAWING_TOOL::PlaceSubGrid(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), SCH_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), ZONE_FILLER_TOOL::regenerateDirtyGenerators(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDA_3D_CONTROLLER::ReloadBoard(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), MULTICHANNEL_TOOL::repeatLayout(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::RequestSelection(), COMMON_TOOLS::Reset(), DIFF_PHASE_SKEW_TOOL::Reset(), EDA_3D_CONTROLLER::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PNS::TOOL_BASE::Reset(), COMMON_TOOLS::ResetLocalCoords(), EDIT_TOOL::reSolveConstraintsAfterEdit(), ROUTER_TOOL::restoreSelection(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), GRAPHIC_EDIT_TOOL::runInteractive(), MATCH_PROPERTIES_TOOL::runInteractive(), DRAWING_TOOL::runSimpleShapeDraw(), DRC_TOOL::RunTests(), PCB_CONTROL::SaveToLinkedDesignBlock(), SCH_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::SelectAll(), PL_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectChartRow(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectConnection(), PCB_TOOL_BASE::selection(), PCB_TOOL_BASE::selection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), SCH_SELECTION_TOOL::selectLasso(), PCB_SELECTION_TOOL::SelectMultiple(), SCH_SELECTION_TOOL::SelectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectNetChain(), SCH_SELECTION_TOOL::SelectNext(), PL_SELECTION_TOOL::SelectPoint(), SCH_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::SelectPolyArea(), SCH_SELECTION_TOOL::SelectPrevious(), PCB_SELECTION_TOOL::SelectRows(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PCB_SELECTION_TOOL::SelectTable(), SCH_SELECTION_TOOL::SelectTable(), PCB_SELECTION_TOOL::selectTableCells(), SCH_SELECTION_TOOL::selectTableCells(), DRAWING_TOOL::SetAnchor(), TOOL_INTERACTIVE::SetContextMenu(), EDA_3D_CONTROLLER::SetMaterial(), PCB_SELECTION_TOOL::SetSelectPoly(), SCH_SELECTION_TOOL::SetSelectPoly(), PCB_SELECTION_TOOL::SetSelectRect(), SCH_SELECTION_TOOL::SetSelectRect(), DRC_TOOL::ShowDesignRuleEditorDialog(), DIFF_PHASE_SKEW_TOOL::ShowDiffPhaseSkew(), DRC_TOOL::ShowDRCDialog(), DRC_RULE_EDITOR_TOOL::ShowDRCRuleEditorDialog(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), EDIT_TOOL::SimplifyPolygons(), DRAWING_TOOL::snapEventPosition(), PCB_CONTROL::SnapMode(), EDIT_TOOL::Swap(), EDIT_TOOL::SwapGateNets(), EDIT_TOOL::SwapPadNets(), SCH_SELECTION_TOOL::SyncSelection(), COMMON_TOOLS::ToggleCursor(), EDIT_TOOL::ToggleFootprintAttribute(), EDA_3D_CONTROLLER::ToggleLayersManager(), EDA_3D_CONTROLLER::ToggleRaytracing(), PCB_SELECTION_TOOL::toggleTableCellSelection(), EDA_3D_CONTROLLER::ToggleVisibility(), TOOL_BASE(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), GROUP_TOOL::Ungroup(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), PCB_SELECTION_TOOL::UnselectAll(), SCH_SELECTION_TOOL::UnselectAll(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), PNS::TOOL_BASE::updateEndItem(), PCB_POINT_EDITOR::updateItem(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), GERBVIEW_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_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(), BOARD_EDITOR_CONTROL::ZonePriorityLower(), BOARD_EDITOR_CONTROL::ZonePriorityMoveToBottom(), BOARD_EDITOR_CONTROL::ZonePriorityMoveToTop(), BOARD_EDITOR_CONTROL::ZonePriorityRaise(), 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 GetName(), and TOOL_BASE().

m_type

TOOL_TYPE TOOL_BASE::m_type

protectedinherited

Definition at line 214 of file tool_base.h.

Referenced by GetType(), and TOOL_BASE().

m_view

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

protectedinherited

Definition at line 96 of file sch_tool_base.h.

Referenced by EE_GRAPHIC_TOOL::drawManagedShape(), EE_GRAPHIC_TOOL::DrawShape(), EE_GRAPHIC_TOOL::ImportGraphics(), and updateItem().

---

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

• sch_inspection_tool.h
• sch_inspection_tool.cpp