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. More...

	TOOL_EVENT (TOOL_EVENT_CATEGORY aCategory=TC_NONE, TOOL_ACTIONS aAction=TA_NONE, TOOL_ACTION_SCOPE aScope=AS_GLOBAL, void *aParameter=nullptr)

	TOOL_EVENT (TOOL_EVENT_CATEGORY aCategory, TOOL_ACTIONS aAction, int aExtraParam, TOOL_ACTION_SCOPE aScope=AS_GLOBAL, void *aParameter=nullptr)

	TOOL_EVENT (TOOL_EVENT_CATEGORY aCategory, TOOL_ACTIONS aAction, const std::string &aExtraParam, TOOL_ACTION_SCOPE aScope=AS_GLOBAL, void *aParameter=nullptr)
	Returns the category (eg. mouse/keyboard/action) of an event.. More...

TOOL_EVENT_CATEGORY	Category () const
	Returns more specific information about the type of an event. More...

TOOL_ACTIONS	Action () 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. More...

bool	PassEvent () const

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

bool	HasPosition () const

void	SetHasPosition (bool aHasPosition)
	Returns if the action associated with this event should be treated as immediate regardless of the current immediate action settings. More...

bool	ForceImmediate () const

void	SetForceImmediate (bool aForceImmediate=true)

TOOL_BASE *	FirstResponder () const

void	SetFirstResponder (TOOL_BASE *aTool)
	Controls whether the tool is first being pushed to the stack or being reactivated after a pause. More...

bool	IsReactivate () const

void	SetReactivate (bool aReactivate=true)
	Returns information about difference between current mouse cursor position and the place where dragging has started. More...

const VECTOR2D	Delta () const
	Returns mouse cursor position in world coordinates. More...

const VECTOR2D	Position () const
	Returns the point where dragging has started. More...

const VECTOR2D	DragOrigin () const
	Returns information about mouse buttons state. More...

int	Buttons () const

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
	Returns information about key modifiers state (Ctrl, Alt, etc.) More...

int	Modifier (int aMask=MD_MODIFIER_MASK) const

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. More...

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

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

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

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

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

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

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

template<typename T >
T	Parameter () const
	Return a non-standard parameter assigned to the event. More...

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

std::optional< int >	GetCommandId () const

void	SetMousePosition (const VECTOR2D &aP)

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. More...

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
	True when the tool is being re-activated from the stack. More...

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

VECTOR2D	m_mouseDelta
	Current mouse cursor position. More...

VECTOR2D	m_mousePos
	Point where dragging has started. More...

VECTOR2D	m_mouseDragOrigin
	State of mouse buttons. More...

int	m_mouseButtons
	Stores code of pressed/released key. More...

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

int	m_modifiers
	Generic parameter used for passing non-standard data. More...

void *	m_param
	The first tool to receive the event. More...

TOOL_BASE *	m_firstResponder

std::optional< int >	m_commandId

std::string	m_commandStr

Friends
class	TOOL_DISPATCHER

class	TOOL_MANAGER

class	TOOLS_HOLDER

Detailed Description

Generic, UI-independent tool event.

Definition at line 155 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`,
		void *	aParameter = `nullptr`
	)

inline

Definition at line 165 of file tool_event.h.

 :
 m_category( aCategory ),
 m_actions( aAction ),
 m_scope( aScope ),
 m_mouseButtons( 0 ),
 m_keyCode( 0 ),
 m_modifiers( 0 ),
 m_param( aParameter ),
 m_firstResponder( nullptr )
 {
 init();
 }

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`,
		void *	aParameter = `nullptr`
	)

inline

