Generic, UI-independent tool event. More...

#include <tool_event.h>

Public Member Functions
const std::string	Format () const
	Return information about event in form of a human-readable string.

	TOOL_EVENT (TOOL_EVENT_CATEGORY aCategory=TC_NONE, TOOL_ACTIONS aAction=TA_NONE, TOOL_ACTION_SCOPE aScope=AS_GLOBAL)

	TOOL_EVENT (TOOL_EVENT_CATEGORY aCategory, TOOL_ACTIONS aAction, int aExtraParam, TOOL_ACTION_SCOPE aScope=AS_GLOBAL)

	TOOL_EVENT (TOOL_EVENT_CATEGORY aCategory, TOOL_ACTIONS aAction, const std::string &aExtraParam, TOOL_ACTION_SCOPE aScope=AS_GLOBAL)

TOOL_EVENT_CATEGORY	Category () const
	Return the category (eg. mouse/keyboard/action) of an event.

TOOL_ACTIONS	Action () const
	Returns more specific information about the type of an event.

bool	PassEvent () const
	These give a tool a method of informing the TOOL_MANAGER that a particular event should be passed on to subsequent tools on the stack.

void	SetPassEvent (bool aPass=true)

bool	HasPosition () const
	Returns if it this event has a valid position (true for mouse events and context-menu or hotkey-based command events).

void	SetHasPosition (bool aHasPosition)

bool	ForceImmediate () const
	Returns if the action associated with this event should be treated as immediate regardless of the current immediate action settings.

void	SetForceImmediate (bool aForceImmediate=true)

TOOL_BASE *	FirstResponder () const

void	SetFirstResponder (TOOL_BASE *aTool)

bool	IsReactivate () const
	Control whether the tool is first being pushed to the stack or being reactivated after a pause.

void	SetReactivate (bool aReactivate=true)

void	SetSynchronous (std::atomic< SYNCRONOUS_TOOL_STATE > *aState)

std::atomic< SYNCRONOUS_TOOL_STATE > *	SynchronousState () const

void	SetCommit (COMMIT *aCommit)

COMMIT *	Commit () const

const VECTOR2D	Delta () const
	Return information about difference between current mouse cursor position and the place where dragging has started.

const VECTOR2D	Position () const
	Return mouse cursor position in world coordinates.

const VECTOR2D	DragOrigin () const
	Return the point where dragging has started.

int	Buttons () const
	Return information about mouse buttons state.

bool	IsClick (int aButtonMask=BUT_ANY) const

bool	IsDblClick (int aButtonMask=BUT_ANY) const

bool	IsDrag (int aButtonMask=BUT_ANY) const

bool	IsMouseDown (int aButtonMask=BUT_ANY) const

bool	IsMouseUp (int aButtonMask=BUT_ANY) const

bool	IsMotion () const

bool	IsMouseAction () const

bool	IsCancel () const

bool	IsActivate () const

bool	IsUndoRedo () const

bool	IsChoiceMenu () const

bool	IsPrime () const

int	Modifier (int aMask=MD_MODIFIER_MASK) const
	Return information about key modifiers state (Ctrl, Alt, etc.).

bool	DisableGridSnapping () const

int	KeyCode () const

bool	IsKeyPressed () const

bool	Matches (const TOOL_EVENT &aEvent) const
	Test whether two events match in terms of category & action or command.

bool	IsAction (const TOOL_ACTION *aAction) const
	Test if the event contains an action issued upon activation of the given TOOL_ACTION.

bool	IsCancelInteractive () const
	Indicate the event should restart/end an ongoing interactive tool's event loop (eg esc key, click cancel, start different tool).

bool	IsSelectionEvent () const
	Indicate an selection-changed notification event.

bool	IsPointEditor () const
	Indicate if the event is from one of the point editors.

bool	IsMoveTool () const
	Indicate if the event is from one of the move tools.

bool	IsEditorTool () const
	Indicate if the event is asking for an editor tool.

bool	IsSimulator () const
	Indicate if the event is from the simulator.

template<typename T , std::enable_if_t<!std::is_pointer< T >::value > * = nullptr>
T	Parameter () const
	Return a parameter assigned to the event.

template<typename T , std::enable_if_t< std::is_pointer< T >::value > * = nullptr>
T	Parameter () const
	Return pointer parameter assigned to the event.

template<typename T >
void	SetParameter (T aParam)
	Set a non-standard parameter assigned to the event.

std::optional< int >	GetCommandId () const

void	SetMousePosition (const VECTOR2D &aP)

void	SetActionGroup (const TOOL_ACTION_GROUP &aGroup)

bool	IsActionInGroup (const TOOL_ACTION_GROUP &aGroup) const

Private Member Functions
void	init ()

const std::string &	getCommandStr () const

void	setMouseDragOrigin (const VECTOR2D &aP)

void	setMouseDelta (const VECTOR2D &aP)

void	setMouseButtons (int aButtons)

void	setModifiers (int aMods)

VECTOR2D	returnCheckedPosition (const VECTOR2D &aPos) const
	Ensure that the event is a type that has a position before returning a position, otherwise return a null-constructed position.

Private Attributes
TOOL_EVENT_CATEGORY	m_category

