Module editor specific tools. More...

#include <footprint_editor_control.h>

Inheritance diagram for FOOTPRINT_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
	FOOTPRINT_EDITOR_CONTROL ()

void	Reset (RESET_REASON aReason) override
	Bring the tool to a known, initial state.

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

int	NewFootprint (const TOOL_EVENT &aEvent)

int	CreateFootprint (const TOOL_EVENT &aEvent)

int	Save (const TOOL_EVENT &aEvent)

int	SaveAs (const TOOL_EVENT &aEvent)

int	Revert (const TOOL_EVENT &aEvent)

int	EditFootprint (const TOOL_EVENT &aEvent)

int	EditLibraryFootprint (const TOOL_EVENT &aEvent)

int	CutCopyFootprint (const TOOL_EVENT &aEvent)

int	PasteFootprint (const TOOL_EVENT &aEvent)

int	DuplicateFootprint (const TOOL_EVENT &aEvent)

int	RenameFootprint (const TOOL_EVENT &aEvent)

int	DeleteFootprint (const TOOL_EVENT &aEvent)

int	ImportFootprint (const TOOL_EVENT &aEvent)

int	ExportFootprint (const TOOL_EVENT &aEvent)

int	OpenDirectory (const TOOL_EVENT &aEvent)

int	OpenWithTextEditor (const TOOL_EVENT &aEvent)

int	ShowDatasheet (const TOOL_EVENT &aEvent)

int	ToggleLayersManager (const TOOL_EVENT &aEvent)

int	ToggleProperties (const TOOL_EVENT &aEvent)

int	Properties (const TOOL_EVENT &aEvent)

int	EditTextAndGraphics (const TOOL_EVENT &aEvent)

int	CheckFootprint (const TOOL_EVENT &aEvent)

void	CrossProbe (const PCB_MARKER *aMarker)

void	DestroyCheckerDialog ()

int	CleanupGraphics (const TOOL_EVENT &aEvent)

int	RepairFootprint (const TOOL_EVENT &aEvent)

int	DefaultPadProperties (const TOOL_EVENT &aEvent)
	Edit the properties used for new pad creation.

void	SetIsFootprintEditor (bool aEnabled)
	Function SetIsFootprintEditor()

bool	IsFootprintEditor () const

void	SetIsBoardEditor (bool aEnabled)

bool	IsBoardEditor () const

virtual bool	Is45Limited () const
	Should the tool use its 45° mode option?

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 Types
enum	INTERACTIVE_PLACEMENT_OPTIONS { IPO_ROTATE = 0x01 , IPO_FLIP = 0x02 , IPO_SINGLE_CLICK = 0x04 , IPO_REPEAT = 0x08 }
	Options for placing items interactively. More...

Protected Member Functions
void	doInteractiveItemPlacement (const TOOL_EVENT &aTool, INTERACTIVE_PLACER_BASE *aPlacer, const wxString &aCommitMessage, int aOptions=IPO_ROTATE\|IPO_FLIP\|IPO_REPEAT)
	Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

KIGFX::PCB_VIEW *	view () const

KIGFX::VIEW_CONTROLS *	controls () const

template<class T = PCB_BASE_EDIT_FRAME>
T *	frame () const

BOARD *	board () const

FOOTPRINT *	footprint () const

PCBNEW_SETTINGS::DISPLAY_OPTIONS &	displayOptions () const

PCB_DRAW_PANEL_GAL *	canvas () const

const PCB_SELECTION &	selection () const

PCB_SELECTION &	selection ()

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

bool	m_isBoardEditor

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
void	setTransitions () override
	< Set up handlers for various events.

void	tryToSaveFootprintInLibrary (FOOTPRINT &aFootprint, const LIB_ID &aLibId)
	Try to save the footprint in the library, if it is valid and writable.

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
FOOTPRINT_EDIT_FRAME *	m_frame

DIALOG_FOOTPRINT_CHECKER *	m_checkerDialog

std::unique_ptr< FOOTPRINT >	m_copiedFootprint

Detailed Description

Module editor specific tools.

Definition at line 39 of file footprint_editor_control.h.

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

enum PCB_TOOL_BASE::INTERACTIVE_PLACEMENT_OPTIONS

protectedinherited

Options for placing items interactively.

Enumerator
IPO_ROTATE	Handle the rotate action in the loop by calling the item's rotate method.
IPO_FLIP	Handle flip action in the loop by calling the item's flip method.
IPO_SINGLE_CLICK	Create an item immediately on placement starting, otherwise show the pencil cursor until the item is created.
IPO_REPEAT	Allow repeat placement of the item.