Definition at line 179 of file tool_event.h.

 :
 m_category( aCategory ),
 m_actions( aAction ),
 m_scope( aScope ),
 m_mouseButtons( 0 ),
 m_keyCode( 0 ),
 m_modifiers( 0 ),
 m_param( aParameter ),
 m_firstResponder( nullptr )
 {
 if( aCategory == TC_MOUSE )
 {
 setMouseButtons( aExtraParam & BUT_BUTTON_MASK );
 }
 else if( aCategory == TC_KEYBOARD )
 {
 m_keyCode = aExtraParam & ~MD_MODIFIER_MASK; // Filter out modifiers
 }
 else if( aCategory == TC_COMMAND )
 {
 m_commandId = aExtraParam;
 }
 
 if( aCategory & ( TC_MOUSE | TC_KEYBOARD ) )
 {
 m_modifiers = aExtraParam & MD_MODIFIER_MASK;
 }
 
 init();
 }

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`,
		void *	aParameter = `nullptr`
	)

inline

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

Definition at line 211 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

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 233 of file tool_event.h.

References m_actions.

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

◆ Buttons()

int TOOL_EVENT::Buttons ( ) const

inline

Definition at line 278 of file tool_event.h.

 {
 assert( m_category == TC_MOUSE ); // this should be used only with mouse events
 return m_mouseButtons;
 }

References m_category, m_mouseButtons, and TC_MOUSE.

◆ Category()

TOOL_EVENT_CATEGORY TOOL_EVENT::Category ( ) const

inline

Returns more specific information about the type of an event.

Definition at line 230 of file tool_event.h.

References m_category.

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

◆ Delta()

const VECTOR2D TOOL_EVENT::Delta ( ) const

inline

Returns mouse cursor position in world coordinates.

Definition at line 260 of file tool_event.h.

References m_mouseDelta, and returnCheckedPosition().

◆ DisableGridSnapping()

bool TOOL_EVENT::DisableGridSnapping ( ) const

inline

Definition at line 344 of file tool_event.h.

 {
 return Modifier( MD_CTRL );
 }

References MD_CTRL, and Modifier().

Referenced by EE_POINT_EDITOR::addCorner(), SCH_EDIT_TOOL::BreakWire(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_EDITOR_CONTROL::HighlightNet(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DRAWING_TOOL::PlaceImportedGraphics(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

◆ DragOrigin()

const VECTOR2D TOOL_EVENT::DragOrigin ( ) const

inline

Returns information about mouse buttons state.

Definition at line 272 of file tool_event.h.

References m_mouseDragOrigin, and returnCheckedPosition().

Referenced by EE_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 251 of file tool_event.h.

251{ return m_firstResponder; }

References m_firstResponder.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ ForceImmediate()

bool TOOL_EVENT::ForceImmediate ( ) const

inline

Definition at line 248 of file tool_event.h.

248{ return m_forceImmediate; }

TOOL_EVENT::m_forceImmediate

bool m_forceImmediate

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

Definition: tool_event.h:523

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 94 of file tool_event.cpp.

{
 std::string ev;
 
 const FlagString categories[] =
 {
 { TC_MOUSE, "mouse" },
 { TC_KEYBOARD, "keyboard" },
 { TC_COMMAND, "command" },
 { TC_MESSAGE, "message" },
 { TC_VIEW, "view" },
 { 0, "" }
 };
 
 const FlagString actions[] =
 {
 { TA_MOUSE_CLICK, "click" },
 { TA_MOUSE_DBLCLICK, "double click" },
 { TA_MOUSE_UP, "button-up" },
 { TA_MOUSE_DOWN, "button-down" },
 { TA_MOUSE_DRAG, "drag" },
 { TA_MOUSE_MOTION, "motion" },
 { TA_MOUSE_WHEEL, "wheel" },
 { TA_KEY_PRESSED, "key-pressed" },
 { TA_VIEW_REFRESH, "view-refresh" },
 { TA_VIEW_ZOOM, "view-zoom" },
 { TA_VIEW_PAN, "view-pan" },
 { TA_VIEW_DIRTY, "view-dirty" },
 { TA_CHANGE_LAYER, "change-layer" },
 { TA_CANCEL_TOOL, "cancel-tool" },
 { TA_CHOICE_MENU_UPDATE, "choice-menu-update" },
 { TA_CHOICE_MENU_CHOICE, "choice-menu-choice" },
 { TA_UNDO_REDO_PRE, "undo-redo-pre" },
 { TA_UNDO_REDO_POST, "undo-redo-post" },
 { TA_ACTION, "action" },
 { TA_ACTIVATE, "activate" },
 { 0, "" }
 };
 
 const FlagString buttons[] =
 {
 { BUT_NONE, "none" },
 { BUT_LEFT, "left" },
 { BUT_RIGHT, "right" },
 { BUT_MIDDLE, "middle" },
 { BUT_AUX1, "aux1" },
 { BUT_AUX2, "aux2" },
 { 0, "" }
 };
 
 const FlagString modifiers[] =
 {
 { MD_SHIFT, "shift" },
 { MD_CTRL, "ctrl" },
 { MD_ALT, "alt" },
 { 0, "" }
 };
 
 ev = "category: ";
 ev += flag2string( m_category, categories );
 ev += " action: ";
 ev += flag2string( m_actions, actions );
 
 if( m_actions & TA_MOUSE )
 {
 ev += " btns: ";
 ev += flag2string( m_mouseButtons, buttons );
 }
 
 if( m_actions & TA_KEYBOARD )
 {
 char tmp[128];
 sprintf( tmp, "key: %d", m_keyCode );
 ev += tmp;
 }
 
 if( m_actions & ( TA_MOUSE | TA_KEYBOARD ) )
 {
 ev += " mods: ";
 ev += flag2string( m_modifiers, modifiers );
 }
 
 if( m_commandId )
 {
 char tmp[128];
 sprintf( tmp, "cmd-id: %d", *m_commandId );
 ev += tmp;
 }
 
 ev += "cmd-str: " + m_commandStr;
 
 return ev;
}

References BUT_AUX1, BUT_AUX2, BUT_LEFT, BUT_MIDDLE, BUT_NONE, BUT_RIGHT, flag2string(), 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 465 of file tool_event.h.

 {
 return m_commandId;
 }

References m_commandId.

Referenced by SCH_MOVE_TOOL::Main().

◆ getCommandStr()

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

inlineprivate

Definition at line 482 of file tool_event.h.

482{ return m_commandStr; }

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

Definition at line 243 of file tool_event.h.

243{ return m_hasPosition; }

TOOL_EVENT::m_hasPosition

bool m_hasPosition

Definition: tool_event.h:522

References m_hasPosition.

Referenced by DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), 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(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), DRAWING_TOOL::InteractivePlaceWithPreview(), ROUTER_TOOL::MainLoop(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), returnCheckedPosition(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ init()

void TOOL_EVENT::init ( )

private

Definition at line 60 of file tool_event.cpp.

{
 // By default only MESSAGEs and Cancels are passed to multiple recipients
 m_passEvent = m_category == TC_MESSAGE || IsCancelInteractive() || IsActivate();
 
 m_hasPosition = ( m_category == TC_MOUSE || m_category == TC_COMMAND );
 
 // Cancel tool doesn't contain a position
 if( IsCancel() )
 m_hasPosition = false;
 
 m_forceImmediate = false;
 m_reactivate = false;
}

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 88 of file tool_event.cpp.

{
 return Matches( aAction->MakeEvent() );
}

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

Referenced by SYMBOL_EDITOR_CONTROL::AddLibrary(), PCB_CONTROL::AddLibrary(), SYMBOL_EDITOR_CONTROL::AddSymbol(), SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::copyToClipboard(), CONVERT_TOOL::CreatePolys(), SYMBOL_EDITOR_CONTROL::CutCopyDelete(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), GERBVIEW_CONTROL::DisplayControl(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawZone(), EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_CONTROL::DuplicateSymbol(), SCH_EDIT_TOOL::EditField(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), KICAD_MANAGER_CONTROL::Execute(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SCH_FIND_REPLACE_TOOL::FindAndReplace(), SCH_FIND_REPLACE_TOOL::FindNext(), BOARD_EDITOR_CONTROL::GenerateFabFiles(), getTargetLayerFromEvent(), ROUTER_TOOL::handleLayerSwitch(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightNet(), TOOL_EVT_UTILS::IsRotateToolEvt(), ZONE_FILLER_TOOL::IsZoneFillAction(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PCB_PICKER_TOOL::Main(), EDIT_TOOL::Mirror(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), 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(), PCB_SELECTION_TOOL::selectNet(), COMMON_CONTROL::ShowHelp(), COMMON_CONTROL::ShowLibraryTable(), 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(), EDA_3D_CONTROLLER::ZoomInOut(), COMMON_TOOLS::ZoomInOut(), EDA_3D_CONTROLLER::ZoomInOutCenter(), and COMMON_TOOLS::ZoomInOutCenter().

◆ IsActivate()

bool TOOL_EVENT::IsActivate ( ) const

inline

Definition at line 318 of file tool_event.h.

 {
 return m_actions == TA_ACTIVATE;
 }

References m_actions, and TA_ACTIVATE.

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

◆ IsCancel()

bool TOOL_EVENT::IsCancel ( ) const

inline

Definition at line 313 of file tool_event.h.

 {
 return m_actions == TA_CANCEL_TOOL;
 }

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 212 of file tool_event.cpp.

{
 return ( ( m_commandStr == ACTIONS::cancelInteractive.GetName() )
 || ( m_commandId && *m_commandId == ACTIONS::cancelInteractive.GetId() )
 || ( m_actions == TA_CANCEL_TOOL ) );
}

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

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

◆ IsChoiceMenu()

bool TOOL_EVENT::IsChoiceMenu ( ) const

inline

Definition at line 328 of file tool_event.h.

 {
 return m_actions & TA_CHOICE_MENU;
 }

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 200 of file tool_event.cpp.

{
 return ( m_actions & TA_MOUSE_CLICK ) && ( m_mouseButtons & aButtonMask ) == m_mouseButtons;
}

References m_actions, m_mouseButtons, and TA_MOUSE_CLICK.

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

◆ IsDblClick()

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

Definition at line 206 of file tool_event.cpp.

{
 return m_actions == TA_MOUSE_DBLCLICK && ( m_mouseButtons & aButtonMask ) == m_mouseButtons;
}

References m_actions, m_mouseButtons, and TA_MOUSE_DBLCLICK.

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

◆ IsDrag()

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

inline

Definition at line 288 of file tool_event.h.

 {
 return m_actions == TA_MOUSE_DRAG && ( m_mouseButtons & aButtonMask ) == m_mouseButtons;
 }

References m_actions, m_mouseButtons, and TA_MOUSE_DRAG.

Referenced by EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), EE_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 242 of file tool_event.cpp.

{
 return ( m_commandStr.find( "InteractiveEdit" ) != getCommandStr().npos );
}

References getCommandStr(), and m_commandStr.

◆ IsKeyPressed()

bool TOOL_EVENT::IsKeyPressed ( ) const

inline

Definition at line 354 of file tool_event.h.

 {
 return m_actions == TA_KEY_PRESSED;
 }

References m_actions, and TA_KEY_PRESSED.

Referenced by ROUTER_TOOL::handleCommonEvents().

◆ IsMotion()

bool TOOL_EVENT::IsMotion ( ) const

inline

Definition at line 303 of file tool_event.h.

 {
 return m_actions == TA_MOUSE_MOTION;
 }

References m_actions, and TA_MOUSE_MOTION.

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

◆ IsMouseAction()

bool TOOL_EVENT::IsMouseAction ( ) const

inline

Definition at line 308 of file tool_event.h.

 {
 return ( m_actions & TA_MOUSE );
 }

References m_actions, and TA_MOUSE.

◆ IsMouseDown()

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

inline

Definition at line 293 of file tool_event.h.

 {
 return m_actions == TA_MOUSE_DOWN && ( m_mouseButtons & aButtonMask ) == m_mouseButtons;
 }

References m_actions, m_mouseButtons, and TA_MOUSE_DOWN.

◆ IsMouseUp()

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

inline

Definition at line 298 of file tool_event.h.

 {
 return m_actions == TA_MOUSE_UP && ( m_mouseButtons & aButtonMask ) == m_mouseButtons;
 }

References m_actions, m_mouseButtons, and TA_MOUSE_UP.

Referenced by EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), 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 236 of file tool_event.cpp.

{
 return ( m_commandStr.find( "InteractiveMove" ) != getCommandStr().npos );
}

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 229 of file tool_event.cpp.

{
 return ( ( m_commandStr.find( "PointEditor" ) != getCommandStr().npos )
 || ( m_commandId && *m_commandId == ACTIONS::activatePointEditor.GetId() ) );
}

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

◆ IsPrime()

bool TOOL_EVENT::IsPrime ( ) const

inline

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

Definition at line 333 of file tool_event.h.

References m_actions, and TA_PRIME.

Referenced by PNS::TOOL_BASE::updateStartItem().

◆ IsReactivate()

bool TOOL_EVENT::IsReactivate ( ) const

inline

Definition at line 255 of file tool_event.h.

255{ return m_reactivate; }

References m_reactivate.

Referenced by BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), 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 220 of file tool_event.cpp.

{
 return Matches( EVENTS::ClearedEvent )
 || Matches( EVENTS::UnselectedEvent )
 || Matches( EVENTS::SelectedEvent )
 || Matches( EVENTS::PointSelectedEvent );
}

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 248 of file tool_event.cpp.

{
 return ( m_commandStr.find( "Simulation" ) != getCommandStr().npos );
}

References getCommandStr(), and m_commandStr.

Referenced by TOOL_MANAGER::PostEvent().

◆ IsUndoRedo()

bool TOOL_EVENT::IsUndoRedo ( ) const

inline

Definition at line 323 of file tool_event.h.

 {
 return m_actions & ( TA_UNDO_REDO_PRE | TA_UNDO_REDO_POST );
 }

References m_actions, TA_UNDO_REDO_POST, and TA_UNDO_REDO_PRE.

◆ KeyCode()

int TOOL_EVENT::KeyCode ( ) const

inline

Definition at line 349 of file tool_event.h.

 {
 return m_keyCode;
 }

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 365 of file tool_event.h.

 {
 if( !( m_category & aEvent.m_category ) )
 return false;
 
 if( m_category == TC_COMMAND || m_category == TC_MESSAGE )
 {
 if( !m_commandStr.empty() && !aEvent.getCommandStr().empty() )
 return m_commandStr == aEvent.m_commandStr;
 
 if( (bool) m_commandId && (bool) aEvent.m_commandId )
 return *m_commandId == *aEvent.m_commandId;
 }
 
 // BUGFIX: TA_ANY should match EVERYTHING, even TA_NONE (for TC_MESSAGE)
 if( m_actions == TA_ANY && aEvent.m_actions == TA_NONE && aEvent.m_category == TC_MESSAGE )
 return true;
 
 // BUGFIX: This check must happen after the TC_COMMAND check because otherwise events of
 // the form { TC_COMMAND, TA_NONE } will be incorrectly skipped
 if( !( m_actions & aEvent.m_actions ) )
 return false;
 
 return true;
 }

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(), PCB_POINT_EDITOR::changeArcEditMode(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), IsAction(), IsSelectionEvent(), 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

Definition at line 339 of file tool_event.h.

 {
 return m_modifiers & aMask;
 }

References m_modifiers.

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

◆ Parameter()

template<typename T >

T TOOL_EVENT::Parameter ( ) const

inline

Return a non-standard parameter assigned to the event.

Its meaning depends on the target tool.

Definition at line 442 of file tool_event.h.

 {
 // Exhibit #798 on why I love to hate C++
 // - reinterpret_cast needs to be used for pointers
 // - static_cast must be used for enums
 // - templates can't usefully distinguish between pointer and non-pointer types
 // Fortunately good old C's cast can be a reinterpret_cast or a static_cast, and
 // C99 gave us intptr_t which is guaranteed to be round-trippable with a pointer.
 return (T) reinterpret_cast<intptr_t>( m_param );
 }

References m_param.

Referenced by SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), MICROWAVE_TOOL::addMicrowaveFootprint(), PCB_POINT_EDITOR::changeArcEditMode(), CVPCB_CONTROL::ChangeFocus(), SCH_EDITOR_CONTROL::ChangeLineMode(), ROUTER_TOOL::ChangeRouterMode(), SCH_NAVIGATE_TOOL::ChangeSheet(), SCH_EDIT_TOOL::ChangeTextType(), 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_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawZone(), KICAD_MANAGER_CONTROL::Execute(), TOOL_EVT_UTILS::GetEventRotationAngle(), COMMON_TOOLS::GridPreset(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::GroupProperties(), ROUTER_TOOL::handleLayerSwitch(), BOARD_INSPECTION_TOOL::HideNetInRatsnest(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::HighlightNet(), KICAD_MANAGER_CONTROL::ImportNonKicadProj(), ROUTER_TOOL::InlineDrag(), PCB_CONTROL::LayerSwitch(), GERBVIEW_CONTROL::LoadGerbFiles(), KICAD_MANAGER_CONTROL::LoadProject(), GERBVIEW_CONTROL::LoadZipfile(), SCH_MOVE_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), EDA_3D_CONTROLLER::On3DGridSelection(), EDA_3D_CONTROLLER::PanControl(), COMMON_TOOLS::PanControl(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), EDIT_TOOL::Remove(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), BOARD_EDITOR_CONTROL::RepairBoard(), SCH_EDITOR_CONTROL::RepairSchematic(), EDA_3D_CONTROLLER::RotateView(), ROUTER_TOOL::RouteSelected(), SELECTION_TOOL::SelectionMenu(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), PCB_SELECTION_TOOL::selectNet(), 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(), EDA_3D_CONTROLLER::ViewControl(), KICAD_MANAGER_CONTROL::ViewDroppedViewers(), ZONE_FILLER_TOOL::ZoneFill(), and COMMON_TOOLS::ZoomPreset().

◆ PassEvent()

bool TOOL_EVENT::PassEvent ( ) const

inline

Definition at line 238 of file tool_event.h.

238{ return m_passEvent; }

References m_passEvent.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ Position()

const VECTOR2D TOOL_EVENT::Position ( ) const

inline

Returns the point where dragging has started.

Definition at line 266 of file tool_event.h.

References m_mousePos, and returnCheckedPosition().

Referenced by EE_SELECTION_TOOL::autostartEvent(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawDimension(), 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(), DRAWING_TOOL::InteractivePlaceWithPreview(), ROUTER_TOOL::MainLoop(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), EE_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 76 of file tool_event.cpp.

{
#ifdef WX_COMPATIBILITY
 wxCHECK_MSG( HasPosition(), VECTOR2D(), "Attempted to get position from non-position event" );
#else
 assert( HasPosition() );
#endif
 
 return aPos;
}

References HasPosition().

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

◆ SetFirstResponder()

void TOOL_EVENT::SetFirstResponder ( TOOL_BASE * aTool )

inline

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

Definition at line 252 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 249 of file tool_event.h.

249{ m_forceImmediate = aForceImmediate; }

References m_forceImmediate.

◆ SetHasPosition()

void TOOL_EVENT::SetHasPosition ( bool aHasPosition )

inline

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

Definition at line 244 of file tool_event.h.

References m_hasPosition.

Referenced by PANEL_KICAD_LAUNCHER::CreateLaunchers(), TOOL_MANAGER::DispatchContextMenu(), 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 500 of file tool_event.h.

 {
 assert( ( aMods & ~MD_MODIFIER_MASK ) == 0 );
 m_modifiers = aMods;
 }

References m_modifiers, and MD_MODIFIER_MASK.

◆ setMouseButtons()

void TOOL_EVENT::setMouseButtons ( int aButtons )

inlineprivate

Definition at line 494 of file tool_event.h.

 {
 assert( ( aButtons & ~BUT_BUTTON_MASK ) == 0 );
 m_mouseButtons = aButtons;
 }

References BUT_BUTTON_MASK, and m_mouseButtons.

Referenced by TOOL_EVENT().

◆ setMouseDelta()

void TOOL_EVENT::setMouseDelta ( const VECTOR2D & aP )

inlineprivate

Definition at line 489 of file tool_event.h.

 {
 m_mouseDelta = aP;
 }

References m_mouseDelta.

◆ setMouseDragOrigin()

void TOOL_EVENT::setMouseDragOrigin ( const VECTOR2D & aP )

inlineprivate

Definition at line 484 of file tool_event.h.

 {
 m_mouseDragOrigin = aP;
 }

References m_mouseDragOrigin.

◆ SetMousePosition()

void TOOL_EVENT::SetMousePosition ( const VECTOR2D & aP )

inline

Definition at line 470 of file tool_event.h.

 {
 m_mousePos = aP;
 }

References m_mousePos.

Referenced by EE_SELECTION_TOOL::autostartEvent(), COMMON_TOOLS::CursorControl(), TOOL_MANAGER::invokeTool(), TOOL_MANAGER::PrimeTool(), and TOOL_MANAGER::RunAction().

◆ 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 460 of file tool_event.h.

 {
 m_param = reinterpret_cast<void*>( aParam );
 }

References m_param.

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

◆ SetPassEvent()

void TOOL_EVENT::SetPassEvent ( bool aPass = true )

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 239 of file tool_event.h.

References m_passEvent.

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

◆ SetReactivate()

void TOOL_EVENT::SetReactivate ( bool aReactivate = true )

inline

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

Definition at line 256 of file tool_event.h.

References m_reactivate.

Referenced by TOOLS_HOLDER::PopTool().

Friends And Related Function Documentation

◆ TOOL_DISPATCHER

friend class TOOL_DISPATCHER

friend

Definition at line 476 of file tool_event.h.

◆ TOOL_MANAGER

friend class TOOL_MANAGER

friend

Definition at line 477 of file tool_event.h.

◆ TOOLS_HOLDER

friend class TOOLS_HOLDER

friend

Definition at line 478 of file tool_event.h.

Member Data Documentation

◆ m_actions

TOOL_ACTIONS TOOL_EVENT::m_actions

private

Definition at line 519 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 518 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 553 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 554 of file tool_event.h.

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

◆ m_firstResponder

TOOL_BASE* TOOL_EVENT::m_firstResponder

private

Definition at line 551 of file tool_event.h.

Referenced by FirstResponder(), and SetFirstResponder().

◆ m_forceImmediate

bool TOOL_EVENT::m_forceImmediate

private

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

Definition at line 523 of file tool_event.h.

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

◆ m_hasPosition

bool TOOL_EVENT::m_hasPosition

private

Definition at line 522 of file tool_event.h.

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

◆ m_keyCode

int TOOL_EVENT::m_keyCode

private

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

Definition at line 542 of file tool_event.h.

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

◆ m_modifiers

int TOOL_EVENT::m_modifiers

private

Generic parameter used for passing non-standard data.

Definition at line 545 of file tool_event.h.

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

◆ m_mouseButtons

int TOOL_EVENT::m_mouseButtons

private

Stores code of pressed/released key.

Definition at line 539 of file tool_event.h.

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

◆ m_mouseDelta

VECTOR2D TOOL_EVENT::m_mouseDelta

private

Current mouse cursor position.

Definition at line 530 of file tool_event.h.

Referenced by Delta(), and setMouseDelta().

◆ m_mouseDragOrigin

VECTOR2D TOOL_EVENT::m_mouseDragOrigin

private

State of mouse buttons.

Definition at line 536 of file tool_event.h.

Referenced by DragOrigin(), and setMouseDragOrigin().

◆ m_mousePos

VECTOR2D TOOL_EVENT::m_mousePos

private

Point where dragging has started.

Definition at line 533 of file tool_event.h.

Referenced by Position(), and SetMousePosition().

◆ m_param

void* TOOL_EVENT::m_param

private

The first tool to receive the event.

Definition at line 548 of file tool_event.h.

Referenced by Parameter(), and SetParameter().

◆ m_passEvent

bool TOOL_EVENT::m_passEvent

private

Definition at line 521 of file tool_event.h.

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

◆ m_reactivate

bool TOOL_EVENT::m_reactivate

private

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

Definition at line 526 of file tool_event.h.

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

◆ m_scope

TOOL_ACTION_SCOPE TOOL_EVENT::m_scope

private

Definition at line 520 of file tool_event.h.

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

◆ Delta()

◆ DisableGridSnapping()

◆ DragOrigin()

◆ FirstResponder()

◆ ForceImmediate()

◆ Format()

◆ GetCommandId()

◆ getCommandStr()

◆ HasPosition()

◆ init()

◆ IsAction()

◆ IsActivate()

◆ IsCancel()

◆ IsCancelInteractive()

◆ IsChoiceMenu()

◆ IsClick()

◆ IsDblClick()

◆ IsDrag()

◆ IsEditorTool()

◆ IsKeyPressed()

◆ IsMotion()

◆ IsMouseAction()

◆ IsMouseDown()

◆ IsMouseUp()

◆ IsMoveTool()

◆ IsPointEditor()

◆ IsPrime()

◆ IsReactivate()

◆ IsSelectionEvent()

◆ IsSimulator()

◆ IsUndoRedo()

◆ KeyCode()

◆ Matches()

◆ Modifier()

◆ Parameter()

◆ PassEvent()

◆ Position()

◆ returnCheckedPosition()

◆ SetFirstResponder()

◆ SetForceImmediate()

◆ SetHasPosition()

◆ setModifiers()

◆ setMouseButtons()

◆ setMouseDelta()

◆ setMouseDragOrigin()

◆ SetMousePosition()

◆ SetParameter()

◆ SetPassEvent()

◆ SetReactivate()

Friends And Related Function Documentation

◆ TOOL_DISPATCHER

◆ TOOL_MANAGER

◆ TOOLS_HOLDER

Member Data Documentation

◆ m_actions

◆ m_category

◆ m_commandId

◆ m_commandStr

◆ m_firstResponder

◆ m_forceImmediate

◆ m_hasPosition

◆ m_keyCode

◆ m_modifiers

◆ m_mouseButtons

◆ m_mouseDelta

◆ m_mouseDragOrigin

◆ m_mousePos