TOOL_ACTIONS	m_actions

TOOL_ACTION_SCOPE	m_scope

bool	m_passEvent

bool	m_hasPosition

bool	m_forceImmediate

std::optional< TOOL_ACTION_GROUP >	m_actionGroup
	Optional group that the parent action for the event belongs to.

bool	m_reactivate
	True when the tool is being re-activated from the stack.

VECTOR2D	m_mouseDelta
	Difference between mouse cursor position and the point where dragging event has started.

VECTOR2D	m_mousePos
	Current mouse cursor position.

VECTOR2D	m_mouseDragOrigin
	Point where dragging has started.

int	m_mouseButtons
	State of mouse buttons.

int	m_keyCode
	Stores code of pressed/released key.

int	m_modifiers
	State of key modifiers (Ctrl/Alt/etc.).

std::atomic< SYNCRONOUS_TOOL_STATE > *	m_synchronousState

COMMIT *	m_commit
	Commit the tool handling the event should add to.

ki::any	m_param
	Generic parameter used for passing non-standard data.

TOOL_BASE *	m_firstResponder
	The first tool to receive the event.

std::optional< int >	m_commandId

std::string	m_commandStr

Friends
class	TOOL_EVENT_LIST

class	TOOL_DISPATCHER

class	TOOL_MANAGER

class	TOOLS_HOLDER

Detailed Description

Generic, UI-independent tool event.

Definition at line 167 of file tool_event.h.

Constructor & Destructor Documentation

◆ TOOL_EVENT() [1/3]

TOOL_EVENT::TOOL_EVENT	(	TOOL_EVENT_CATEGORY	aCategory = `TC_NONE`,
		TOOL_ACTIONS	aAction = `TA_NONE`,
		TOOL_ACTION_SCOPE	aScope = `AS_GLOBAL`
	)

inline

Definition at line 177 of file tool_event.h.

References init().

◆ TOOL_EVENT() [2/3]

TOOL_EVENT::TOOL_EVENT	(	TOOL_EVENT_CATEGORY	aCategory,
		TOOL_ACTIONS	aAction,
		int	aExtraParam,
		TOOL_ACTION_SCOPE	aScope = `AS_GLOBAL`
	)

inline

Definition at line 192 of file tool_event.h.

References BUT_BUTTON_MASK, init(), m_commandId, m_keyCode, m_modifiers, MD_MODIFIER_MASK, setMouseButtons(), TC_COMMAND, TC_KEYBOARD, and TC_MOUSE.

◆ TOOL_EVENT() [3/3]

TOOL_EVENT::TOOL_EVENT	(	TOOL_EVENT_CATEGORY	aCategory,
		TOOL_ACTIONS	aAction,
		const std::string &	aExtraParam,
		TOOL_ACTION_SCOPE	aScope = `AS_GLOBAL`
	)

inline

Definition at line 225 of file tool_event.h.

References init(), m_commandStr, TC_COMMAND, and TC_MESSAGE.

Member Function Documentation

◆ Action()

TOOL_ACTIONS TOOL_EVENT::Action ( ) const

inline

Returns more specific information about the type of an event.

Definition at line 247 of file tool_event.h.

References m_actions.

Referenced by EDIT_TOOL::copyToClipboard(), TOOL_MANAGER::DispatchHotKey(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), and PL_EDIT_TOOL::Main().

◆ Buttons()

int TOOL_EVENT::Buttons ( ) const

inline

Return information about mouse buttons state.

Definition at line 302 of file tool_event.h.

References m_category, m_mouseButtons, and TC_MOUSE.

◆ Category()

TOOL_EVENT_CATEGORY TOOL_EVENT::Category ( ) const

inline

Return the category (eg. mouse/keyboard/action) of an event.

Definition at line 244 of file tool_event.h.

References m_category.

Referenced by EDIT_TOOL::copyToClipboard(), TOOL_MANAGER::dispatchInternal(), and ROUTER_TOOL::handleCommonEvents().

◆ Commit()

COMMIT * TOOL_EVENT::Commit ( ) const

inline

◆ Delta()

const VECTOR2D TOOL_EVENT::Delta ( ) const

inline

Return information about difference between current mouse cursor position and the place where dragging has started.

Definition at line 284 of file tool_event.h.

References m_mouseDelta, and returnCheckedPosition().

◆ DisableGridSnapping()

bool TOOL_EVENT::DisableGridSnapping ( ) const

inline

◆ DragOrigin()

const VECTOR2D TOOL_EVENT::DragOrigin ( ) const

inline

Return the point where dragging has started.

Definition at line 296 of file tool_event.h.

References m_mouseDragOrigin, and returnCheckedPosition().

Referenced by SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), and PNS::TOOL_BASE::updateEndItem().

◆ FirstResponder()

TOOL_BASE * TOOL_EVENT::FirstResponder ( ) const

inline

Definition at line 265 of file tool_event.h.

References m_firstResponder.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ ForceImmediate()

bool TOOL_EVENT::ForceImmediate ( ) const

inline

Returns if the action associated with this event should be treated as immediate regardless of the current immediate action settings.

Definition at line 262 of file tool_event.h.

References m_forceImmediate.

