KiCad PCB EDA Suite
TOOL_EVENT Class Reference

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_BASEFirstResponder () 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 >
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_BASEm_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.

166 :
167 m_category( aCategory ),
168 m_actions( aAction ),
169 m_scope( aScope ),
170 m_mouseButtons( 0 ),
171 m_keyCode( 0 ),
172 m_modifiers( 0 ),
173 m_param( aParameter ),
174 m_firstResponder( nullptr )
175 {
176 init();
177 }
int m_keyCode
State of key modifiers (Ctrl/Alt/etc.)
Definition: tool_event.h:542
TOOL_ACTION_SCOPE m_scope
Definition: tool_event.h:520
int m_modifiers
Generic parameter used for passing non-standard data.
Definition: tool_event.h:545
void * m_param
The first tool to receive the event.
Definition: tool_event.h:548
void init()
Definition: tool_event.cpp:60
TOOL_ACTIONS m_actions
Definition: tool_event.h:519
TOOL_BASE * m_firstResponder
Definition: tool_event.h:551
TOOL_EVENT_CATEGORY m_category
Definition: tool_event.h:518
int m_mouseButtons
Stores code of pressed/released key.
Definition: tool_event.h:539

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.

180 :
181 m_category( aCategory ),
182 m_actions( aAction ),
183 m_scope( aScope ),
184 m_mouseButtons( 0 ),
185 m_keyCode( 0 ),
186 m_modifiers( 0 ),
187 m_param( aParameter ),
188 m_firstResponder( nullptr )
189 {
190 if( aCategory == TC_MOUSE )
191 {
192 setMouseButtons( aExtraParam & BUT_BUTTON_MASK );
193 }
194 else if( aCategory == TC_KEYBOARD )
195 {
196 m_keyCode = aExtraParam & ~MD_MODIFIER_MASK; // Filter out modifiers
197 }
198 else if( aCategory == TC_COMMAND )
199 {
200 m_commandId = aExtraParam;
201 }
202
203 if( aCategory & ( TC_MOUSE | TC_KEYBOARD ) )
204 {
205 m_modifiers = aExtraParam & MD_MODIFIER_MASK;
206 }
207
208 init();
209 }
std::optional< int > m_commandId
Definition: tool_event.h:553
void setMouseButtons(int aButtons)
Definition: tool_event.h:494
@ TC_COMMAND
Definition: tool_event.h:52
@ TC_MOUSE
Definition: tool_event.h:50
@ TC_KEYBOARD
Definition: tool_event.h:51
@ MD_MODIFIER_MASK
Definition: tool_event.h:141
@ BUT_BUTTON_MASK
Definition: tool_event.h:132

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.

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

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

◆ DragOrigin()

const VECTOR2D TOOL_EVENT::DragOrigin ( ) const
inline

◆ 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; }
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.

