v1::mouse_event Struct Reference

Public Types
enum class	Type {   None , Entered , Exited , Move ,   Drag , ButtonDown , ButtonUp , Wheel }

Public Member Functions
bool	empty () const noexcept
	operator bool () const noexcept
bool	is_left_button_up (aarectangle active_area) const noexcept
	Check if this event is for a left-button-up event while the mouse pointer is in the given area.
vector2	delta () const noexcept
	Get the location of the mouse relative to the start of a drag.

Static Public Member Functions
static mouse_event	entered (point2 position={}) noexcept
static mouse_event	exited () noexcept

Data Fields
Type	type
std::chrono::utc_time< std::chrono::nanoseconds >	timePoint
point2	position
	The current position of the mouse pointer.
point2	downPosition
	The position the last time a button was pressed.
vector2	wheelDelta
	Change in wheel rotation, in pixels.
mouse_buttons	cause
	Buttons which has caused this event.
mouse_buttons	down
	Buttons that are pressed/held down.
int	clickCount
	Number of clicks from the last button clicked.

Friends
mouse_event	operator* (geo::transformer auto const &transform, mouse_event const &rhs) noexcept
std::string	to_string (mouse_event const &rhs) noexcept
std::ostream &	operator<< (std::ostream &lhs, mouse_event const &rhs)

Member Function Documentation

delta()

vector2 v1::mouse_event::delta ( ) const

inlinenoexcept

Get the location of the mouse relative to the start of a drag.

is_left_button_up()

bool v1::mouse_event::is_left_button_up ( aarectangle active_area ) const

inlinenoexcept

Check if this event is for a left-button-up event while the mouse pointer is in the given area.

Field Documentation

cause

mouse_buttons v1::mouse_event::cause

Buttons which has caused this event.

clickCount

int v1::mouse_event::clickCount

Number of clicks from the last button clicked.

down

mouse_buttons v1::mouse_event::down

Buttons that are pressed/held down.

downPosition

point2 v1::mouse_event::downPosition

The position the last time a button was pressed.

position

point2 v1::mouse_event::position

The current position of the mouse pointer.

wheelDelta

vector2 v1::mouse_event::wheelDelta

Change in wheel rotation, in pixels.

---

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

• hikogui/src/hikogui/GUI/mouse_event.hpp