Referenced by TOOL_MANAGER::processEvent().

◆ Format()

const std::string TOOL_EVENT::Format ( ) const

Return information about event in form of a human-readable string.

Returns: Event information.

Definition at line 97 of file tool_event.cpp.

References BUT_AUX1, BUT_AUX2, BUT_LEFT, BUT_MIDDLE, BUT_NONE, BUT_RIGHT, flag2string(), m_actionGroup, m_actions, m_category, m_commandId, m_commandStr, m_keyCode, m_modifiers, m_mouseButtons, MD_ALT, MD_CTRL, MD_SHIFT, TA_ACTION, TA_ACTIVATE, TA_CANCEL_TOOL, TA_CHANGE_LAYER, TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_UPDATE, TA_KEY_PRESSED, TA_KEYBOARD, TA_MOUSE, TA_MOUSE_CLICK, TA_MOUSE_DBLCLICK, TA_MOUSE_DOWN, TA_MOUSE_DRAG, TA_MOUSE_MOTION, TA_MOUSE_UP, TA_MOUSE_WHEEL, TA_UNDO_REDO_POST, TA_UNDO_REDO_PRE, TA_VIEW_DIRTY, TA_VIEW_PAN, TA_VIEW_REFRESH, TA_VIEW_ZOOM, TC_COMMAND, TC_KEYBOARD, TC_MESSAGE, TC_MOUSE, and TC_VIEW.

Referenced by TOOL_MANAGER::dispatchActivation(), TOOL_MANAGER::dispatchInternal(), and TOOL_MANAGER::processEvent().

◆ GetCommandId()

std::optional< int > TOOL_EVENT::GetCommandId ( ) const

inline

Definition at line 525 of file tool_event.h.

References m_commandId.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ getCommandStr()

const std::string & TOOL_EVENT::getCommandStr ( ) const

inlineprivate

Definition at line 550 of file tool_event.h.

References m_commandStr.