95{
96 std::string ev;
97
98 const FlagString categories[] =
99 {
100 { TC_MOUSE, "mouse" },
101 { TC_KEYBOARD, "keyboard" },
102 { TC_COMMAND, "command" },
103 { TC_MESSAGE, "message" },
104 { TC_VIEW, "view" },
105 { 0, "" }
106 };
107
108 const FlagString actions[] =
109 {
110 { TA_MOUSE_CLICK, "click" },
111 { TA_MOUSE_DBLCLICK, "double click" },
112 { TA_MOUSE_UP, "button-up" },
113 { TA_MOUSE_DOWN, "button-down" },
114 { TA_MOUSE_DRAG, "drag" },
115 { TA_MOUSE_MOTION, "motion" },
116 { TA_MOUSE_WHEEL, "wheel" },
117 { TA_KEY_PRESSED, "key-pressed" },
118 { TA_VIEW_REFRESH, "view-refresh" },
119 { TA_VIEW_ZOOM, "view-zoom" },
120 { TA_VIEW_PAN, "view-pan" },
121 { TA_VIEW_DIRTY, "view-dirty" },
122 { TA_CHANGE_LAYER, "change-layer" },
123 { TA_CANCEL_TOOL, "cancel-tool" },
124 { TA_CHOICE_MENU_UPDATE, "choice-menu-update" },
125 { TA_CHOICE_MENU_CHOICE, "choice-menu-choice" },
126 { TA_UNDO_REDO_PRE, "undo-redo-pre" },
127 { TA_UNDO_REDO_POST, "undo-redo-post" },
128 { TA_ACTION, "action" },
129 { TA_ACTIVATE, "activate" },
130 { 0, "" }
131 };
132
133 const FlagString buttons[] =
134 {
135 { BUT_NONE, "none" },
136 { BUT_LEFT, "left" },
137 { BUT_RIGHT, "right" },
138 { BUT_MIDDLE, "middle" },
139 { BUT_AUX1, "aux1" },
140 { BUT_AUX2, "aux2" },
141 { 0, "" }
142 };
143
144 const FlagString modifiers[] =
145 {
146 { MD_SHIFT, "shift" },
147 { MD_CTRL, "ctrl" },
148 { MD_ALT, "alt" },
149 { 0, "" }
150 };
151
152 ev = "category: ";
153 ev += flag2string( m_category, categories );
154 ev += " action: ";
155 ev += flag2string( m_actions, actions );
156
157 if( m_actions & TA_MOUSE )
158 {
159 ev += " btns: ";
160 ev += flag2string( m_mouseButtons, buttons );
161 }
162
163 if( m_actions & TA_KEYBOARD )
164 {
165 char tmp[128];
166 sprintf( tmp, "key: %d", m_keyCode );
167 ev += tmp;
168 }
169
170 if( m_actions & ( TA_MOUSE | TA_KEYBOARD ) )
171 {
172 ev += " mods: ";
173 ev += flag2string( m_modifiers, modifiers );
174 }
175
176 if( m_commandId )
177 {
178 char tmp[128];
179 sprintf( tmp, "cmd-id: %d", *m_commandId );
180 ev += tmp;
181 }
182
183 ev += "cmd-str: " + m_commandStr;
184
185 return ev;
186}
std::string m_commandStr
Definition: tool_event.h:554
static const std::string flag2string(int aFlag, const FlagString *aExps)
Definition: tool_event.cpp:46
@ TA_CHOICE_MENU_CHOICE
Definition: tool_event.h:93
@ TA_UNDO_REDO_PRE
Definition: tool_event.h:101
@ TA_MOUSE_CLICK
Definition: tool_event.h:62
@ TA_CHOICE_MENU_UPDATE
Definition: tool_event.h:89
@ TA_MOUSE
Definition: tool_event.h:69
@ TA_ACTIVATE
Definition: tool_event.h:110
@ TA_MOUSE_MOTION
Definition: tool_event.h:67
@ TA_MOUSE_UP
Definition: tool_event.h:64
@ TA_KEYBOARD
Definition: tool_event.h:72
@ TA_VIEW_REFRESH
Definition: tool_event.h:75
@ TA_MOUSE_DRAG
Definition: tool_event.h:66
@ TA_CHANGE_LAYER
Definition: tool_event.h:81
@ TA_MOUSE_DOWN
Definition: tool_event.h:65
@ TA_UNDO_REDO_POST
Definition: tool_event.h:104
@ TA_KEY_PRESSED
Definition: tool_event.h:71
@ TA_MOUSE_DBLCLICK
Definition: tool_event.h:63
@ TA_MOUSE_WHEEL
Definition: tool_event.h:68
@ TA_ACTION
Definition: tool_event.h:107
@ TA_VIEW_PAN
Definition: tool_event.h:77
@ TA_CANCEL_TOOL
Definition: tool_event.h:85
@ TA_VIEW_DIRTY
Definition: tool_event.h:78
@ TA_VIEW_ZOOM
Definition: tool_event.h:76
@ TC_MESSAGE
Definition: tool_event.h:53
@ TC_VIEW
Definition: tool_event.h:54
@ MD_ALT
Definition: tool_event.h:140
@ MD_SHIFT
Definition: tool_event.h:138
@ BUT_AUX1
Definition: tool_event.h:130
@ BUT_MIDDLE
Definition: tool_event.h:129
@ BUT_LEFT
Definition: tool_event.h:127
@ BUT_RIGHT
Definition: tool_event.h:128
@ BUT_AUX2
Definition: tool_event.h:131
@ BUT_NONE
Definition: tool_event.h:126

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.

