hi::v1::mouse_event_data Struct Reference

#include <hikogui/GUI/gui_event.hpp>

Data Fields
hi::hitbox	hitbox = {}
	Information about which widget is underneath the mouse pointer.
point2	position = {}
	The current position of the mouse pointer.
point2	down_position = {}
	The position the last time a button was pressed.
vector2	wheel_delta = {}
	Change in wheel rotation, in points (pt).
mouse_buttons	cause = {}
	Buttons which have caused this event.
mouse_buttons	down = {}
	Buttons that are also held down.
uint8_t	click_count = 0
	Number of clicks from the last button clicked.

Detailed Description

Information for a mouse event.

Field Documentation

cause

mouse_buttons hi::v1::mouse_event_data::cause = {}

Buttons which have caused this event.

click_count

uint8_t hi::v1::mouse_event_data::click_count = 0

Number of clicks from the last button clicked.

down

mouse_buttons hi::v1::mouse_event_data::down = {}

Buttons that are also held down.

down_position

point2 hi::v1::mouse_event_data::down_position = {}

The position the last time a button was pressed.

This can be used as the position at the start of a drag event.

Note

The event system will convert these in widget-local coordinates.

hitbox

hi::hitbox hi::v1::mouse_event_data::hitbox = {}

Information about which widget is underneath the mouse pointer.

position

point2 hi::v1::mouse_event_data::position = {}

The current position of the mouse pointer.

Note

The event system will convert these in widget-local coordinates.

wheel_delta

vector2 hi::v1::mouse_event_data::wheel_delta = {}

Change in wheel rotation, in points (pt).

Some mice have two dimensional mouse wheels.

---

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

• hikogui/src/hikogui/GUI/gui_event.hpp