KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
TOOL_DISPATCHER::BUTTON_STATE Struct Reference

Store information about a mouse button state. More...

Public Member Functions

 BUTTON_STATE (TOOL_MOUSE_BUTTONS aButton, const wxEventType &aDownEvent, const wxEventType &aUpEvent, const wxEventType &aDblClickEvent)
 
void Reset ()
 Restores initial state.
 
bool GetState () const
 Checks the current state of the button.
 

Public Attributes

bool dragging
 Flag indicating that dragging is active for the given button.
 
bool pressed
 Flag indicating that the given button is pressed.
 
VECTOR2D dragOrigin
 Point where dragging has started (in world coordinates).
 
VECTOR2D dragOriginScreen
 Point where dragging has started (in screen coordinates).
 
VECTOR2D downPosition
 Point where click event has occurred.
 
TOOL_MOUSE_BUTTONS button
 Determines the mouse button for which information are stored.
 
wxEventType downEvent
 The type of wxEvent that determines mouse button press.
 
wxEventType upEvent
 The type of wxEvent that determines mouse button release.
 
wxEventType dblClickEvent
 The type of wxEvent that determines mouse button double click.
 
wxLongLong downTimestamp
 Time stamp for the last mouse button press event.
 

Detailed Description

Store information about a mouse button state.

Definition at line 52 of file tool_dispatcher.cpp.

Constructor & Destructor Documentation

◆ BUTTON_STATE()

TOOL_DISPATCHER::BUTTON_STATE::BUTTON_STATE ( TOOL_MOUSE_BUTTONS  aButton,
const wxEventType &  aDownEvent,
const wxEventType &  aUpEvent,
const wxEventType &  aDblClickEvent 
)
inline

Definition at line 54 of file tool_dispatcher.cpp.

Member Function Documentation

◆ GetState()

bool TOOL_DISPATCHER::BUTTON_STATE::GetState ( ) const
inline

Checks the current state of the button.

Definition at line 102 of file tool_dispatcher.cpp.

References BUT_AUX1, BUT_AUX2, BUT_LEFT, BUT_MIDDLE, BUT_RIGHT, and button.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ Reset()

void TOOL_DISPATCHER::BUTTON_STATE::Reset ( )
inline

Restores initial state.

Definition at line 95 of file tool_dispatcher.cpp.

References dragging, and pressed.

Member Data Documentation

◆ button

TOOL_MOUSE_BUTTONS TOOL_DISPATCHER::BUTTON_STATE::button

Determines the mouse button for which information are stored.

Definition at line 80 of file tool_dispatcher.cpp.

Referenced by GetState(), and TOOL_DISPATCHER::handleMouseButton().

◆ dblClickEvent

wxEventType TOOL_DISPATCHER::BUTTON_STATE::dblClickEvent

The type of wxEvent that determines mouse button double click.

Definition at line 89 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ downEvent

wxEventType TOOL_DISPATCHER::BUTTON_STATE::downEvent

The type of wxEvent that determines mouse button press.

Definition at line 83 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ downPosition

VECTOR2D TOOL_DISPATCHER::BUTTON_STATE::downPosition

Point where click event has occurred.

Definition at line 77 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ downTimestamp

wxLongLong TOOL_DISPATCHER::BUTTON_STATE::downTimestamp

Time stamp for the last mouse button press event.

Definition at line 92 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ dragging

bool TOOL_DISPATCHER::BUTTON_STATE::dragging

Flag indicating that dragging is active for the given button.

Definition at line 65 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton(), and Reset().

◆ dragOrigin

VECTOR2D TOOL_DISPATCHER::BUTTON_STATE::dragOrigin

Point where dragging has started (in world coordinates).

Definition at line 71 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ dragOriginScreen

VECTOR2D TOOL_DISPATCHER::BUTTON_STATE::dragOriginScreen

Point where dragging has started (in screen coordinates).

Definition at line 74 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton().

◆ pressed

bool TOOL_DISPATCHER::BUTTON_STATE::pressed

Flag indicating that the given button is pressed.

Definition at line 68 of file tool_dispatcher.cpp.

Referenced by TOOL_DISPATCHER::handleMouseButton(), and Reset().

◆ upEvent

wxEventType TOOL_DISPATCHER::BUTTON_STATE::upEvent

The type of wxEvent that determines mouse button release.

Definition at line 86 of file tool_dispatcher.cpp.

The documentation for this struct was generated from the following file: