itycodes
/
wlseeds
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

wlr_seat: Declare functions in the same order for pointer, keyboard, and touch

Browse Source 
These three APIs are very similar to one another, but they all had
slightly different function orderings. For consistency, always declare
the non_`notify` functions first, then the `notify` functions, then
`{start,end,has}_grab`.

This change has no functional effect.
master
Thomas Hebb 5 years ago committed by Simon Ser
parent 8f28f5b2f8
commit e8c00e918a
1 changed files with 77 additions and 77 deletions
Show Stats Download Patch File Download Diff File

154
include/wlr/types/wlr_seat.h
Unescape View File

@ -391,19 +391,6 @@ void wlr_seat_pointer_send_axis(struct wlr_seat *wlr_seat, uint32_t time_msec,
*/ */
void wlr_seat_pointer_send_frame(struct wlr_seat *wlr_seat); void wlr_seat_pointer_send_frame(struct wlr_seat *wlr_seat);
/**
* Start a grab of the pointer of this seat. The grabber is responsible for
* handling all pointer events until the grab ends.
*/
void wlr_seat_pointer_start_grab(struct wlr_seat *wlr_seat,
struct wlr_seat_pointer_grab *grab);
/**
* End the grab of the pointer of this seat. This reverts the grab back to the
* default grab for the pointer.
*/
void wlr_seat_pointer_end_grab(struct wlr_seat *wlr_seat);
/** /**
* Notify the seat of a pointer enter event to the given surface and request it * Notify the seat of a pointer enter event to the given surface and request it
* to be the focused surface for the pointer. Pass surface-local coordinates * to be the focused surface for the pointer. Pass surface-local coordinates
@ -441,32 +428,32 @@ void wlr_seat_pointer_notify_axis(struct wlr_seat *wlr_seat, uint32_t time_msec,
void wlr_seat_pointer_notify_frame(struct wlr_seat *wlr_seat); void wlr_seat_pointer_notify_frame(struct wlr_seat *wlr_seat);
/** /**
* Whether or not the pointer has a grab other than the default grab. * Start a grab of the pointer of this seat. The grabber is responsible for
* handling all pointer events until the grab ends.
*/ */
bool wlr_seat_pointer_has_grab(struct wlr_seat *seat); void wlr_seat_pointer_start_grab(struct wlr_seat *wlr_seat,
struct wlr_seat_pointer_grab *grab);
/** /**
* Set this keyboard as the active keyboard for the seat. * End the grab of the pointer of this seat. This reverts the grab back to the
* default grab for the pointer.
*/ */
void wlr_seat_set_keyboard(struct wlr_seat *seat, struct wlr_input_device *dev); void wlr_seat_pointer_end_grab(struct wlr_seat *wlr_seat);
/** /**
* Get the active keyboard for the seat. * Whether or not the pointer has a grab other than the default grab.
*/ */
struct wlr_keyboard *wlr_seat_get_keyboard(struct wlr_seat *seat); bool wlr_seat_pointer_has_grab(struct wlr_seat *seat);
/** /**
* Start a grab of the keyboard of this seat. The grabber is responsible for * Set this keyboard as the active keyboard for the seat.
* handling all keyboard events until the grab ends.
*/ */
void wlr_seat_keyboard_start_grab(struct wlr_seat *wlr_seat, void wlr_seat_set_keyboard(struct wlr_seat *seat, struct wlr_input_device *dev);
struct wlr_seat_keyboard_grab *grab);
/** /**
* End the grab of the keyboard of this seat. This reverts the grab back to the * Get the active keyboard for the seat.
* default grab for the keyboard.
*/ */
void wlr_seat_keyboard_end_grab(struct wlr_seat *wlr_seat); struct wlr_keyboard *wlr_seat_get_keyboard(struct wlr_seat *seat);
/** /**
* Send the keyboard key to focused keyboard resources. Compositors should use * Send the keyboard key to focused keyboard resources. Compositors should use
@ -475,13 +462,6 @@ void wlr_seat_keyboard_end_grab(struct wlr_seat *wlr_seat);
void wlr_seat_keyboard_send_key(struct wlr_seat *seat, uint32_t time_msec, void wlr_seat_keyboard_send_key(struct wlr_seat *seat, uint32_t time_msec,
uint32_t key, uint32_t state); uint32_t key, uint32_t state);
/**
* Notify the seat that a key has been pressed on the keyboard. Defers to any
* keyboard grabs.
*/
void wlr_seat_keyboard_notify_key(struct wlr_seat *seat, uint32_t time_msec,
uint32_t key, uint32_t state);
/** /**
* Send the modifier state to focused keyboard resources. Compositors should use * Send the modifier state to focused keyboard resources. Compositors should use
* `wlr_seat_keyboard_notify_modifiers()` to respect any keyboard grabs. * `wlr_seat_keyboard_notify_modifiers()` to respect any keyboard grabs.
@ -489,22 +469,6 @@ void wlr_seat_keyboard_notify_key(struct wlr_seat *seat, uint32_t time_msec,
void wlr_seat_keyboard_send_modifiers(struct wlr_seat *seat, void wlr_seat_keyboard_send_modifiers(struct wlr_seat *seat,
struct wlr_keyboard_modifiers *modifiers); struct wlr_keyboard_modifiers *modifiers);
/**
* Notify the seat that the modifiers for the keyboard have changed. Defers to
* any keyboard grabs.
*/
void wlr_seat_keyboard_notify_modifiers(struct wlr_seat *seat,
struct wlr_keyboard_modifiers *modifiers);
/**
* Notify the seat that the keyboard focus has changed and request it to be the
* focused surface for this keyboard. Defers to any current grab of the seat's
* keyboard.
*/
void wlr_seat_keyboard_notify_enter(struct wlr_seat *seat,
struct wlr_surface *surface, uint32_t keycodes[], size_t num_keycodes,
struct wlr_keyboard_modifiers *modifiers);
/** /**
* Send a keyboard enter event to the given surface and consider it to be the * Send a keyboard enter event to the given surface and consider it to be the
* focused surface for the keyboard. This will send a leave event to the last * focused surface for the keyboard. This will send a leave event to the last
@ -522,53 +486,52 @@ void wlr_seat_keyboard_enter(struct wlr_seat *seat,
void wlr_seat_keyboard_clear_focus(struct wlr_seat *wlr_seat); void wlr_seat_keyboard_clear_focus(struct wlr_seat *wlr_seat);
/** /**
* Whether or not the keyboard has a grab other than the default grab * Notify the seat that a key has been pressed on the keyboard. Defers to any
* keyboard grabs.
*/ */
bool wlr_seat_keyboard_has_grab(struct wlr_seat *seat); void wlr_seat_keyboard_notify_key(struct wlr_seat *seat, uint32_t time_msec,
uint32_t key, uint32_t state);
/** /**
* Start a grab of the touch device of this seat. The grabber is responsible for * Notify the seat that the modifiers for the keyboard have changed. Defers to
* handling all touch events until the grab ends. * any keyboard grabs.
*/ */
void wlr_seat_touch_start_grab(struct wlr_seat *wlr_seat, void wlr_seat_keyboard_notify_modifiers(struct wlr_seat *seat,
struct wlr_seat_touch_grab *grab); struct wlr_keyboard_modifiers *modifiers);
/** /**
* End the grab of the touch device of this seat. This reverts the grab back to * Notify the seat that the keyboard focus has changed and request it to be the
* the default grab for the touch device. * focused surface for this keyboard. Defers to any current grab of the seat's
* keyboard.
*/ */
void wlr_seat_touch_end_grab(struct wlr_seat *wlr_seat); void wlr_seat_keyboard_notify_enter(struct wlr_seat *seat,
struct wlr_surface *surface, uint32_t keycodes[], size_t num_keycodes,
struct wlr_keyboard_modifiers *modifiers);
/** /**
* Get the active touch point with the given `touch_id`. If the touch point does * Start a grab of the keyboard of this seat. The grabber is responsible for
* not exist or is no longer active, returns NULL. * handling all keyboard events until the grab ends.
*/ */
struct wlr_touch_point *wlr_seat_touch_get_point(struct wlr_seat *seat, void wlr_seat_keyboard_start_grab(struct wlr_seat *wlr_seat,
int32_t touch_id); struct wlr_seat_keyboard_grab *grab);
/** /**
* Notify the seat of a touch down on the given surface. Defers to any grab of * End the grab of the keyboard of this seat. This reverts the grab back to the
* the touch device. * default grab for the keyboard.
*/ */
uint32_t wlr_seat_touch_notify_down(struct wlr_seat *seat, void wlr_seat_keyboard_end_grab(struct wlr_seat *wlr_seat);
struct wlr_surface *surface, uint32_t time_msec,
int32_t touch_id, double sx, double sy);
/** /**
* Notify the seat that the touch point given by `touch_id` is up. Defers to any * Whether or not the keyboard has a grab other than the default grab
* grab of the touch device.
*/ */
void wlr_seat_touch_notify_up(struct wlr_seat *seat, uint32_t time_msec, bool wlr_seat_keyboard_has_grab(struct wlr_seat *seat);
int32_t touch_id);
/** /**
* Notify the seat that the touch point given by `touch_id` has moved. Defers to * Get the active touch point with the given `touch_id`. If the touch point does
* any grab of the touch device. The seat should be notified of touch motion * not exist or is no longer active, returns NULL.
* even if the surface is not the owner of the touch point for processing by
* grabs.
*/ */
void wlr_seat_touch_notify_motion(struct wlr_seat *seat, uint32_t time_msec, struct wlr_touch_point *wlr_seat_touch_get_point(struct wlr_seat *seat,
int32_t touch_id, double sx, double sy); int32_t touch_id);
/** /**
* Notify the seat that the touch point given by `touch_id` has entered a new * Notify the seat that the touch point given by `touch_id` has entered a new
@ -615,11 +578,48 @@ void wlr_seat_touch_send_up(struct wlr_seat *seat, uint32_t time_msec,
void wlr_seat_touch_send_motion(struct wlr_seat *seat, uint32_t time_msec, void wlr_seat_touch_send_motion(struct wlr_seat *seat, uint32_t time_msec,
int32_t touch_id, double sx, double sy); int32_t touch_id, double sx, double sy);
/**
* Notify the seat of a touch down on the given surface. Defers to any grab of
* the touch device.
*/
uint32_t wlr_seat_touch_notify_down(struct wlr_seat *seat,
struct wlr_surface *surface, uint32_t time_msec,
int32_t touch_id, double sx, double sy);
/**
* Notify the seat that the touch point given by `touch_id` is up. Defers to any
* grab of the touch device.
*/
void wlr_seat_touch_notify_up(struct wlr_seat *seat, uint32_t time_msec,
int32_t touch_id);
/**
* Notify the seat that the touch point given by `touch_id` has moved. Defers to
* any grab of the touch device. The seat should be notified of touch motion
* even if the surface is not the owner of the touch point for processing by
* grabs.
*/
void wlr_seat_touch_notify_motion(struct wlr_seat *seat, uint32_t time_msec,
int32_t touch_id, double sx, double sy);
/** /**
* How many touch points are currently down for the seat. * How many touch points are currently down for the seat.
*/ */
int wlr_seat_touch_num_points(struct wlr_seat *seat); int wlr_seat_touch_num_points(struct wlr_seat *seat);
/**
* Start a grab of the touch device of this seat. The grabber is responsible for
* handling all touch events until the grab ends.
*/
void wlr_seat_touch_start_grab(struct wlr_seat *wlr_seat,
struct wlr_seat_touch_grab *grab);
/**
* End the grab of the touch device of this seat. This reverts the grab back to
* the default grab for the touch device.
*/
void wlr_seat_touch_end_grab(struct wlr_seat *wlr_seat);
/** /**
* Whether or not the seat has a touch grab other than the default grab. * Whether or not the seat has a touch grab other than the default grab.
*/ */

Write Preview
Loading…
Cancel
Save