Referenced by TOOL_MANAGER::dispatchActivation(), IsEditorTool(), IsMoveTool(), IsPointEditor(), IsSimulator(), Matches(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::processEvent(), and TOOLS_HOLDER::PushTool().

◆ HasPosition()

bool TOOL_EVENT::HasPosition ( ) const

inline

Returns if it this event has a valid position (true for mouse events and context-menu or hotkey-based command events).

Definition at line 257 of file tool_event.h.

References m_hasPosition.

◆ init()

void TOOL_EVENT::init ( )

private

Definition at line 58 of file tool_event.cpp.

References IsActivate(), IsCancel(), IsCancelInteractive(), m_category, m_forceImmediate, m_hasPosition, m_passEvent, m_reactivate, TC_COMMAND, TC_MESSAGE, and TC_MOUSE.

Referenced by TOOL_EVENT().

◆ IsAction()

bool TOOL_EVENT::IsAction ( const TOOL_ACTION * aAction ) const

Test if the event contains an action issued upon activation of the given TOOL_ACTION.

Parameters

aAction is the TOOL_ACTION to be checked against.

Returns: True if it matches the given TOOL_ACTION.

Definition at line 82 of file tool_event.cpp.

References TOOL_ACTION::MakeEvent(), and Matches().

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeSymbols(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::copyToClipboard(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), GERBVIEW_CONTROL::DisplayControl(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_EDIT_TOOL::EditField(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), COMMON_CONTROL::Execute(), KICAD_MANAGER_CONTROL::Execute(), SCH_FIND_REPLACE_TOOL::FindAndReplace(), SCH_FIND_REPLACE_TOOL::FindNext(), BOARD_EDITOR_CONTROL::FindNext(), GENERATOR_TOOL::GenEditAction(), ROUTER_TOOL::handleLayerSwitch(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightNet(), SCH_DRAWING_TOOLS::ImportSheet(), TOOL_EVT_UTILS::IsRotateToolEvt(), ZONE_FILLER_TOOL::IsZoneFillAction(), SCH_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), EDIT_TOOL::Mirror(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), passEvent(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::Paste(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SYMBOL_EDITOR_PIN_TOOL::PushPinProperties(), SYMBOL_EDITOR_CONTROL::Save(), SIMULATOR_CONTROL::SaveWorkbook(), PCB_SELECTION_TOOL::selectNet(), SCH_EDIT_TOOL::SetAttribute(), COMMON_CONTROL::ShowHelp(), COMMON_CONTROL::ShowLibraryTable(), PCB_CONTROL::SnapMode(), PL_EDITOR_CONTROL::TitleBlockDisplayMode(), PCB_CONTROL::ToggleRatsnest(), EDA_3D_CONTROLLER::ToggleVisibility(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_FIND_REPLACE_TOOL::UpdateFind(), PCB_CONTROL::ZoneDisplayMode(), SIMULATOR_CONTROL::Zoom(), EDA_3D_CONTROLLER::ZoomInOut(), COMMON_TOOLS::ZoomInOut(), EDA_3D_CONTROLLER::ZoomInOutCenter(), and COMMON_TOOLS::ZoomInOutCenter().

◆ IsActionInGroup()

bool TOOL_EVENT::IsActionInGroup ( const TOOL_ACTION_GROUP & aGroup ) const

Definition at line 88 of file tool_event.cpp.

References m_actionGroup.

Referenced by ROUTER_TOOL::handleLayerSwitch().

◆ IsActivate()

bool TOOL_EVENT::IsActivate ( ) const

inline

Definition at line 342 of file tool_event.h.

References m_actions, and TA_ACTIVATE.

Referenced by TOOL_MANAGER::dispatchActivation(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), init(), and PL_EDIT_TOOL::Main().

◆ IsCancel()

bool TOOL_EVENT::IsCancel ( ) const

inline

Definition at line 337 of file tool_event.h.

References m_actions, and TA_CANCEL_TOOL.

Referenced by init().

◆ IsCancelInteractive()

bool TOOL_EVENT::IsCancelInteractive ( ) const

Indicate the event should restart/end an ongoing interactive tool's event loop (eg esc key, click cancel, start different tool).

Definition at line 221 of file tool_event.cpp.

References ACTIONS::cancelInteractive, m_actions, m_commandId, m_commandStr, and TA_CANCEL_TOOL.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), init(), and PL_EDIT_TOOL::Main().

◆ IsChoiceMenu()

bool TOOL_EVENT::IsChoiceMenu ( ) const

inline

Definition at line 352 of file tool_event.h.

References m_actions, and TA_CHOICE_MENU.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ IsClick()

bool TOOL_EVENT::IsClick ( int aButtonMask = BUT_ANY ) const

Definition at line 209 of file tool_event.cpp.

References m_actions, m_mouseButtons, and TA_MOUSE_CLICK.

Referenced by TOOL_MANAGER::DispatchContextMenu(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), and PL_EDIT_TOOL::Main().

◆ IsDblClick()

bool TOOL_EVENT::IsDblClick ( int aButtonMask = BUT_ANY ) const

Definition at line 215 of file tool_event.cpp.

References m_actions, m_mouseButtons, and TA_MOUSE_DBLCLICK.

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

◆ IsDrag()

bool TOOL_EVENT::IsDrag ( int aButtonMask = BUT_ANY ) const

inline

Definition at line 312 of file tool_event.h.

References m_actions, m_mouseButtons, and TA_MOUSE_DRAG.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), PL_EDIT_TOOL::Main(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), and PNS::TOOL_BASE::updateEndItem().

◆ IsEditorTool()

bool TOOL_EVENT::IsEditorTool ( ) const

Indicate if the event is asking for an editor tool.

Used to allow deleting an element without de-activating the current tool.

Definition at line 251 of file tool_event.cpp.

References getCommandStr(), and m_commandStr.

◆ IsKeyPressed()

bool TOOL_EVENT::IsKeyPressed ( ) const

inline

Definition at line 378 of file tool_event.h.

References m_actions, and TA_KEY_PRESSED.

Referenced by ROUTER_TOOL::handleCommonEvents().

◆ IsMotion()

bool TOOL_EVENT::IsMotion ( ) const

inline

Definition at line 327 of file tool_event.h.

References m_actions, and TA_MOUSE_MOTION.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), PL_EDIT_TOOL::Main(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), and PCB_POINT_EDITOR::updateEditedPoint().

◆ IsMouseAction()

bool TOOL_EVENT::IsMouseAction ( ) const

inline

Definition at line 332 of file tool_event.h.

References m_actions, and TA_MOUSE.

◆ IsMouseDown()

bool TOOL_EVENT::IsMouseDown ( int aButtonMask = BUT_ANY ) const

inline

Definition at line 317 of file tool_event.h.

References m_actions, m_mouseButtons, and TA_MOUSE_DOWN.

◆ IsMouseUp()

bool TOOL_EVENT::IsMouseUp ( int aButtonMask = BUT_ANY ) const

inline

Definition at line 322 of file tool_event.h.

References m_actions, m_mouseButtons, and TA_MOUSE_UP.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), and PL_EDIT_TOOL::Main().

◆ IsMoveTool()

bool TOOL_EVENT::IsMoveTool ( ) const

Indicate if the event is from one of the move tools.

Usually used to allow move to be done without de-activating the current drawing tool.

Definition at line 245 of file tool_event.cpp.

References getCommandStr(), and m_commandStr.

◆ IsPointEditor()

bool TOOL_EVENT::IsPointEditor ( ) const

Indicate if the event is from one of the point editors.

Usually used to allow the point editor to activate itself without de-activating the current drawing tool.

Definition at line 238 of file tool_event.cpp.

References ACTIONS::activatePointEditor, getCommandStr(), m_commandId, and m_commandStr.

◆ IsPrime()

bool TOOL_EVENT::IsPrime ( ) const

inline

Definition at line 357 of file tool_event.h.

References m_actions, and TA_PRIME.

◆ IsReactivate()

bool TOOL_EVENT::IsReactivate ( ) const

inline

Control whether the tool is first being pushed to the stack or being reactivated after a pause.

Definition at line 270 of file tool_event.h.

References m_reactivate.

Referenced by SCH_DRAWING_TOOLS::ImportSheet(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ IsSelectionEvent()

bool TOOL_EVENT::IsSelectionEvent ( ) const

Indicate an selection-changed notification event.

Definition at line 229 of file tool_event.cpp.

References EVENTS::ClearedEvent, Matches(), EVENTS::PointSelectedEvent, EVENTS::SelectedEvent, and EVENTS::UnselectedEvent.

◆ IsSimulator()

bool TOOL_EVENT::IsSimulator ( ) const

Indicate if the event is from the simulator.

Definition at line 257 of file tool_event.cpp.

References getCommandStr(), and m_commandStr.

Referenced by TOOL_MANAGER::PostEvent().

◆ IsUndoRedo()

bool TOOL_EVENT::IsUndoRedo ( ) const

inline

Definition at line 347 of file tool_event.h.

References m_actions, TA_UNDO_REDO_POST, and TA_UNDO_REDO_PRE.

◆ KeyCode()

int TOOL_EVENT::KeyCode ( ) const

inline

Definition at line 373 of file tool_event.h.

References m_keyCode.

Referenced by TOOL_MANAGER::DispatchHotKey(), and ROUTER_TOOL::handleCommonEvents().

◆ Matches()

bool TOOL_EVENT::Matches ( const TOOL_EVENT & aEvent ) const

inline

Test whether two events match in terms of category & action or command.

Parameters

aEvent is the event to test against.

Returns: True if two events match, false otherwise.

Definition at line 389 of file tool_event.h.

References getCommandStr(), m_actions, m_category, m_commandId, m_commandStr, TA_ANY, TA_NONE, TC_COMMAND, and TC_MESSAGE.

Referenced by SCH_EDIT_TOOL::BreakWire(), SCH_POINT_EDITOR::changeArcEditMode(), PCB_POINT_EDITOR::changeArcEditMode(), ALIGN_DISTRIBUTE_TOOL::DistributeItems(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), IsAction(), IsSelectionEvent(), SCH_EDIT_TOOL::JustifyText(), EDIT_TOOL::JustifyText(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_POINT_EDITOR::OnSelectionChange(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ Modifier()

int TOOL_EVENT::Modifier ( int aMask = MD_MODIFIER_MASK ) const

inline

Return information about key modifiers state (Ctrl, Alt, etc.).

Definition at line 363 of file tool_event.h.

References m_modifiers.

Referenced by DisableGridSnapping(), TOOL_MANAGER::DispatchHotKey(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), PICKER_TOOL::Main(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

◆ Parameter() [1/2]

template<typename T , std::enable_if_t<!std::is_pointer< T >::value > * = nullptr>

T TOOL_EVENT::Parameter ( ) const

inline

Return a parameter assigned to the event.

Its meaning depends on the target tool.

Definition at line 465 of file tool_event.h.

References ki::any::has_value(), m_param, name, T, and ki::any::type().

Referenced by EMBED_TOOL::AddFile(), SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), MICROWAVE_TOOL::addMicrowaveFootprint(), SCH_POINT_EDITOR::changeArcEditMode(), PCB_POINT_EDITOR::changeArcEditMode(), CVPCB_CONTROL::ChangeFocus(), SCH_EDITOR_CONTROL::ChangeLineMode(), ROUTER_TOOL::ChangeRouterMode(), SCH_NAVIGATE_TOOL::ChangeSheet(), SCH_EDIT_TOOL::ChangeTextType(), SYMBOL_EDITOR_CONTROL::ChangeUnit(), COMMON_TOOLS::CursorControl(), PCB_SELECTION_TOOL::CursorSelection(), SYMBOL_EDITOR_CONTROL::DdAddLibrary(), PCB_CONTROL::DdAddLibrary(), PCB_CONTROL::DdAppendBoard(), SCH_EDIT_TOOL::DdAppendFile(), PCB_CONTROL::DdImportFootprint(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), BOARD_EDITOR_CONTROL::DrillOrigin(), COMMON_CONTROL::Execute(), KICAD_MANAGER_CONTROL::Execute(), EDA_3D_CONTROLLER::ExportImage(), GENERATOR_TOOL::GenEditAction(), TOOL_EVT_UTILS::GetEventRotationAngle(), PCB_CONTROL::GridPlaceOrigin(), COMMON_TOOLS::GridPreset(), GROUP_TOOL::GroupProperties(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::HideNetInRatsnest(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::HighlightNet(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_EDIT_TOOL::Increment(), SYMBOL_EDITOR_EDIT_TOOL::Increment(), EDIT_TOOL::Increment(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::IterateFootprint(), PCB_CONTROL::LayerSwitch(), GERBVIEW_CONTROL::LoadGerbFiles(), KICAD_MANAGER_CONTROL::LoadProject(), GERBVIEW_CONTROL::LoadZipfile(), SCH_MOVE_TOOL::Main(), PICKER_TOOL::Main(), PCB_PICKER_TOOL::Main(), ROUTER_TOOL::MainLoop(), EDA_3D_CONTROLLER::On3DGridSelection(), EDA_3D_CONTROLLER::PanControl(), COMMON_TOOLS::PanControl(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceTuningPattern(), GENERATOR_TOOL::RegenerateAllOfType(), GENERATOR_TOOL::RegenerateItem(), EDIT_TOOL::Remove(), EMBED_TOOL::RemoveFile(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), BOARD_EDITOR_CONTROL::RepairBoard(), SCH_EDITOR_CONTROL::RepairSchematic(), SELECTION_TOOL::ReselectItem(), EDA_3D_CONTROLLER::RotateView(), ROUTER_TOOL::RouteSelected(), SELECTION_TOOL::SelectionMenu(), GERBVIEW_SELECTION_TOOL::SelectItem(), PCB_PICKER_TOOL::SelectItemInteractively(), GERBVIEW_SELECTION_TOOL::SelectItems(), PCB_SELECTION_TOOL::selectNet(), PCB_PICKER_TOOL::SelectPointInteractively(), PCB_SELECTION_TOOL::selectSheetContents(), EDA_3D_CONTROLLER::SetMaterial(), BOARD_INSPECTION_TOOL::ShowNetInRatsnest(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_DRAWING_TOOLS::SingleClickPlace(), COMMON_TOOLS::SwitchUnits(), PCB_SELECTION_TOOL::syncSelection(), PCB_SELECTION_TOOL::syncSelectionWithNets(), CVPCB_CONTROL::ToggleFootprintFilter(), CVPCB_CONTROL::ToNA(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_LINE_WIRE_BUS_TOOL::UnfoldBus(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EDA_3D_CONTROLLER::UpdateMenu(), CVPCB_CONTROL::UpdateMenu(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::UpdateMenu(), SELECTION_TOOL::UpdateMenu(), KICAD_MANAGER_CONTROL::UpdateMenu(), FOOTPRINT_CHOOSER_SELECTION_TOOL::UpdateMenu(), EDA_3D_CONTROLLER::ViewControl(), KICAD_MANAGER_CONTROL::ViewDroppedViewers(), ZONE_FILLER_TOOL::ZoneFill(), and COMMON_TOOLS::ZoomPreset().

◆ Parameter() [2/2]

template<typename T , std::enable_if_t< std::is_pointer< T >::value > * = nullptr>

T TOOL_EVENT::Parameter ( ) const

inline

Return pointer parameter assigned to the event.

Its meaning depends on the target tool.

Definition at line 491 of file tool_event.h.

References ki::any::has_value(), m_param, name, T, and ki::any::type().

◆ PassEvent()

bool TOOL_EVENT::PassEvent ( ) const

inline

These give a tool a method of informing the TOOL_MANAGER that a particular event should be passed on to subsequent tools on the stack.

Defaults to true for TC_MESSAGES; false for everything else.

Definition at line 252 of file tool_event.h.

References m_passEvent.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ Position()

const VECTOR2D TOOL_EVENT::Position ( ) const

inline

Return mouse cursor position in world coordinates.

Definition at line 290 of file tool_event.h.

References m_mousePos, and returnCheckedPosition().

Referenced by SCH_SELECTION_TOOL::autostartEvent(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawBezier(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawRuleArea(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::DrawTable(), DRAWING_TOOL::DrawTable(), DRAWING_TOOL::DrawZone(), ROUTER_TOOL::MainLoop(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_POINT_EDITOR::updateEditedPoint(), PL_POINT_EDITOR::updateEditedPoint(), PCB_POINT_EDITOR::updateEditedPoint(), and PNS::TOOL_BASE::updateStartItem().

◆ returnCheckedPosition()

VECTOR2D TOOL_EVENT::returnCheckedPosition ( const VECTOR2D & aPos ) const

private

Ensure that the event is a type that has a position before returning a position, otherwise return a null-constructed position.

Used to defend the position accessors from runtime access when the event does not have a valid position.

Parameters

aPos	the position to return if the event is valid

Returns: the checked position

Definition at line 74 of file tool_event.cpp.

References HasPosition().

Referenced by Delta(), DragOrigin(), and Position().

◆ SetActionGroup()

void TOOL_EVENT::SetActionGroup ( const TOOL_ACTION_GROUP & aGroup )

inline

Definition at line 535 of file tool_event.h.

References m_actionGroup.

Referenced by TOOL_ACTION::MakeEvent().

◆ SetCommit()

void TOOL_EVENT::SetCommit ( COMMIT * aCommit )

inline

Definition at line 279 of file tool_event.h.

References m_commit.

◆ SetFirstResponder()

void TOOL_EVENT::SetFirstResponder ( TOOL_BASE * aTool )

inline

Definition at line 266 of file tool_event.h.

References m_firstResponder.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ SetForceImmediate()

void TOOL_EVENT::SetForceImmediate ( bool aForceImmediate = true )

inline

Definition at line 263 of file tool_event.h.

References m_forceImmediate.

◆ SetHasPosition()

void TOOL_EVENT::SetHasPosition ( bool aHasPosition )

inline

Definition at line 258 of file tool_event.h.

References m_hasPosition.

Referenced by TOOL_MANAGER::DispatchContextMenu(), PANEL_KICAD_LAUNCHER::onLauncherButtonClick(), ACTION_TOOLBAR::onPaletteEvent(), TOOLS_HOLDER::PopTool(), TOOL_MANAGER::processEvent(), and PCB_EDIT_FRAME::ShowBoardSetupDialog().

◆ setModifiers()

void TOOL_EVENT::setModifiers ( int aMods )

inlineprivate

Definition at line 568 of file tool_event.h.

References m_modifiers, and MD_MODIFIER_MASK.

◆ setMouseButtons()

void TOOL_EVENT::setMouseButtons ( int aButtons )

inlineprivate

Definition at line 562 of file tool_event.h.

References BUT_BUTTON_MASK, and m_mouseButtons.

Referenced by TOOL_EVENT().

◆ setMouseDelta()

void TOOL_EVENT::setMouseDelta ( const VECTOR2D & aP )

inlineprivate

Definition at line 557 of file tool_event.h.

References m_mouseDelta.

◆ setMouseDragOrigin()

void TOOL_EVENT::setMouseDragOrigin ( const VECTOR2D & aP )

inlineprivate

Definition at line 552 of file tool_event.h.

References m_mouseDragOrigin.

◆ SetMousePosition()

void TOOL_EVENT::SetMousePosition ( const VECTOR2D & aP )

inline

Definition at line 530 of file tool_event.h.

References m_mousePos.

Referenced by COMMON_TOOLS::CursorControl(), TOOL_MANAGER::doRunAction(), TOOL_MANAGER::invokeTool(), and TOOL_MANAGER::PrimeTool().

◆ SetParameter()

template<typename T >

void TOOL_EVENT::SetParameter ( T aParam )

inline

Set a non-standard parameter assigned to the event.

Its meaning depends on the target tool.

Parameters

aParam is the new parameter.

Definition at line 520 of file tool_event.h.

References m_param.

Referenced by COMMON_TOOLS::CursorControl(), EDIT_TOOL::cutToClipboard(), TOOL_MANAGER::DispatchContextMenu(), and TOOL_ACTION::MakeEvent().

◆ SetPassEvent()

void TOOL_EVENT::SetPassEvent ( bool aPass = true )

inline

Definition at line 253 of file tool_event.h.

References m_passEvent.

Referenced by EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), ROUTER_TOOL::handleCommonEvents(), PL_EDIT_TOOL::Main(), and passEvent().

◆ SetReactivate()

void TOOL_EVENT::SetReactivate ( bool aReactivate = true )

inline

Definition at line 271 of file tool_event.h.

References m_reactivate.

Referenced by TOOLS_HOLDER::PopTool().

◆ SetSynchronous()

void TOOL_EVENT::SetSynchronous ( std::atomic< SYNCRONOUS_TOOL_STATE > * aState )

inline

Definition at line 273 of file tool_event.h.

References m_synchronousState.

◆ SynchronousState()

std::atomic< SYNCRONOUS_TOOL_STATE > * TOOL_EVENT::SynchronousState ( ) const

inline

Definition at line 277 of file tool_event.h.

References m_synchronousState.

Referenced by SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), and EDIT_TOOL::Move().

Friends And Related Function Documentation

◆ TOOL_DISPATCHER

friend class TOOL_DISPATCHER

friend

Definition at line 544 of file tool_event.h.

◆ TOOL_EVENT_LIST

friend class TOOL_EVENT_LIST

friend

Definition at line 543 of file tool_event.h.

◆ TOOL_MANAGER

friend class TOOL_MANAGER

friend

Definition at line 545 of file tool_event.h.

◆ TOOLS_HOLDER

friend class TOOLS_HOLDER

friend

Definition at line 546 of file tool_event.h.

Member Data Documentation

◆ m_actionGroup

std::optional<TOOL_ACTION_GROUP> TOOL_EVENT::m_actionGroup

private

Optional group that the parent action for the event belongs to.

Definition at line 595 of file tool_event.h.

Referenced by Format(), IsActionInGroup(), and SetActionGroup().

◆ m_actions

TOOL_ACTIONS TOOL_EVENT::m_actions

private

Definition at line 587 of file tool_event.h.

Referenced by Action(), Format(), IsActivate(), IsCancel(), IsCancelInteractive(), IsChoiceMenu(), IsClick(), IsDblClick(), IsDrag(), IsKeyPressed(), IsMotion(), IsMouseAction(), IsMouseDown(), IsMouseUp(), IsPrime(), IsUndoRedo(), and Matches().

◆ m_category

TOOL_EVENT_CATEGORY TOOL_EVENT::m_category

private

Definition at line 586 of file tool_event.h.

Referenced by Buttons(), Category(), Format(), init(), and Matches().

◆ m_commandId

std::optional<int> TOOL_EVENT::m_commandId

private

Definition at line 629 of file tool_event.h.

Referenced by Format(), GetCommandId(), IsCancelInteractive(), IsPointEditor(), Matches(), and TOOL_EVENT().

◆ m_commandStr

std::string TOOL_EVENT::m_commandStr

private

Definition at line 630 of file tool_event.h.

Referenced by Format(), getCommandStr(), IsCancelInteractive(), IsEditorTool(), IsMoveTool(), IsPointEditor(), IsSimulator(), Matches(), and TOOL_EVENT().

◆ m_commit

COMMIT* TOOL_EVENT::m_commit

private

Commit the tool handling the event should add to.

Definition at line 621 of file tool_event.h.

Referenced by Commit(), and SetCommit().

◆ m_firstResponder

TOOL_BASE* TOOL_EVENT::m_firstResponder

private

The first tool to receive the event.

Definition at line 627 of file tool_event.h.

Referenced by FirstResponder(), and SetFirstResponder().

◆ m_forceImmediate

bool TOOL_EVENT::m_forceImmediate

private

Definition at line 591 of file tool_event.h.

Referenced by ForceImmediate(), init(), and SetForceImmediate().

◆ m_hasPosition

bool TOOL_EVENT::m_hasPosition

private

Definition at line 590 of file tool_event.h.

Referenced by HasPosition(), init(), and SetHasPosition().

◆ m_keyCode

int TOOL_EVENT::m_keyCode

private

Stores code of pressed/released key.

Definition at line 613 of file tool_event.h.

Referenced by Format(), KeyCode(), and TOOL_EVENT().

◆ m_modifiers

int TOOL_EVENT::m_modifiers

private

State of key modifiers (Ctrl/Alt/etc.).

Definition at line 616 of file tool_event.h.

Referenced by Format(), Modifier(), setModifiers(), and TOOL_EVENT().

◆ m_mouseButtons

int TOOL_EVENT::m_mouseButtons

private

State of mouse buttons.

Definition at line 610 of file tool_event.h.

Referenced by Buttons(), Format(), IsClick(), IsDblClick(), IsDrag(), IsMouseDown(), IsMouseUp(), and setMouseButtons().

◆ m_mouseDelta

VECTOR2D TOOL_EVENT::m_mouseDelta

private

Difference between mouse cursor position and the point where dragging event has started.

Definition at line 601 of file tool_event.h.

Referenced by Delta(), and setMouseDelta().

◆ m_mouseDragOrigin

VECTOR2D TOOL_EVENT::m_mouseDragOrigin

private

Point where dragging has started.

Definition at line 607 of file tool_event.h.

Referenced by DragOrigin(), and setMouseDragOrigin().

◆ m_mousePos

VECTOR2D TOOL_EVENT::m_mousePos

private

Current mouse cursor position.

Definition at line 604 of file tool_event.h.

Referenced by Position(), and SetMousePosition().

◆ m_param

ki::any TOOL_EVENT::m_param

private

Generic parameter used for passing non-standard data.

Definition at line 624 of file tool_event.h.

Referenced by Parameter(), and SetParameter().

◆ m_passEvent

bool TOOL_EVENT::m_passEvent

private

Definition at line 589 of file tool_event.h.

Referenced by init(), PassEvent(), and SetPassEvent().

◆ m_reactivate

bool TOOL_EVENT::m_reactivate

private

True when the tool is being re-activated from the stack.

Definition at line 598 of file tool_event.h.

Referenced by init(), IsReactivate(), and SetReactivate().

◆ m_scope

TOOL_ACTION_SCOPE TOOL_EVENT::m_scope

private

Definition at line 588 of file tool_event.h.

◆ m_synchronousState

std::atomic<SYNCRONOUS_TOOL_STATE>* TOOL_EVENT::m_synchronousState

private

Definition at line 618 of file tool_event.h.

Referenced by SetSynchronous(), and SynchronousState().

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TOOL_EVENT() [1/3]

◆ TOOL_EVENT() [2/3]

◆ TOOL_EVENT() [3/3]

Member Function Documentation

◆ Action()

◆ Buttons()

◆ Category()

◆ Commit()

◆ Delta()

◆ DisableGridSnapping()

◆ DragOrigin()

◆ FirstResponder()

◆ ForceImmediate()

◆ Format()

◆ GetCommandId()

◆ getCommandStr()

◆ HasPosition()

◆ init()

◆ IsAction()

◆ IsActionInGroup()

◆ IsActivate()

◆ IsCancel()

◆ IsCancelInteractive()

◆ IsChoiceMenu()

◆ IsClick()

◆ IsDblClick()

◆ IsDrag()

◆ IsEditorTool()

◆ IsKeyPressed()

◆ IsMotion()

◆ IsMouseAction()

◆ IsMouseDown()

◆ IsMouseUp()

◆ IsMoveTool()

◆ IsPointEditor()

◆ IsPrime()

◆ IsReactivate()

◆ IsSelectionEvent()

◆ IsSimulator()

◆ IsUndoRedo()

◆ KeyCode()

◆ Matches()

◆ Modifier()

◆ Parameter() [1/2]

◆ Parameter() [2/2]

◆ PassEvent()

◆ Position()

◆ returnCheckedPosition()

◆ SetActionGroup()

◆ SetCommit()

◆ SetFirstResponder()

◆ SetForceImmediate()

◆ SetHasPosition()

◆ setModifiers()

◆ setMouseButtons()

◆ setMouseDelta()

◆ setMouseDragOrigin()

◆ SetMousePosition()

◆ SetParameter()

◆ SetPassEvent()

◆ SetReactivate()

◆ SetSynchronous()

◆ SynchronousState()

Friends And Related Function Documentation

◆ TOOL_DISPATCHER

◆ TOOL_EVENT_LIST

◆ TOOL_MANAGER

◆ TOOLS_HOLDER

Member Data Documentation

◆ m_actionGroup

◆ m_actions

◆ m_category

◆ m_commandId

◆ m_commandStr