Ecore_Wl2_Input_Group(3)

NAME
Ecore_Wl2_Input_Group - Wayland Library Input Functions

 - Functions that deal with creating, destroying, or interacting with Wayland Input.

SYNOPSIS

  Functions
EAPI struct wl_seat * ecore_wl2_input_seat_get (Ecore_Wl2_Input *input)
Get the wl_seat that an input is using.
EAPI Ecore_Wl2_Seat_Capabilities ecore_wl2_input_seat_capabilities_get (Ecore_Wl2_Input *input)
Get the seat capabilities for a given input.
EAPI unsigned int ecore_wl2_input_seat_id_get (Ecore_Wl2_Input *input)
Get the wayland's seat id from an input.
EAPI Ecore_Wl2_Display * ecore_wl2_input_display_get (const Ecore_Wl2_Input *input)
Get the display object of an input.
EAPI struct xkb_keymap * ecore_wl2_input_keymap_get (const Ecore_Wl2_Input *input)
Get the xkb_keymap object of an input.
EAPI Eina_Stringshare * ecore_wl2_input_name_get (Ecore_Wl2_Input *input)
Get the name of an input.
EAPI Eina_Bool ecore_wl2_input_keyboard_repeat_get (const Ecore_Wl2_Input *input, double *rate, double *delay)
Get the keyboard repeat rate and delay of an input.
EAPI Eina_Bool ecore_wl2_input_keyboard_repeat_set (Ecore_Wl2_Input *input, double rate, double delay)
Set the keyboard repeat rate and delay of an input.
EAPI Eina_Bool ecore_wl2_input_pointer_xy_get (const Ecore_Wl2_Input *input, int *x, int *y)
Retrieves the mouse position of the seat.
EAPI void ecore_wl2_input_pointer_set (Ecore_Wl2_Input *input, struct wl_surface *surface, int hot_x, int hot_y)
Set a given wl_surface to use as the pointer on a seat.
EAPI void ecore_wl2_input_cursor_from_name_set (Ecore_Wl2_Input *input, const char *cursor)
Set a specific cursor on a given seat.
EAPI Ecore_Wl2_Input * ecore_wl2_input_default_input_get (const Ecore_Wl2_Display *ewd)
Gets default input of a given display.

Detailed Description

Functions that deal with creating, destroying, or interacting with Wayland Input.

Function Documentation

  EAPI struct wl_seat* ecore_wl2_input_seat_get (Ecore_Wl2_Input * input)

Get the wl_seat that an input is using.

Parameters
    input The Ecore_Wl2_Input to get the seat of

Returns
    The wl_seat of this input, or NULL otherwise

Since
    1.17

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  EAPI Ecore_Wl2_Seat_Capabilities ecore_wl2_input_seat_capabilities_get (Ecore_Wl2_Input * input)

Get the seat capabilities for a given input.

Parameters
    input The input

Since
    1.19

  EAPI unsigned int ecore_wl2_input_seat_id_get (Ecore_Wl2_Input * input)

Get the wayland's seat id from an input.

Parameters
    input The input

Returns
    The seat id

Since
    1.19

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  EAPI Ecore_Wl2_Display* ecore_wl2_input_display_get (const Ecore_Wl2_Input * input)

Get the display object of an input.

Parameters
    input The input

Returns
    The display

Since
    1.20

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  EAPI struct xkb_keymap* ecore_wl2_input_keymap_get (const Ecore_Wl2_Input * input)

Get the xkb_keymap object of an input.

Parameters
    input The input

Returns
    The xkb_keymap object

Since
    1.20

References EINA_SAFETY_ON_FALSE_RETURN_VAL, and EINA_SAFETY_ON_NULL_RETURN_VAL.

  EAPI Eina_Stringshare* ecore_wl2_input_name_get (Ecore_Wl2_Input * input)

Get the name of an input.

Parameters
    input The input

Returns
    The name

Since
    1.20

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  EAPI Eina_Bool ecore_wl2_input_keyboard_repeat_get (const Ecore_Wl2_Input * input, double * rate, double * delay)

Get the keyboard repeat rate and delay of an input.

Parameters
    input The input
    rate Pointer to store the repeat rate (in seconds)
    rate Pointer to store the repeat delay (in seconds)

Returns
    True if repeat is enabled

Since
    1.20

References EINA_FALSE, EINA_SAFETY_ON_FALSE_RETURN_VAL, and EINA_SAFETY_ON_NULL_RETURN_VAL.

  EAPI Eina_Bool ecore_wl2_input_keyboard_repeat_set (Ecore_Wl2_Input * input, double rate, double delay)

Set the keyboard repeat rate and delay of an input.

Parameters
    input The input
    rate Pointer to store the repeat rate (in seconds)
    rate Pointer to store the repeat delay (in seconds)

Returns
    True if repeat is enabled

Since
    1.24

References EINA_FALSE, EINA_SAFETY_ON_FALSE_RETURN_VAL, EINA_SAFETY_ON_NULL_RETURN_VAL, and EINA_TRUE.

  EAPI Eina_Bool ecore_wl2_input_pointer_xy_get (const Ecore_Wl2_Input * input, int * x, int * y)

Retrieves the mouse position of the seat.

Parameters
    input The seat
    x where to return the horizontal position. May be NULL. Returns 0 on error.
    y where to return the vertical position. May be NULL. Returns 0 on error.

Returns
    EINA_TRUE if coords were successfully retrieved

Since
    1.20

References EINA_FALSE, EINA_SAFETY_ON_NULL_RETURN_VAL, and EINA_TRUE.

  EAPI void ecore_wl2_input_pointer_set (Ecore_Wl2_Input * input, struct wl_surface * surface, int hot_x, int hot_y)

Set a given wl_surface to use as the pointer on a seat.

Parameters
    input The seat to set this surface as the pointer on
    surface The surface to use as the pointer
    hot_x The x coordinate to use as the cursor hot spot
    hot_y The y coordinate to use as the cursor hot spot

Since
    1.20

References EINA_SAFETY_ON_NULL_RETURN.

  EAPI void ecore_wl2_input_cursor_from_name_set (Ecore_Wl2_Input * input, const char * cursor)

Set a specific cursor on a given seat. This function will try to find a matching cursor inside the existing cursor theme and set the pointer for the specified seat to be the specified cursor

Parameters
    input The seat to set the cursor on
    cursor The name of the cursor to try and set

Since
    1.20

References EINA_SAFETY_ON_NULL_RETURN.

Referenced by ecore_wl2_dnd_drag_start().

  EAPI Ecore_Wl2_Input* ecore_wl2_input_default_input_get (const Ecore_Wl2_Display * ewd)

Gets default input of a given display.

Parameters
    ewd The display

Since
    1.24

References ecore_wl2_display_input_find_by_name(), and EINA_SAFETY_ON_NULL_RETURN_VAL.

Author

Generated automatically by Doxygen for EFL from the source code.