466 {
467 return m_commandId;
468 }

References m_commandId.

Referenced by SCH_MOVE_TOOL::Main().

◆ getCommandStr()

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

◆ HasPosition()

◆ init()

void TOOL_EVENT::init ( )
private

Definition at line 60 of file tool_event.cpp.

61{
62 // By default only MESSAGEs and Cancels are passed to multiple recipients
64
66
67 // Cancel tool doesn't contain a position
68 if( IsCancel() )
69 m_hasPosition = false;
70
71 m_forceImmediate = false;
72 m_reactivate = false;
73}
bool IsCancelInteractive() const
Indicate the event should restart/end an ongoing interactive tool's event loop (eg esc key,...
Definition: tool_event.cpp:212
bool IsActivate() const
Definition: tool_event.h:318
bool m_passEvent
Definition: tool_event.h:521
bool m_reactivate
Difference between mouse cursor position and the point where dragging event has started.
Definition: tool_event.h:526
bool IsCancel() const
Definition: tool_event.h:313

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

89{
90 return Matches( aAction->MakeEvent() );
91}
TOOL_EVENT MakeEvent() const
Return the event associated with the action (i.e.
Definition: tool_action.cpp:72
bool Matches(const TOOL_EVENT &aEvent) const
Test whether two events match in terms of category & action or command.
Definition: tool_event.h:365

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_EDITOR_CONTROL::FindAndReplace(), SCH_EDITOR_CONTROL::FindNext(), BOARD_EDITOR_CONTROL::GenerateFabFiles(), getTargetLayerFromEvent(), ROUTER_TOOL::handleLayerSwitch(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::HighlightNet(), TOOL_EVT_UTILS::IsRotateToolEvt(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_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_EDITOR_CONTROL::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

◆ IsCancel()

bool TOOL_EVENT::IsCancel ( ) const
inline

Definition at line 313 of file tool_event.h.

314 {
315 return m_actions == TA_CANCEL_TOOL;
316 }

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.

213{
214 return ( ( m_commandStr == ACTIONS::cancelInteractive.GetName() )
216 || ( m_actions == TA_CANCEL_TOOL ) );
217}
static TOOL_ACTION cancelInteractive
Definition: actions.h:63

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.

329 {
330 return m_actions & TA_CHOICE_MENU;
331 }
@ TA_CHOICE_MENU
Definition: tool_event.h:98

References m_actions, and TA_CHOICE_MENU.

Referenced by TOOL_MANAGER::dispatchInternal().

◆ IsClick()

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

◆ IsDblClick()

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

Definition at line 206 of file tool_event.cpp.

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

References m_actions, m_mouseButtons, and TA_MOUSE_DBLCLICK.

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

◆ IsDrag()

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

243{
244 return ( m_commandStr.find( "InteractiveEdit" ) != getCommandStr().npos );
245}
const std::string & getCommandStr() const
Definition: tool_event.h:482

References getCommandStr(), and m_commandStr.

◆ IsKeyPressed()

bool TOOL_EVENT::IsKeyPressed ( ) const
inline

Definition at line 354 of file tool_event.h.

355 {
356 return m_actions == TA_KEY_PRESSED;
357 }

References m_actions, and TA_KEY_PRESSED.

Referenced by ROUTER_TOOL::handleCommonEvents().

◆ IsMotion()

◆ IsMouseAction()

bool TOOL_EVENT::IsMouseAction ( ) const
inline

Definition at line 308 of file tool_event.h.

309 {
310 return ( m_actions & TA_MOUSE );
311 }

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.

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

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.

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

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.

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

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.

230{
231 return ( ( m_commandStr.find( "PointEditor" ) != getCommandStr().npos )
233}
static TOOL_ACTION activatePointEditor
Definition: actions.h:171

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

◆ IsSelectionEvent()

bool TOOL_EVENT::IsSelectionEvent ( ) const

Indicate an selection-changed notification event.

Definition at line 220 of file tool_event.cpp.

221{
226}
static const TOOL_EVENT ClearedEvent
Selected item had a property changed (except movement)
Definition: actions.h:207
static const TOOL_EVENT SelectedEvent
Definition: actions.h:205
static const TOOL_EVENT PointSelectedEvent
Definition: actions.h:204
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:206

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.

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

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.

324 {
326 }

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.

350 {
351 return m_keyCode;
352 }

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
aEventis the event to test against.
Returns
True if two events match, false otherwise.

Definition at line 365 of file tool_event.h.

366 {
367 if( !( m_category & aEvent.m_category ) )
368 return false;
369
371 {
372 if( !m_commandStr.empty() && !aEvent.getCommandStr().empty() )
373 return m_commandStr == aEvent.m_commandStr;
374
375 if( (bool) m_commandId && (bool) aEvent.m_commandId )
376 return *m_commandId == *aEvent.m_commandId;
377 }
378
379 // BUGFIX: TA_ANY should match EVERYTHING, even TA_NONE (for TC_MESSAGE)
380 if( m_actions == TA_ANY && aEvent.m_actions == TA_NONE && aEvent.m_category == TC_MESSAGE )
381 return true;
382
383 // BUGFIX: This check must happen after the TC_COMMAND check because otherwise events of
384 // the form { TC_COMMAND, TA_NONE } will be incorrectly skipped
385 if( !( m_actions & aEvent.m_actions ) )
386 return false;
387
388 return true;
389 }
@ TA_ANY
Definition: tool_event.h:121
@ TA_NONE
Definition: tool_event.h:61

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

Referenced by 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_EDITOR_CONTROL::UpdateFind().

◆ Modifier()

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

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

References m_param.

Referenced by SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), SCH_LINE_WIRE_BUS_TOOL::AddJunctionsIfNeeded(), MICROWAVE_TOOL::addMicrowaveFootprint(), 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(), 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(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), 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()

◆ 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
aPosthe position to return if the event is valid
Returns
the checked position

Definition at line 76 of file tool_event.cpp.

77{
78#ifdef WX_COMPATIBILITY
79 wxCHECK_MSG( HasPosition(), VECTOR2D(), "Attempted to get position from non-position event" );
80#else
81 assert( HasPosition() );
82#endif
83
84 return aPos;
85}
bool HasPosition() const
Definition: tool_event.h:243
VECTOR2< double > VECTOR2D
Definition: vector2d.h:617

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.

501 {
502 assert( ( aMods & ~MD_MODIFIER_MASK ) == 0 );
503 m_modifiers = aMods;
504 }

References m_modifiers, and MD_MODIFIER_MASK.

◆ setMouseButtons()

void TOOL_EVENT::setMouseButtons ( int  aButtons)
inlineprivate

Definition at line 494 of file tool_event.h.

495 {
496 assert( ( aButtons & ~BUT_BUTTON_MASK ) == 0 );
497 m_mouseButtons = aButtons;
498 }

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.

490 {
491 m_mouseDelta = aP;
492 }
VECTOR2D m_mouseDelta
Current mouse cursor position.
Definition: tool_event.h:530

References m_mouseDelta.

◆ setMouseDragOrigin()

void TOOL_EVENT::setMouseDragOrigin ( const VECTOR2D aP)
inlineprivate

Definition at line 484 of file tool_event.h.

485 {
487 }
VECTOR2D m_mouseDragOrigin
State of mouse buttons.
Definition: tool_event.h:536

References m_mouseDragOrigin.

◆ SetMousePosition()

void TOOL_EVENT::SetMousePosition ( const VECTOR2D aP)
inline

Definition at line 470 of file tool_event.h.

471 {
472 m_mousePos = aP;
473 }
VECTOR2D m_mousePos
Point where dragging has started.
Definition: tool_event.h:533

References m_mousePos.

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

◆ SetParameter()

template<typename T >
void TOOL_EVENT::SetParameter ( aParam)
inline

Set a non-standard parameter assigned to the event.

Its meaning depends on the target tool.

Parameters
aParamis the new parameter.

Definition at line 460 of file tool_event.h.

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

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

◆ 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

◆ m_commandStr

std::string TOOL_EVENT::m_commandStr
private

◆ 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: