gigawidgets 0.3.55
A wxWidgets-style UI library for the Arduino Giga Display Shield.
 
Loading...
Searching...
No Matches
ui::EventHandlers< T > Class Template Reference

Extended definitions for widget event handler functions. More...

#include <event_handlers.hpp>

Inheritance diagram for ui::EventHandlers< T >:
ui::CoreEventHandlers< T >

Public Member Functions

void onpress (std::function< void(T &)> callback)
 Register a touchscreen event handler that triggers on press.
 
void onpress (std::function< void(const Event &)> callback)
 Register a touchscreen event handler that triggers on press.
 
void onpress (std::function< void()> callback)
 Register a touchscreen event handler that triggers on press.
 
void onrelease (std::function< void(T &)> callback)
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
void onrelease (std::function< void(const Event &)> callback)
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
void onrelease (std::function< void()> callback)
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
void onblur (std::function< void(T &)> callback)
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
void onblur (std::function< void(const Event &)> callback)
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
void onblur (std::function< void()> callback)
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
void onhold (std::function< void(T &, time_t)> callback)
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onhold (std::function< void(const Event &, time_t)> callback)
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onhold (std::function< void(time_t)> callback)
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onhold (std::function< void(T &)> callback)
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onhold (std::function< void(const Event &)> callback)
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onhold (std::function< void()> callback)
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onclick (std::function< void(T &)> callback)
 Register a touchscreen event handler that triggers on release.
 
void onclick (std::function< void(const Event &)> callback)
 Register a touchscreen event handler that triggers on release.
 
void onclick (std::function< void()> callback)
 Register a touchscreen event handler that triggers on release.
 
- Public Member Functions inherited from ui::CoreEventHandlers< T >
virtual void onpress (std::function< void(T &, const Event &)> callback)=0
 Register a touchscreen event handler that triggers on press.
 
virtual void onrelease (std::function< void(T &, const Event &)> callback)=0
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
virtual void onblur (std::function< void(T &, const Event &)> callback)=0
 Register a touchscreen event handler that triggers when the widget stops being pressed.
 
virtual void onhold (std::function< void(T &, const Event &, time_t)> callback)=0
 Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.
 
void onclick (std::function< void(T &, const Event &)> callback)
 Register a touchscreen event handler that triggers on release.
 

Detailed Description

template<class T>
class ui::EventHandlers< T >

Extended definitions for widget event handler functions.

Template Parameters
TThe derived class.

Member Function Documentation

◆ onblur() [1/3]

template<class T >
void ui::EventHandlers< T >::onblur ( std::function< void()>  callback)
inline

Register a touchscreen event handler that triggers when the widget stops being pressed.

Parameters
callbackA callback function that is called when a widget stops being pressed after previously receiving a "press" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onblur() [2/3]

template<class T >
void ui::EventHandlers< T >::onblur ( std::function< void(const Event &)>  callback)
inline

Register a touchscreen event handler that triggers when the widget stops being pressed.

Parameters
callbackA callback function that is called when a widget stops being pressed after previously receiving a "press" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onblur() [3/3]

template<class T >
void ui::EventHandlers< T >::onblur ( std::function< void(T &)>  callback)
inline

Register a touchscreen event handler that triggers when the widget stops being pressed.

Parameters
callbackA callback function that is called when a widget stops being pressed after previously receiving a "press" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onclick() [1/3]

template<class T >
void ui::EventHandlers< T >::onclick ( std::function< void()>  callback)
inline

Register a touchscreen event handler that triggers on release.

This is identical to the onrelease() function.

Parameters
callbackA callback function that is called when this widget receives a "release" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onclick() [2/3]

template<class T >
void ui::EventHandlers< T >::onclick ( std::function< void(const Event &)>  callback)
inline

Register a touchscreen event handler that triggers on release.

This is identical to the onrelease() function.

Parameters
callbackA callback function that is called when this widget receives a "release" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onclick() [3/3]

template<class T >
void ui::EventHandlers< T >::onclick ( std::function< void(T &)>  callback)
inline

Register a touchscreen event handler that triggers on release.

This is identical to the onrelease() function.

Parameters
callbackA callback function that is called when this widget receives a "release" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onhold() [1/6]

template<class T >
void ui::EventHandlers< T >::onhold ( std::function< void()>  callback)
inline

Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.

Parameters
callbackA callback function that is called when this widget has been continuously pressed for a while.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onhold() [2/6]

template<class T >
void ui::EventHandlers< T >::onhold ( std::function< void(const Event &)>  callback)
inline

Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.

Parameters
callbackA callback function that is called when this widget has been continuously pressed for a while.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onhold() [3/6]

template<class T >
void ui::EventHandlers< T >::onhold ( std::function< void(const Event &, time_t)>  callback)
inline

Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.

Parameters
callbackA callback function that is called when this widget has been continuously pressed for a while.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onhold() [4/6]

template<class T >
void ui::EventHandlers< T >::onhold ( std::function< void(T &)>  callback)
inline

Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.

Parameters
callbackA callback function that is called when this widget has been continuously pressed for a while.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onhold() [5/6]

template<class T >
void ui::EventHandlers< T >::onhold ( std::function< void(T &, time_t)>  callback)
inline

Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.

Parameters
callbackA callback function that is called when this widget has been continuously pressed for a while.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onhold() [6/6]

template<class T >
void ui::EventHandlers< T >::onhold ( std::function< void(time_t)>  callback)
inline

Register a touchscreen event handler that repeatedly triggers when the widget is held for a while.

Parameters
callbackA callback function that is called when this widget has been continuously pressed for a while.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onpress() [1/3]

template<class T >
void ui::EventHandlers< T >::onpress ( std::function< void()>  callback)
inline

Register a touchscreen event handler that triggers on press.

Parameters
callbackA callback function that is called when this widget receives a "press" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onpress() [2/3]

template<class T >
void ui::EventHandlers< T >::onpress ( std::function< void(const Event &)>  callback)
inline

Register a touchscreen event handler that triggers on press.

Parameters
callbackA callback function that is called when this widget receives a "press" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onpress() [3/3]

template<class T >
void ui::EventHandlers< T >::onpress ( std::function< void(T &)>  callback)
inline

Register a touchscreen event handler that triggers on press.

Parameters
callbackA callback function that is called when this widget receives a "press" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onrelease() [1/3]

template<class T >
void ui::EventHandlers< T >::onrelease ( std::function< void()>  callback)
inline

Register a touchscreen event handler that triggers when the widget stops being pressed.

Parameters
callbackA callback function that is called when this widget receives a "release" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onrelease() [2/3]

template<class T >
void ui::EventHandlers< T >::onrelease ( std::function< void(const Event &)>  callback)
inline

Register a touchscreen event handler that triggers when the widget stops being pressed.

Parameters
callbackA callback function that is called when this widget receives a "release" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

◆ onrelease() [3/3]

template<class T >
void ui::EventHandlers< T >::onrelease ( std::function< void(T &)>  callback)
inline

Register a touchscreen event handler that triggers when the widget stops being pressed.

Parameters
callbackA callback function that is called when this widget receives a "release" event.
Note
Only one event handler for each type of event (press, hold, release, blur) is allowed per widget.

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