xkb_event_pointer_button Struct Reference

#include <xkbcommon.h>

Data Fields
uint32_t	size
uint32_t	button
uint8_t	count
uint8_t	state

Private Attributes
uint8_t	reserved0 [2]

Detailed Description

Description of a pointer button action.

Note

This struct uses a size-based versioning; see Extensible structure ABI contract for further details.

See also

xkb_event::xkb_event_get_pointer_button()

XKB_EVENT_TYPE_POINTER_BUTTON

Since

1.14.0

Field Documentation

size

uint32_t xkb_event_pointer_button::size

Size of this structure in bytes.

See also

Extensible structure ABI contract

Since

1.14.0

button

uint32_t xkb_event_pointer_button::button

Button index.

Since

1.14.0

count

uint8_t xkb_event_pointer_button::count

Number of clicks reported in this single event.

• 0 denotes a plain press/release described in #state.

• A value greater than 0 denotes a complete press-release cycle: 1 for a single click, 2 for a double-click, etc.

  Timing considerations (e.g. durations between each atomic button state change) are the responsibility of the display server.

Since

1.14.0

state

uint8_t xkb_event_pointer_button::state

Button state.

Meaningful only when #count is 0.

See also

enum xkb_pointer_button_state

Since

1.14.0

reserved0

uint8_t xkb_event_pointer_button::reserved0[2]

private

Reserved for future extensions.

Precondition

Must be set to 0 by the caller.

---

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

• include/xkbcommon/xkbcommon.h