Definition at line 121 of file pcb_tool_base.h.

◆ 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

◆ FOOTPRINT_EDITOR_CONTROL()

FOOTPRINT_EDITOR_CONTROL::FOOTPRINT_EDITOR_CONTROL ( )

Definition at line 60 of file footprint_editor_control.cpp.

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

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

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

References TOOL_BASE::m_toolMgr.

Referenced by TOOL_MANAGER::RegisterTool().

◆ board()

BOARD * PCB_TOOL_BASE::board ( ) const

inlineprotectedinherited

Definition at line 171 of file pcb_tool_base.h.

◆ canvas()

PCB_DRAW_PANEL_GAL * PCB_TOOL_BASE::canvas ( ) const

protectedinherited

Definition at line 309 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame().

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), CreateFootprint(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::Init(), NewFootprint(), EDIT_TOOL::pickReferencePoint(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PCB_CONTROL::RatsnestModeCycle(), EDIT_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::rebuildConnectivity(), ZONE_FILLER_TOOL::refresh(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), Save(), SaveAs(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), ZONE_FILLER_TOOL::singleShotRefocus(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::ViaDisplayMode(), PCB_CONTROL::ZoneDisplayMode(), and ZONE_FILLER_TOOL::ZoneFillDirty().

◆ CheckFootprint()

int FOOTPRINT_EDITOR_CONTROL::CheckFootprint ( const TOOL_EVENT & aEvent )

Definition at line 798 of file footprint_editor_control.cpp.

References m_checkerDialog, m_frame, and DIALOG_SHIM::Show().

Referenced by setTransitions().

◆ CleanupGraphics()

int FOOTPRINT_EDITOR_CONTROL::CleanupGraphics ( const TOOL_EVENT & aEvent )

Definition at line 788 of file footprint_editor_control.cpp.

References DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

◆ controls()

KIGFX::VIEW_CONTROLS * PCB_TOOL_BASE::controls ( ) const

inlineprotectedinherited

◆ CreateFootprint()

int FOOTPRINT_EDITOR_CONTROL::CreateFootprint ( const TOOL_EVENT & aEvent )

Definition at line 239 of file footprint_editor_control.cpp.

Referenced by setTransitions().

◆ CrossProbe()

void FOOTPRINT_EDITOR_CONTROL::CrossProbe ( const PCB_MARKER * aMarker )

Definition at line 814 of file footprint_editor_control.cpp.

References m_checkerDialog, m_frame, DIALOG_FOOTPRINT_CHECKER::SelectMarker(), and DIALOG_SHIM::Show().

◆ CutCopyFootprint()

int FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint ( const TOOL_EVENT & aEvent )

Definition at line 376 of file footprint_editor_control.cpp.

References PCB_ACTIONS::cutFootprint, DeleteFootprint(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT_EDIT_FRAME::GetLibTree(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), LIB_TREE::GetSelectedLibId(), TOOL_EVENT::IsAction(), PCB_BASE_FRAME::LoadFootprint(), m_copiedFootprint, and m_frame.

Referenced by setTransitions().

◆ DefaultPadProperties()

int FOOTPRINT_EDITOR_CONTROL::DefaultPadProperties ( const TOOL_EVENT & aEvent )

Edit the properties used for new pad creation.

Definition at line 781 of file footprint_editor_control.cpp.

Referenced by setTransitions().

◆ DeleteFootprint()

int FOOTPRINT_EDITOR_CONTROL::DeleteFootprint ( const TOOL_EVENT & aEvent )

Definition at line 535 of file footprint_editor_control.cpp.

References PCB_TOOL_BASE::frame().

Referenced by CutCopyFootprint(), and setTransitions().

◆ DestroyCheckerDialog()

void FOOTPRINT_EDITOR_CONTROL::DestroyCheckerDialog ( )

Definition at line 826 of file footprint_editor_control.cpp.

References m_checkerDialog.

Referenced by DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), and Reset().

◆ displayOptions()

PCBNEW_SETTINGS::DISPLAY_OPTIONS & PCB_TOOL_BASE::displayOptions ( ) const

protectedinherited

Definition at line 304 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame().

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), PCB_CONTROL::RatsnestModeCycle(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::TrackDisplayMode(), and PCB_CONTROL::ViaDisplayMode().

◆ doInteractiveItemPlacement()

void PCB_TOOL_BASE::doInteractiveItemPlacement	(	const TOOL_EVENT &	aTool,
		INTERACTIVE_PLACER_BASE *	aPlacer,
		const wxString &	aCommitMessage,
		int	aOptions = `IPO_ROTATE \| IPO_FLIP \| IPO_REPEAT`
	)

protectedinherited

Helper function for performing a common interactive idiom: wait for a left click, place an item there (perhaps with a dialog or other user interaction), then have it move with the mouse and respond to rotate/flip, etc.

More complex interactive processes are not supported here, you should implement a customised event loop for those.

Parameters

aItemCreator	the callable that will attempt to create the item
aCommitMessage	the message used on a successful commit

Definition at line 43 of file pcb_tool_base.cpp.

References TOOL_INTERACTIVE::Activate(), SELECTION::Add(), KIGFX::VIEW_GROUP::Add(), KIGFX::PCB_VIEW::Add(), PCB_TOOL_BASE::board(), BUT_LEFT, BUT_RIGHT, KIGFX::VIEW_CONTROLS::CaptureCursor(), SELECTION::Clear(), EDA_ITEM::ClearFlags(), PCB_TOOL_BASE::controls(), INTERACTIVE_PLACER_BASE::CreateItem(), PCB_ACTIONS::flip, KIGFX::VIEW_CONTROLS::ForceCursorPosition(), PCB_TOOL_BASE::frame(), TOOL_EVT_UTILS::GetEventRotationAngle(), EDA_ITEM::GetFlags(), TOOL_BASE::GetManager(), TOOL_BASE::getView(), grid, PCB_TOOL_BASE::IPO_FLIP, PCB_TOOL_BASE::IPO_REPEAT, PCB_TOOL_BASE::IPO_ROTATE, PCB_TOOL_BASE::IPO_SINGLE_CLICK, TOOL_EVT_UTILS::IsRotateToolEvt(), INTERACTIVE_PLACER_BASE::m_board, INTERACTIVE_PLACER_BASE::m_frame, TOOL_INTERACTIVE::m_menu, INTERACTIVE_PLACER_BASE::m_modifiers, TOOL_BASE::m_toolMgr, INTERACTIVE_PLACER_BASE::PlaceItem(), TOOL_MANAGER::PostAction(), TOOL_MANAGER::ProcessEvent(), PCB_ACTIONS::properties, BOARD_COMMIT::Push(), ACTIONS::refreshPreview, KIGFX::PCB_VIEW::Remove(), TOOL_MANAGER::RunAction(), EVENTS::SelectedItemsModified, PCB_TOOL_BASE::selection(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetAutoPan(), EDA_ITEM::SetFlags(), KIGFX::VIEW_CONTROLS::ShowCursor(), INTERACTIVE_PLACER_BASE::SnapItem(), TC_COMMAND, PCB_ACTIONS::trackViaSizeChanged, KIGFX::PCB_VIEW::Update(), PCB_TOOL_BASE::view(), and TOOL_INTERACTIVE::Wait().

Referenced by MICROWAVE_TOOL::addMicrowaveFootprint(), DRAWING_TOOL::DrawVia(), and PAD_TOOL::PlacePad().

◆ DuplicateFootprint()

int FOOTPRINT_EDITOR_CONTROL::DuplicateFootprint ( const TOOL_EVENT & aEvent )

Definition at line 420 of file footprint_editor_control.cpp.

Referenced by setTransitions().

◆ EditFootprint()

int FOOTPRINT_EDITOR_CONTROL::EditFootprint ( const TOOL_EVENT & aEvent )

Definition at line 729 of file footprint_editor_control.cpp.

References FOOTPRINT_EDIT_FRAME::GetLibTree(), LIB_TREE::GetSelectedLibId(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), and m_frame.

Referenced by setTransitions().

◆ EditLibraryFootprint()

int FOOTPRINT_EDITOR_CONTROL::EditLibraryFootprint ( const TOOL_EVENT & aEvent )

Definition at line 736 of file footprint_editor_control.cpp.

References PCB_TOOL_BASE::footprint(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), FOOTPRINT::GetFPID(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), FOOTPRINT_EDIT_FRAME::IsLibraryTreeShown(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), m_frame, and FOOTPRINT_EDIT_FRAME::ToggleLibraryTree().

Referenced by setTransitions().

◆ EditTextAndGraphics()

int FOOTPRINT_EDITOR_CONTROL::EditTextAndGraphics ( const TOOL_EVENT & aEvent )

Definition at line 631 of file pcbnew/dialogs/dialog_global_edit_text_and_graphics.cpp.

References DIALOG_SHIM::ShowModal().

Referenced by setTransitions().

◆ ExportFootprint()

int FOOTPRINT_EDITOR_CONTROL::ExportFootprint ( const TOOL_EVENT & aEvent )

Definition at line 579 of file footprint_editor_control.cpp.

References FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), and m_frame.

Referenced by setTransitions().

◆ footprint()

FOOTPRINT * PCB_TOOL_BASE::footprint ( ) const

inlineprotectedinherited

Definition at line 173 of file pcb_tool_base.h.

References PCB_TOOL_BASE::board(), and BOARD::GetFirstFootprint().

Referenced by PCB_CONTROL::AppendBoard(), MICROWAVE_TOOL::createBaseFootprint(), CreateFootprint(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawSpecificationStackup(), DuplicateFootprint(), EditLibraryFootprint(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::ExportNetlist(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_INSPECTION_TOOL::makeDRCEngine(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), Properties(), PAD_TOOL::pushPadSettings(), RenameFootprint(), BOARD_EDITOR_CONTROL::RepairBoard(), RepairFootprint(), Save(), SaveAs(), DRAWING_TOOL::SetAnchor(), and ShowDatasheet().

◆ frame()

template<class T = PCB_BASE_EDIT_FRAME>

T * PCB_TOOL_BASE::frame ( ) const

inlineprotectedinherited

Definition at line 166 of file pcb_tool_base.h.

Referenced by PCB_POINT_EDITOR::addCorner(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), AUTOPLACE_TOOL::autoplace(), PCB_TOOL_BASE::canvas(), PCB_POINT_EDITOR::chamferCorner(), ZONE_FILLER_TOOL::CheckAllZones(), PNS::TOOL_BASE::checkSnap(), PCB_CONTROL::ContrastModeFeedback(), PAD_TOOL::copyPadSettings(), EDIT_TOOL::copyToClipboard(), CreateFootprint(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), DeleteFootprint(), EDIT_TOOL::DeleteItems(), PCB_TOOL_BASE::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::DpDimensionsDialog(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), PCB_EDIT_TABLE_TOOL::EditTable(), PAD_TOOL::enterPadEditMode(), PAD_TOOL::EnumeratePads(), PAD_TOOL::ExitPadEditMode(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), ZONE_FILLER_TOOL::FillAllZones(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::finishInteractive(), EDIT_TOOL::Flip(), PCB_CONTROL::FlipPcbView(), EDIT_TOOL::GetAndPlace(), GLOBAL_EDIT_TOOL::GlobalDeletions(), ROUTER_TOOL::handleLayerSwitch(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), BOARD_INSPECTION_TOOL::HighlightItem(), ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), SCRIPTING_TOOL::Init(), ROUTER_TOOL::Init(), EDIT_TOOL::Init(), PCB_PICKER_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_TOOL_BASE::Is45Limited(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), EDIT_TOOL::MoveExact(), PCB_CONTROL::NetColorModeCycle(), PCB_POINT_EDITOR::OnSelectionChange(), ROUTER_TOOL::onViaCommand(), CONVERT_TOOL::OutsetItems(), PCB_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), GROUP_TOOL::PickNewMember(), PNS::TOOL_BASE::pickSingleItem(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PAD_TOOL::PlacePad(), DRAWING_TOOL::PlaceText(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), ROUTER_TOOL::prepareInteractive(), EDIT_TOOL::Properties(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::pushPadSettings(), PCB_CONTROL::RatsnestModeCycle(), GENERATOR_TOOL::RegenerateAllOfType(), GENERATOR_TOOL::RegenerateItem(), GENERATOR_TOOL::RegenerateSelected(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SCRIPTING_TOOL::reloadPlugins(), PCB_POINT_EDITOR::removeCorner(), MULTICHANNEL_TOOL::repeatLayout(), MULTICHANNEL_TOOL::RepeatLayout(), PNS::TOOL_BASE::Reset(), GENERATOR_TOOL_PNS_PROXY::Reset(), PAD_TOOL::Reset(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), ROUTER_TOOL::saveRouterDebugLog(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_PICKER_TOOL::SelectItemInteractively(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_POINT_EDITOR::setEditedPoint(), ROUTER_TOOL::SettingsDialog(), ShowDatasheet(), GENERATOR_TOOL::ShowGeneratorsManager(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), ROUTER_TOOL::switchLayerOnViaPlacement(), DRAWING_TOOL::ToggleHV45Mode(), PCB_CONTROL::ToggleRatsnest(), PCB_CONTROL::unfilledZoneCheck(), PCB_POINT_EDITOR::updateItem(), ROUTER_TOOL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), PCB_CONTROL::ZoneDisplayMode(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), and ZONE_FILLER_TOOL::ZoneFillDirty().

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

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

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

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

◆ getModelInternal()

EDA_ITEM * TOOL_BASE::getModelInternal ( ) const

privateinherited

Definition at line 54 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 TOOL_MANAGER::dispatchInternal(), TOOL_INTERACTIVE::goInternal(), COMMON_TOOLS::GridProperties(), 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 48 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

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

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

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

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

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), EE_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), PCB_POINT_EDITOR::chamferCorner(), PCB_SELECTION_TOOL::controls(), PCB_TOOL_BASE::controls(), PCB_TEST_SELECTION_TOOL::controls(), 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(), SCH_EDITOR_CONTROL::HighlightNet(), BOARD_INSPECTION_TOOL::HighlightNet(), ImportFootprint(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), SCH_EDIT_TOOL::Init(), EDIT_TOOL::Init(), EE_POINT_EDITOR::Main(), EE_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(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), COMMON_TOOLS::OnGridChanged(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDITOR_CONTROL::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(), EE_SELECTION_TOOL::RequestSelection(), DRAWING_TOOL::Reset(), PCB_POINT_EDITOR::Reset(), COMMON_TOOLS::ResetLocalCoords(), ROUTER_TOOL::RouteSelected(), PCB_SELECTION_TOOL::selectCursor(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), EE_SELECTION_TOOL::SelectNode(), ZOOM_TOOL::selectRegion(), PCB_SELECTION_TOOL::selectTableCells(), EE_SELECTION_TOOL::selectTableCells(), ALIGN_DISTRIBUTE_TOOL::selectTarget(), PICKER_TOOL::setControls(), PCB_PICKER_TOOL::setControls(), EE_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(), EE_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().

◆ goInternal()

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

privateinherited

Definition at line 83 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().

◆ ImportFootprint()

int FOOTPRINT_EDITOR_CONTROL::ImportFootprint ( const TOOL_EVENT & aEvent )

Definition at line 551 of file footprint_editor_control.cpp.

References FOOTPRINT_EDIT_FRAME::Clear_Pcb(), EDA_ITEM::ClearFlags(), PCB_TOOL_BASE::frame(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), TOOL_BASE::getViewControls(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), m_frame, TOOL_BASE::m_toolMgr, FOOTPRINT_EDIT_FRAME::OnModify(), FOOTPRINT_EDIT_FRAME::ReCreateHToolbar(), EDA_BASE_FRAME::ReCreateMenuBar(), TOOL_MANAGER::RunAction(), KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), and ACTIONS::zoomFitScreen.

Referenced by setTransitions().

◆ Init()

bool FOOTPRINT_EDITOR_CONTROL::Init ( )

overridevirtual

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

Returns: True if the initialization went fine, false - otherwise.

Reimplemented from PCB_TOOL_BASE.

Definition at line 77 of file footprint_editor_control.cpp.

References LIBRARY_EDITOR_CONTROL::AddContextMenuItems(), PCB_ACTIONS::copyFootprint, PCB_ACTIONS::createFootprint, PCB_ACTIONS::cutFootprint, PCB_ACTIONS::deleteFootprint, PCB_ACTIONS::duplicateFootprint, UTF8::empty(), PCB_ACTIONS::exportFootprint, PCB_BASE_FRAME::GetBoard(), ADVANCED_CFG::GetCfg(), BOARD::GetFirstFootprint(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT_EDIT_FRAME::GetLibTree(), LIB_TREE::GetSelectedLibId(), TOOL_MANAGER::GetTool(), PCB_ACTIONS::importFootprint, FOOTPRINT_EDIT_FRAME::IsContentModified(), ADVANCED_CFG::m_EnableLibDir, ADVANCED_CFG::m_EnableLibWithText, m_frame, TOOL_INTERACTIVE::m_menu, TOOL_BASE::m_toolMgr, PCB_ACTIONS::newFootprint, ACTIONS::openDirectory, ACTIONS::openWithTextEditor, PCB_ACTIONS::pasteFootprint, PCB_ACTIONS::renameFootprint, ACTIONS::revert, ACTIONS::save, ACTIONS::saveAs, and SELECTION_CONDITIONS::ShowAlways().

◆ Is45Limited()

bool PCB_TOOL_BASE::Is45Limited ( ) const

virtualinherited

Should the tool use its 45° mode option?

Returns: True if set to use 45°

Definition at line 331 of file pcb_tool_base.cpp.

References PCB_TOOL_BASE::frame(), FRAME_PCB_EDITOR, SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetSettingsManager(), and Pgm().

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawShape(), DRAWING_TOOL::DrawZone(), and ZONE_CREATE_HELPER::OnFirstPoint().

◆ IsBoardEditor()

bool PCB_TOOL_BASE::IsBoardEditor ( ) const

inlineinherited

Definition at line 109 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isBoardEditor.

◆ IsFootprintEditor()

bool PCB_TOOL_BASE::IsFootprintEditor ( ) const

inlineinherited

Definition at line 106 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isFootprintEditor.

Referenced by EDIT_TOOL::DeleteItems(), EDIT_TOOL::Flip(), EDIT_TOOL::GetAndPlace(), and PCB_GRID_HELPER::queryVisible().

◆ IsToolActive()

bool TOOL_BASE::IsToolActive ( ) const

inherited

Definition at line 31 of file tool_base.cpp.

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

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

◆ NewFootprint()

int FOOTPRINT_EDITOR_CONTROL::NewFootprint ( const TOOL_EVENT & aEvent )

◆ OpenDirectory()

int FOOTPRINT_EDITOR_CONTROL::OpenDirectory ( const TOOL_EVENT & aEvent )

Definition at line 588 of file footprint_editor_control.cpp.

References _, COMMON_SETTINGS::SYSTEM::file_explorer, PGM_BASE::GetCommonSettings(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT_EDIT_FRAME::GetTargetFPID(), GFootprintTable, FILEEXT::KiCadFootprintFileExtension, LaunchExternal(), m_frame, COMMON_SETTINGS::m_System, path, PROJECT_PCB::PcbFootprintLibs(), Pgm(), and KIWAY_HOLDER::Prj().

Referenced by setTransitions().

◆ OpenWithTextEditor()

int FOOTPRINT_EDITOR_CONTROL::OpenWithTextEditor ( const TOOL_EVENT & aEvent )

Definition at line 659 of file footprint_editor_control.cpp.

References _, ExecuteFile(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT_EDIT_FRAME::GetLibTree(), LIB_TREE::GetSelectedLibId(), PGM_BASE::GetTextEditor(), GFootprintTable, FILEEXT::KiCadFootprintFileExtension, m_frame, PROJECT_PCB::PcbFootprintLibs(), Pgm(), and KIWAY_HOLDER::Prj().

Referenced by setTransitions().

◆ PasteFootprint()

int FOOTPRINT_EDITOR_CONTROL::PasteFootprint ( const TOOL_EVENT & aEvent )

Definition at line 397 of file footprint_editor_control.cpp.

References _, UTF8::empty(), FOOTPRINT_EDIT_FRAME::FocusOnLibID(), FP_LIB_TABLE::FootprintExists(), LIB_ID::GetLibNickname(), FOOTPRINT_EDIT_FRAME::GetLibTree(), LIB_TREE::GetSelectedLibId(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), m_copiedFootprint, m_frame, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), FOOTPRINT_EDIT_FRAME::RefreshLibraryTree(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

Referenced by setTransitions().

◆ Properties()

int FOOTPRINT_EDITOR_CONTROL::Properties ( const TOOL_EVENT & aEvent )

Definition at line 769 of file footprint_editor_control.cpp.

References PCB_TOOL_BASE::footprint(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetFirstFootprint(), m_frame, and EDA_DRAW_PANEL_GAL::Refresh().

Referenced by setTransitions().

◆ RenameFootprint()

int FOOTPRINT_EDITOR_CONTROL::RenameFootprint ( const TOOL_EVENT & aEvent )

Definition at line 442 of file footprint_editor_control.cpp.

Referenced by setTransitions().

◆ RepairFootprint()

int FOOTPRINT_EDITOR_CONTROL::RepairFootprint ( const TOOL_EVENT & aEvent )

Definition at line 836 of file footprint_editor_control.cpp.

References _, PCB_TOOL_BASE::board(), DisplayInfoMessage(), PCB_TOOL_BASE::footprint(), BOARD::Footprints(), FOOTPRINT::GraphicalItems(), group, FOOTPRINT::Groups(), m_frame, FOOTPRINT_EDIT_FRAME::OnModify(), pad, FOOTPRINT::Pads(), FOOTPRINT::Reference(), FOOTPRINT::Value(), and FOOTPRINT::Zones().

Referenced by setTransitions().

◆ Reset()

void FOOTPRINT_EDITOR_CONTROL::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.

Reimplemented from PCB_TOOL_BASE.

Definition at line 68 of file footprint_editor_control.cpp.

References DestroyCheckerDialog(), m_checkerDialog, and m_frame.

◆ resetTransitions()

void TOOL_INTERACTIVE::resetTransitions ( )

privateinherited

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

Definition at line 76 of file tool_interactive.cpp.

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

◆ Revert()

int FOOTPRINT_EDITOR_CONTROL::Revert ( const TOOL_EVENT & aEvent )

Definition at line 369 of file footprint_editor_control.cpp.

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

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

Referenced by DRAWING_TOOL::PlaceText().

◆ Save()

int FOOTPRINT_EDITOR_CONTROL::Save ( const TOOL_EVENT & aEvent )

Definition at line 301 of file footprint_editor_control.cpp.

References PCB_TOOL_BASE::canvas(), FOOTPRINT_EDIT_FRAME::ClearModify(), PCB_TOOL_BASE::footprint(), EDA_DRAW_PANEL_GAL::ForceRefresh(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), FOOTPRINT_EDIT_FRAME::GetTargetFPID(), m_frame, FOOTPRINT_EDIT_FRAME::RefreshLibraryTree(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), KIGFX::PCB_VIEW::Update(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), and PCB_TOOL_BASE::view().

Referenced by setTransitions().

◆ SaveAs()

int FOOTPRINT_EDITOR_CONTROL::SaveAs ( const TOOL_EVENT & aEvent )

Definition at line 323 of file footprint_editor_control.cpp.

Referenced by setTransitions().

◆ selection() [1/2]

PCB_SELECTION & PCB_TOOL_BASE::selection ( )

protectedinherited

Definition at line 323 of file pcb_tool_base.cpp.

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

◆ selection() [2/2]

const PCB_SELECTION & PCB_TOOL_BASE::selection ( ) const

protectedinherited

Definition at line 315 of file pcb_tool_base.cpp.

References PCB_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), and TOOL_BASE::m_toolMgr.

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

◆ SetIsBoardEditor()

void PCB_TOOL_BASE::SetIsBoardEditor ( bool aEnabled )

inlineinherited

Definition at line 108 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isBoardEditor.

◆ SetIsFootprintEditor()

void PCB_TOOL_BASE::SetIsFootprintEditor ( bool aEnabled )

inlineinherited

Function SetIsFootprintEditor()

Toggles edit footprint mode. When enabled, one may select parts of footprints individually (graphics, pads, etc.), so they can be modified.

Parameters

aEnabled decides if the mode should be enabled.

Definition at line 105 of file pcb_tool_base.h.

References PCB_TOOL_BASE::m_isFootprintEditor.

◆ setTransitions()

void FOOTPRINT_EDITOR_CONTROL::setTransitions ( )

overrideprivatevirtual

< Set up handlers for various events.

Reimplemented from PCB_TOOL_BASE.

Definition at line 904 of file footprint_editor_control.cpp.

◆ ShowDatasheet()

int FOOTPRINT_EDITOR_CONTROL::ShowDatasheet ( const TOOL_EVENT & aEvent )

Definition at line 708 of file footprint_editor_control.cpp.

References _, PCB_TOOL_BASE::footprint(), PCB_TOOL_BASE::frame(), GetAssociatedDocument(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFirstFootprint(), GetFootprintDocumentationURL(), m_frame, and KIWAY_HOLDER::Prj().

Referenced by setTransitions().

◆ ToggleLayersManager()

int FOOTPRINT_EDITOR_CONTROL::ToggleLayersManager ( const TOOL_EVENT & aEvent )

Definition at line 755 of file footprint_editor_control.cpp.

References m_frame, and FOOTPRINT_EDIT_FRAME::ToggleLayersManager().

Referenced by setTransitions().

◆ ToggleProperties()

int FOOTPRINT_EDITOR_CONTROL::ToggleProperties ( const TOOL_EVENT & aEvent )

Definition at line 762 of file footprint_editor_control.cpp.

References m_frame, and PCB_BASE_EDIT_FRAME::ToggleProperties().

Referenced by setTransitions().

◆ tryToSaveFootprintInLibrary()

void FOOTPRINT_EDITOR_CONTROL::tryToSaveFootprintInLibrary	(	FOOTPRINT &	aFootprint,
		const LIB_ID &	aLibId
	)

private

Try to save the footprint in the library, if it is valid and writable.

Definition at line 165 of file footprint_editor_control.cpp.

References _, FOOTPRINT_EDIT_FRAME::ClearModify(), UTF8::empty(), FOOTPRINT::GetFPID(), LIB_ID::GetLibNickname(), LIB_ID::GetUniStringLibNickname(), FP_LIB_TABLE::IsFootprintLibWritable(), m_frame, PROJECT_PCB::PcbFootprintLibs(), KIWAY_HOLDER::Prj(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT::SetFPID(), LIB_ID::SetLibNickname(), and EDA_BASE_FRAME::ShowInfoBarWarning().

Referenced by CreateFootprint(), and NewFootprint().

◆ view()

KIGFX::PCB_VIEW * PCB_TOOL_BASE::view ( ) const

inlineprotectedinherited

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

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

Member Data Documentation

◆ m_checkerDialog

DIALOG_FOOTPRINT_CHECKER* FOOTPRINT_EDITOR_CONTROL::m_checkerDialog

private

Definition at line 98 of file footprint_editor_control.h.

Referenced by CheckFootprint(), CrossProbe(), DestroyCheckerDialog(), and Reset().

◆ m_copiedFootprint

std::unique_ptr<FOOTPRINT> FOOTPRINT_EDITOR_CONTROL::m_copiedFootprint

private

Definition at line 101 of file footprint_editor_control.h.

Referenced by CutCopyFootprint(), and PasteFootprint().

◆ m_frame

FOOTPRINT_EDIT_FRAME* FOOTPRINT_EDITOR_CONTROL::m_frame

private

◆ m_isBoardEditor

bool PCB_TOOL_BASE::m_isBoardEditor

protectedinherited

Definition at line 188 of file pcb_tool_base.h.

Referenced by PCB_TOOL_BASE::IsBoardEditor(), PCB_CONTROL::placeBoardItems(), PCB_TOOL_BASE::SetIsBoardEditor(), and PCB_CONTROL::UpdateMessagePanel().

◆ m_isFootprintEditor

bool PCB_TOOL_BASE::m_isFootprintEditor

protectedinherited

Definition at line 187 of file pcb_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.

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

◆ m_toolName

std::string TOOL_BASE::m_toolName

protectedinherited

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

pcbnew.InteractiveSelection).

Definition at line 216 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().

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ INTERACTIVE_PLACEMENT_OPTIONS

◆ RESET_REASON

Constructor & Destructor Documentation

◆ FOOTPRINT_EDITOR_CONTROL()

Member Function Documentation

◆ Activate()

◆ attachManager()

◆ board()

◆ canvas()

◆ CheckFootprint()

◆ CleanupGraphics()

◆ controls()

◆ CreateFootprint()

◆ CrossProbe()

◆ CutCopyFootprint()

◆ DefaultPadProperties()

◆ DeleteFootprint()

◆ DestroyCheckerDialog()

◆ displayOptions()

◆ doInteractiveItemPlacement()

◆ DuplicateFootprint()

◆ EditFootprint()

◆ EditLibraryFootprint()

◆ EditTextAndGraphics()

◆ ExportFootprint()

◆ footprint()

◆ frame()

◆ getEditFrame()

◆ GetId()

◆ GetManager()

◆ getModel()

◆ getModelInternal()

◆ GetName()

◆ getToolHolderInternal()

◆ GetToolMenu()

◆ GetType()

◆ getView()

◆ getViewControls()

◆ Go()

◆ goInternal()

◆ ImportFootprint()

◆ Init()

◆ Is45Limited()

◆ IsBoardEditor()

◆ IsFootprintEditor()

◆ IsToolActive()

◆ NewFootprint()

◆ OpenDirectory()

◆ OpenWithTextEditor()

◆ PasteFootprint()

◆ Properties()

◆ RenameFootprint()

◆ RepairFootprint()

◆ Reset()

◆ resetTransitions()

◆ Revert()

◆ RunMainStack()

◆ Save()

◆ SaveAs()

◆ selection() [1/2]

◆ selection() [2/2]

◆ SetContextMenu()

◆ SetIsBoardEditor()

◆ SetIsFootprintEditor()

◆ setTransitions()

◆ ShowDatasheet()

◆ ToggleLayersManager()

◆ ToggleProperties()

◆ tryToSaveFootprintInLibrary()

◆ view()

◆ Wait()