#include <pcb_test_frame.h>

Inheritance diagram for PCB_TEST_FRAME_BASE:

Public Member Functions
	PCB_TEST_FRAME_BASE ()

virtual	~PCB_TEST_FRAME_BASE ()

virtual void	SetBoard (std::shared_ptr< BOARD > b)

virtual BOARD *	LoadAndDisplayBoard (const std::string &filename)

std::shared_ptr< PCB_DRAW_PANEL_GAL >	GetPanel ()

std::shared_ptr< BOARD >	GetBoard ()

void	LoadSettings ()

virtual wxWindow *	GetToolCanvas () const override
	Canvas access.

void	SetSelectionHook (std::function< void(PCB_TEST_FRAME_BASE , PCB_SELECTION )> aHook)

void	SetSelectableItemTypes (const std::vector< KICAD_T > aTypes)

std::shared_ptr< PCB_TEST_SELECTION_TOOL >	GetSelectionTool () const

TOOL_MANAGER *	GetToolManager () const
	Return the MVC controller.

TOOL_DISPATCHER *	GetToolDispatcher () const

virtual void	RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
	Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

virtual void	RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions)
	Register a UI update handler for the control with ID `aID`.

virtual void	UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
	Unregister a UI handler for an action that was registered using `RegisterUIUpdateHandler`.

virtual void	UnregisterUIUpdateHandler (int aID)
	Unregister a UI handler for a given ID that was registered using `RegisterUIUpdateHandler`.

virtual SELECTION &	GetCurrentSelection ()
	Get the current selection from the canvas area.

virtual void	PushTool (const TOOL_EVENT &aEvent)
	NB: the definition of "tool" is different at the user level.

virtual void	PopTool (const TOOL_EVENT &aEvent)
	Pops a tool from the stack.

bool	ToolStackIsEmpty ()

std::string	CurrentToolName () const

bool	IsCurrentTool (const TOOL_ACTION &aAction) const

virtual void	DisplayToolMsg (const wxString &msg)

virtual void	ShowChangedLanguage ()

bool	GetDoImmediateActions () const
	Indicate that hotkeys should perform an immediate action even if another tool is currently active.

MOUSE_DRAG_ACTION	GetDragAction () const
	Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

bool	GetMoveWarpsCursor () const
	Indicate that a move operation should warp the mouse pointer to the origin of the move object.

virtual void	CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged)
	Notification event that some of the common (suite-wide) settings have changed.

virtual void	RefreshCanvas ()

virtual wxString	ConfigBaseName ()

Protected Member Functions
void	createView (wxWindow *aParent, PCB_DRAW_PANEL_GAL::GAL_TYPE aGalType=PCB_DRAW_PANEL_GAL::GAL_TYPE_OPENGL)

virtual void	createUserTools ()

Protected Attributes
std::shared_ptr< PCB_DRAW_PANEL_GAL >	m_galPanel

std::shared_ptr< BOARD >	m_board

std::shared_ptr< PCB_TEST_SELECTION_TOOL >	m_selectionTool

KIGFX::GAL_DISPLAY_OPTIONS	m_displayOptions

wxString	m_mruPath

TOOL_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_toolDispatcher

SELECTION	m_dummySelection

std::vector< std::string >	m_toolStack

bool	m_immediateActions

MOUSE_DRAG_ACTION	m_dragAction

bool	m_moveWarpsCursor

Detailed Description

Definition at line 53 of file pcb_test_frame.h.

Constructor & Destructor Documentation

◆ PCB_TEST_FRAME_BASE()

PCB_TEST_FRAME_BASE::PCB_TEST_FRAME_BASE ( )

Definition at line 192 of file pcb_test_frame.cpp.

References m_mruPath.

◆ ~PCB_TEST_FRAME_BASE()

PCB_TEST_FRAME_BASE::~PCB_TEST_FRAME_BASE ( )

virtual

Definition at line 198 of file pcb_test_frame.cpp.

Member Function Documentation

◆ CommonSettingsChanged()

void TOOLS_HOLDER::CommonSettingsChanged	(	bool	aEnvVarsChanged,
		bool	aTextVarsChanged
	)

virtualinherited

Notification event that some of the common (suite-wide) settings have changed.

Update hotkeys, preferences, etc.

Reimplemented in EDA_3D_VIEWER_FRAME, SCH_BASE_FRAME, SCH_EDIT_FRAME, SIMULATOR_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, EDA_BASE_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, KICAD_MANAGER_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.

