MouseGesture Class Reference

Basic class for interpreting mouse events. More...

#include <mousegesture.h>

Public Types
using	MouseCallback = std::function< void(Event &event)>
	Type for mouse event callback.

Public Member Functions
	MouseGesture () noexcept
EGT_NODISCARD bool	active () const
	Is active?
EGT_NODISCARD bool	dragging () const
	Is dragging?
Event	handle (const Event &event)
	Pass the raw EventId to this function to get the emulated mouse event.
EGT_NODISCARD const DisplayPoint &	mouse_start () const
	Get pointer start position.
void	on_async_event (MouseCallback callback)
	Register a callback function to handle the async mouse events.
void	start (const DisplayPoint &point)
	Start.
void	stop ()
	Stop any active dragging state.

Static Public Member Functions
static EGT_NODISCARD DefaultDim	drag_enable_distance ()
	Get the distance to travel to enable the drag mode.
static void	drag_enable_distance (DefaultDim distance)
	Set the distance to travel to enable the drag mode.

Protected Types
using	CallbackArray = std::vector< MouseCallback >
	Type for array of registered callbacks.

Protected Member Functions
void	invoke_handlers (Event &event)
	Invoke an event on each of the handlers.

Protected Attributes
bool	m_active {false}
	Currently processing subsequent events.
CallbackArray	m_callbacks
	Registered callback functions.
bool	m_dragging {false}
	Currently in the dragging state.
bool	m_holding {false}
	Currently in the holding state.
PeriodicTimer	m_long_click_timer
	Async timer for detecting long clicks.
DisplayPoint	m_mouse_start_pos
	The starting position of the mouse.

Static Protected Attributes
static DefaultDim	m_drag_enable_distance
	Cursor distance to enable the drag mode.

Detailed Description

Basic class for interpreting mouse events.

For now, this only supports single mouse click, long click, and drag events. The premise behind this class is to interpret raw mouse events and turn them into higher level meaning. Because some of those events can be asynchronous, all events are generated through callbacks registered with on_async_event().

Member Typedef Documentation

CallbackArray

using CallbackArray = std::vector<MouseCallback>

protected

Type for array of registered callbacks.

MouseCallback

using MouseCallback = std::function<void(Event& event)>

Type for mouse event callback.

Constructor & Destructor Documentation

MouseGesture()

MouseGesture ( )

noexcept

Member Function Documentation

active()

EGT_NODISCARD bool active ( ) const

inline

Is active?

drag_enable_distance() [1/2]

static EGT_NODISCARD DefaultDim drag_enable_distance ( )

inlinestatic

Get the distance to travel to enable the drag mode.

drag_enable_distance() [2/2]

static void drag_enable_distance ( DefaultDim  distance )

inlinestatic

Set the distance to travel to enable the drag mode.

dragging()

EGT_NODISCARD bool dragging ( ) const

inline

Is dragging?

handle()

Event handle

(

const Event &

event

)

Pass the raw EventId to this function to get the emulated mouse event.

invoke_handlers()

void invoke_handlers ( Event &  event )

protected

Invoke an event on each of the handlers.

mouse_start()

EGT_NODISCARD const DisplayPoint & mouse_start ( ) const

inline

Get pointer start position.

on_async_event()

void on_async_event

(

MouseCallback

callback

)

Register a callback function to handle the async mouse events.

start()

void start

(

const DisplayPoint &

point

)

Start.

stop()

void stop

(

)

Stop any active dragging state.

Member Data Documentation

m_active

bool m_active {false}

protected

Currently processing subsequent events.

m_callbacks

CallbackArray m_callbacks

protected

Registered callback functions.

m_drag_enable_distance

DefaultDim m_drag_enable_distance

staticprotected

Cursor distance to enable the drag mode.

m_dragging

bool m_dragging {false}

protected

Currently in the dragging state.

m_holding

bool m_holding {false}

protected

Currently in the holding state.

m_long_click_timer

PeriodicTimer m_long_click_timer

protected

Async timer for detecting long clicks.

m_mouse_start_pos

DisplayPoint m_mouse_start_pos

protected

The starting position of the mouse.