Definition at line 153 of file tools_holder.cpp.

References COMMON_SETTINGS::INPUT::drag_left, TOOL_MANAGER::GetActionManager(), PGM_BASE::GetCommonSettings(), TOOLS_HOLDER::GetToolManager(), COMMON_SETTINGS::INPUT::immediate_actions, TOOLS_HOLDER::m_dragAction, TOOLS_HOLDER::m_immediateActions, COMMON_SETTINGS::m_Input, TOOLS_HOLDER::m_moveWarpsCursor, Pgm(), ACTION_MANAGER::UpdateHotKeys(), and COMMON_SETTINGS::INPUT::warp_mouse_on_move.

Referenced by EDA_BASE_FRAME::CommonSettingsChanged(), and EDA_BASE_FRAME::LoadWindowSettings().

◆ ConfigBaseName()

virtual wxString TOOLS_HOLDER::ConfigBaseName ( )

inlinevirtualinherited

Reimplemented in EDA_BASE_FRAME.

Definition at line 164 of file tools_holder.h.

Referenced by ACTION_MANAGER::UpdateHotKeys().

◆ createUserTools()

virtual void PCB_TEST_FRAME_BASE::createUserTools ( )

inlineprotectedvirtual

Reimplemented in PNS_LOG_VIEWER_FRAME.

Definition at line 79 of file pcb_test_frame.h.

Referenced by SetBoard().

◆ createView()

void PCB_TEST_FRAME_BASE::createView	(	wxWindow *	aParent,
		PCB_DRAW_PANEL_GAL::GAL_TYPE	aGalType = `PCB_DRAW_PANEL_GAL::GAL_TYPE_OPENGL`
	)

protected

Definition at line 157 of file pcb_test_frame.cpp.

References DPI_SCALING_COMMON::GetScaleFactor(), KIGFX::GAL_DISPLAY_OPTIONS::gl_antialiasing_mode, m_displayOptions, m_galPanel, KIGFX::GAL_DISPLAY_OPTIONS::m_scaleFactor, KIGFX::NONE, and Pgm().

Referenced by PNS_LOG_VIEWER_FRAME::PNS_LOG_VIEWER_FRAME().

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 122 of file tools_holder.cpp.

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOLS_HOLDER::ShowChangedLanguage().

◆ DisplayToolMsg()

virtual void TOOLS_HOLDER::DisplayToolMsg ( const wxString & msg )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 130 of file tools_holder.h.

Referenced by TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ GetBoard()

std::shared_ptr< BOARD > PCB_TEST_FRAME_BASE::GetBoard ( )

inline

Definition at line 63 of file pcb_test_frame.h.

References m_board.

◆ GetCurrentSelection()

virtual SELECTION & TOOLS_HOLDER::GetCurrentSelection ( )

inlinevirtualinherited

Get the current selection from the canvas area.

Returns: the current selection.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, SCH_EDIT_FRAME, SYMBOL_DIFF_FRAME, SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, GERBVIEW_FRAME, PL_EDITOR_FRAME, FOOTPRINT_EDIT_FRAME, FOOTPRINT_VIEWER_FRAME, and PCB_EDIT_FRAME.

Definition at line 98 of file tools_holder.h.

References TOOLS_HOLDER::m_dummySelection.

Referenced by COMMON_TOOLS::CursorControl(), COMMON_TOOLS::doCenter(), COMMON_TOOLS::doZoomFit(), EDA_BASE_FRAME::HandleUpdateUIEvent(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), ACTION_MANAGER::RunHotKey(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), NL_GERBVIEW_PLUGIN_IMPL::SetActiveCommand(), NL_PL_EDITOR_PLUGIN_IMPL::SetActiveCommand(), and NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand().

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const

inlineinherited

Indicate that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 138 of file tools_holder.h.

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const

inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 144 of file tools_holder.h.

References TOOLS_HOLDER::m_dragAction.

Referenced by EE_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const

inlineinherited

Indicate that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are allergic to mouse warping.

Definition at line 150 of file tools_holder.h.

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), and ROUTER_TOOL::InlineDrag().

◆ GetPanel()

std::shared_ptr< PCB_DRAW_PANEL_GAL > PCB_TEST_FRAME_BASE::GetPanel ( )

inline

Definition at line 62 of file pcb_test_frame.h.

References m_galPanel.

Referenced by PCB_TEST_SELECTION_TOOL::canvas().

◆ GetSelectionTool()

std::shared_ptr< PCB_TEST_SELECTION_TOOL > PCB_TEST_FRAME_BASE::GetSelectionTool ( ) const

inline

Definition at line 74 of file pcb_test_frame.h.

References m_selectionTool.

◆ GetToolCanvas()

virtual wxWindow * PCB_TEST_FRAME_BASE::GetToolCanvas ( ) const

inlineoverridevirtual

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 67 of file pcb_test_frame.h.

References m_galPanel.

◆ GetToolDispatcher()

TOOL_DISPATCHER * TOOLS_HOLDER::GetToolDispatcher ( ) const

inlineinherited

Definition at line 57 of file tools_holder.h.

References TOOLS_HOLDER::m_toolDispatcher.

Referenced by LIB_TREE_MODEL_ADAPTER::GetToolDispatcher().

◆ GetToolManager()

TOOL_MANAGER * TOOLS_HOLDER::GetToolManager ( ) const

inlineinherited

Return the MVC controller.

Definition at line 55 of file tools_holder.h.

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), SCH_SEARCH_HANDLER::ActivateItem(), PCB_SEARCH_HANDLER::ActivateItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_PROPERTIES_PANEL::AfterCommit(), PCB_PROPERTIES_PANEL::AfterCommit(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), SCH_NAVIGATE_TOOL::Back(), PCB_EDIT_FRAME::CanAcceptApiCommands(), SCH_NAVIGATE_TOOL::changeSheet(), TOOLS_HOLDER::CommonSettingsChanged(), EDA_DRAW_FRAME::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DESIGN_BLOCK_PANE::DESIGN_BLOCK_PANE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), KIGFX::SCH_VIEW::DisplaySheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), SIMULATOR_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), SCH_DRAWING_TOOLS::doSyncSheetsPins(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SIMULATOR_CONTROL::ExportPlotToSchematic(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), PCB_TUNING_PATTERN::GetPreviewItems(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), API_HANDLER_PCB::handleInteractiveMoveItems(), API_HANDLER_PCB::handleRefillZones(), DIALOG_PAD_PROPERTIES::initValues(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_GENERATORS::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_ERC::OnERCItemRClick(), DIALOG_ERC::OnERCItemSelected(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_GENERATORS::OnItemSelected(), PANEL_KICAD_LAUNCHER::onLauncherButtonClick(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::onNetNavigatorSelection(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), GERBER_LAYER_WIDGET::onPopupSelection(), DIALOG_GENERATORS::OnRebuildAllClick(), DIALOG_GENERATORS::OnRebuildTypeClick(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), DIALOG_CREATE_ARRAY::OnSelectCenterButton(), HIERARCHY_PANE::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), PANEL_SCH_SELECTION_FILTER::PANEL_SCH_SELECTION_FILTER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_PRINTOUT::PrintPage(), SIMULATOR_CONTROL::Probe(), SYMBOL_EDIT_FRAME::PushSymbolToUndoList(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PCB_BASE_FRAME::rebuildConnectivity(), SCH_EDIT_FRAME::RecalculateConnections(), SIMULATOR_FRAME::ReCreateHToolbar(), FOOTPRINT_EDIT_FRAME::ReloadFootprint(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SCH_COMMIT::SCH_COMMIT(), DIALOG_FIND::search(), SCH_SEARCH_HANDLER::SelectItems(), PCB_SEARCH_HANDLER::SelectItems(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_MAINFRAME::setupEventHandlers(), FOOTPRINT_EDIT_FRAME::setupTools(), TOOLS_HOLDER::ShowChangedLanguage(), APPEARANCE_CONTROLS::showNetclass(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SIMULATOR_CONTROL::Tune(), SCH_PROPERTIES_PANEL::UpdateData(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), SCH_PROPERTIES_PANEL::valueChanged(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanging(), PCB_PROPERTIES_PANEL::valueChanging(), GLOBAL_EDIT_TOOL::ZonesManager(), DIALOG_IMPORT_NETLIST::~DIALOG_IMPORT_NETLIST(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION & aAction ) const

inherited

Definition at line 131 of file tools_holder.cpp.

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by SCH_EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ LoadAndDisplayBoard()

BOARD * PCB_TEST_FRAME_BASE::LoadAndDisplayBoard ( const std::string & filename )

virtual

Definition at line 130 of file pcb_test_frame.cpp.

References IO_ERROR::Problem().

◆ LoadSettings()

void PCB_TEST_FRAME_BASE::LoadSettings ( )

Definition at line 204 of file pcb_test_frame.cpp.

References SETTINGS_MANAGER::GetColorSettings(), PGM_BASE::GetSettingsManager(), JSON_SETTINGS::Load(), Pgm(), and SETTINGS_MANAGER::RegisterSettings().

Referenced by PNS_LOG_VIEWER_FRAME::PNS_LOG_VIEWER_FRAME().

◆ PopTool()

void TOOLS_HOLDER::PopTool ( const TOOL_EVENT & aEvent )

virtualinherited

Pops a tool from the stack.

Parameters

aEvent The event that started the tool that was pushed to the stack.

Definition at line 77 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOLS_HOLDER::GetToolManager(), TOOLS_HOLDER::m_toolManager, TOOLS_HOLDER::m_toolStack, TOOL_ACTION::MakeEvent(), TOOL_MANAGER::PostEvent(), ACTIONS::selectionTool, TOOL_EVENT::SetHasPosition(), and TOOL_EVENT::SetReactivate().

Referenced by SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawOneBezier(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_DRAWING_TOOLS::ImportSheet(), DRAWING_TOOL::InteractivePlaceWithPreview(), PICKER_TOOL::Main(), ZOOM_TOOL::Main(), PL_EDIT_TOOL::Main(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), SYMBOL_EDITOR_DRAWING_TOOLS::PlaceAnchor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), DRAWING_TOOL::PlaceTuningPattern(), EDIT_TOOL::Remove(), DRAWING_TOOL::SetAnchor(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_LINE_WIRE_BUS_TOOL::UnfoldBus().

◆ PushTool()

void TOOLS_HOLDER::PushTool ( const TOOL_EVENT & aEvent )

virtualinherited

NB: the definition of "tool" is different at the user level.

The implementation uses a single TOOL_BASE derived class to implement several user "tools", such as rectangle and circle, or wire and bus. So each user-level tool is actually a TOOL_ACTION.

Pushes a tool to the stack.

Parameters

aEvent The event that is starting the tool to be pushed to the stack.

Definition at line 56 of file tools_holder.cpp.

References TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_EVENT::getCommandStr(), TOOL_ACTION::GetFriendlyName(), TOOLS_HOLDER::m_toolManager, and TOOLS_HOLDER::m_toolStack.

◆ RefreshCanvas()

virtual void TOOLS_HOLDER::RefreshCanvas ( )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 162 of file tools_holder.h.

Referenced by ACTION_TOOLBAR::onPaletteEvent(), and ACTION_TOOLBAR::onToolEvent().

◆ RegisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::RegisterUIUpdateHandler	(	const TOOL_ACTION &	aAction,
		const ACTION_CONDITIONS &	aConditions
	)

virtualinherited

Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls.

Parameters

aAction	is the action to register.
aConditions	are the UI conditions to use for the control states.

Definition at line 42 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::RegisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), TOOLS_HOLDER::RegisterUIUpdateHandler(), and ACTION_MANAGER::SetConditions().

◆ RegisterUIUpdateHandler() [2/2]

virtual void TOOLS_HOLDER::RegisterUIUpdateHandler	(	int	aID,
		const ACTION_CONDITIONS &	aConditions
	)

inlinevirtualinherited

Register a UI update handler for the control with ID aID.

Parameters

aID	is the control ID to register the handler for.
aConditions	are the UI conditions to use for the control states.

Reimplemented in EDA_BASE_FRAME.

Definition at line 75 of file tools_holder.h.

◆ SetBoard()

void PCB_TEST_FRAME_BASE::SetBoard ( std::shared_ptr< BOARD > b )

virtual

◆ SetSelectableItemTypes()

void PCB_TEST_FRAME_BASE::SetSelectableItemTypes ( const std::vector< KICAD_T > aTypes )

Definition at line 150 of file pcb_test_frame.cpp.

References m_selectionTool.

◆ SetSelectionHook()

void PCB_TEST_FRAME_BASE::SetSelectionHook ( std::function< void(PCB_TEST_FRAME_BASE *, PCB_SELECTION *)> aHook )

Definition at line 213 of file pcb_test_frame.cpp.

References TOOL_MANAGER::FindTool(), TOOLS_HOLDER::m_toolManager, and PCB_TEST_SELECTION_TOOL::SetSelectionHook().

◆ ShowChangedLanguage()

void TOOLS_HOLDER::ShowChangedLanguage ( )

virtualinherited

Reimplemented in EDA_3D_VIEWER_FRAME, BITMAP2CMP_FRAME, CVPCB_MAINFRAME, SCH_EDIT_FRAME, SIMULATOR_FRAME, SYMBOL_EDIT_FRAME, GERBVIEW_FRAME, EDA_BASE_FRAME, EDA_DRAW_FRAME, PCB_BASE_FRAME, KICAD_MANAGER_FRAME, PCB_CALCULATOR_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 140 of file tools_holder.cpp.

References TOOLS_HOLDER::CurrentToolName(), TOOLS_HOLDER::DisplayToolMsg(), ACTION_MANAGER::FindAction(), TOOL_MANAGER::GetActionManager(), TOOL_ACTION::GetFriendlyName(), and TOOLS_HOLDER::GetToolManager().

Referenced by EDA_BASE_FRAME::ShowChangedLanguage().

◆ ToolStackIsEmpty()

bool TOOLS_HOLDER::ToolStackIsEmpty ( )

inlineinherited

◆ UnregisterUIUpdateHandler() [1/2]

void TOOLS_HOLDER::UnregisterUIUpdateHandler ( const TOOL_ACTION & aAction )

virtualinherited

Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler.

Parameters

aAction is the action to unregister the handler for.

Definition at line 49 of file tools_holder.cpp.

References TOOL_ACTION::GetUIId(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

Referenced by ACTION_TOOLBAR::doSelectAction(), ACTION_MANAGER::SetConditions(), and TOOLS_HOLDER::UnregisterUIUpdateHandler().

◆ UnregisterUIUpdateHandler() [2/2]

virtual void TOOLS_HOLDER::UnregisterUIUpdateHandler ( int aID )

inlinevirtualinherited

Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler.

Parameters

aID	is the control ID to unregister the handler for.

protected

Definition at line 83 of file pcb_test_frame.h.

Referenced by GetSelectionTool(), SetBoard(), and SetSelectableItemTypes().

◆ m_toolDispatcher

◆ m_toolManager

TOOL_MANAGER* TOOLS_HOLDER::m_toolManager

protectedinherited

Definition at line 167 of file tools_holder.h.

◆ m_toolStack

std::vector<std::string> TOOLS_HOLDER::m_toolStack

protectedinherited

Definition at line 173 of file tools_holder.h.

Referenced by TOOLS_HOLDER::CurrentToolName(), TOOLS_HOLDER::IsCurrentTool(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), and TOOLS_HOLDER::ToolStackIsEmpty().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_TEST_FRAME_BASE()

◆ ~PCB_TEST_FRAME_BASE()

Member Function Documentation

◆ CommonSettingsChanged()

◆ ConfigBaseName()

◆ createUserTools()

◆ createView()

◆ CurrentToolName()

◆ DisplayToolMsg()

◆ GetBoard()

◆ GetCurrentSelection()

◆ GetDoImmediateActions()

◆ GetDragAction()

◆ GetMoveWarpsCursor()

◆ GetPanel()

◆ GetSelectionTool()

◆ GetToolCanvas()

◆ GetToolDispatcher()

◆ GetToolManager()

◆ IsCurrentTool()

◆ LoadAndDisplayBoard()

◆ LoadSettings()

◆ PopTool()

◆ PushTool()

◆ RefreshCanvas()

◆ RegisterUIUpdateHandler() [1/2]

◆ RegisterUIUpdateHandler() [2/2]

◆ SetBoard()

◆ SetSelectableItemTypes()

◆ SetSelectionHook()

◆ ShowChangedLanguage()

◆ ToolStackIsEmpty()

◆ UnregisterUIUpdateHandler() [1/2]

◆ UnregisterUIUpdateHandler() [2/2]

Member Data Documentation

◆ m_actions

◆ m_board

◆ m_displayOptions

◆ m_dragAction

◆ m_dummySelection

◆ m_galPanel

◆ m_immediateActions

◆ m_moveWarpsCursor

◆ m_mruPath

◆ m_selectionTool

◆ m_toolDispatcher

◆ m_toolManager

◆ m_toolStack