phosh-private-client-protocol

phosh-private-client-protocol

Functions

Types and Values

#define PHOSH_PRIVATE_ERROR_ENUM
enum phosh_private_error
#define PHOSH_PRIVATE_ROTATE_DISPLAY
#define PHOSH_PRIVATE_GET_XDG_SWITCHER
#define PHOSH_PRIVATE_GET_THUMBNAIL
#define PHOSH_PRIVATE_GET_KEYBOARD_EVENT
#define PHOSH_PRIVATE_ROTATE_DISPLAY_SINCE_VERSION
#define PHOSH_PRIVATE_GET_XDG_SWITCHER_SINCE_VERSION
#define PHOSH_PRIVATE_GET_THUMBNAIL_SINCE_VERSION
#define PHOSH_PRIVATE_GET_KEYBOARD_EVENT_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_ENUM
enum phosh_private_keyboard_event_error
struct phosh_private_keyboard_event_listener
#define PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_ACCELERATOR_REQUEST
#define PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_ACCELERATOR_REQUEST
#define PHOSH_PRIVATE_KEYBOARD_EVENT_DESTROY
#define PHOSH_PRIVATE_KEYBOARD_EVENT_ACCELERATOR_ACTIVATED_EVENT_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_FAILED_EVENT_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_SUCCESS_EVENT_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_FAILED_EVENT_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_SUCCESS_EVENT_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_ACCELERATOR_REQUEST_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_ACCELERATOR_REQUEST_SINCE_VERSION
#define PHOSH_PRIVATE_KEYBOARD_EVENT_DESTROY_SINCE_VERSION
#define PHOSH_PRIVATE_XDG_SWITCHER_ERROR_ENUM
enum phosh_private_xdg_switcher_error
struct phosh_private_xdg_switcher_listener
#define PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES
#define PHOSH_PRIVATE_XDG_SWITCHER_DESTROY
#define PHOSH_PRIVATE_XDG_SWITCHER_RAISE_XDG_SURFACE
#define PHOSH_PRIVATE_XDG_SWITCHER_CLOSE_XDG_SURFACE
#define PHOSH_PRIVATE_XDG_SWITCHER_XDG_SURFACE_SINCE_VERSION
#define PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES_DONE_SINCE_VERSION
#define PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES_SINCE_VERSION
#define PHOSH_PRIVATE_XDG_SWITCHER_DESTROY_SINCE_VERSION
#define PHOSH_PRIVATE_XDG_SWITCHER_RAISE_XDG_SURFACE_SINCE_VERSION
#define PHOSH_PRIVATE_XDG_SWITCHER_CLOSE_XDG_SURFACE_SINCE_VERSION
struct phosh_private
struct phosh_private_keyboard_event
struct phosh_private_xdg_switcher
struct wl_surface
struct zwlr_foreign_toplevel_handle_v1
struct zwlr_screencopy_frame_v1

Description

Functions

phosh_private_set_user_data ()

void
phosh_private_set_user_data (struct phosh_private *phosh_private,
                             void *user_data);

phosh_private_get_user_data ()

void *
phosh_private_get_user_data (struct phosh_private *phosh_private);

phosh_private_get_version ()

uint32_t
phosh_private_get_version (struct phosh_private *phosh_private);

phosh_private_destroy ()

void
phosh_private_destroy (struct phosh_private *phosh_private);

phosh_private_rotate_display ()

void
phosh_private_rotate_display (struct phosh_private *phosh_private,
                              struct wl_surface *surface,
                              uint32_t degree);

phosh_private_get_xdg_switcher ()

struct phosh_private_xdg_switcher *
phosh_private_get_xdg_switcher (struct phosh_private *phosh_private);

phosh_private_get_thumbnail ()

struct zwlr_screencopy_frame_v1 *
phosh_private_get_thumbnail (struct phosh_private *phosh_private,
                             struct zwlr_foreign_toplevel_handle_v1 *toplevel,
                             uint32_t max_width,
                             uint32_t max_height);

phosh_private_get_keyboard_event ()

struct phosh_private_keyboard_event *
phosh_private_get_keyboard_event (struct phosh_private *phosh_private);

phosh_private_keyboard_event_add_listener ()

int
phosh_private_keyboard_event_add_listener
                               (struct phosh_private_keyboard_event *phosh_private_keyboard_event,
                                const struct phosh_private_keyboard_event_listener *listener,
                                void *data);

phosh_private_keyboard_event_set_user_data ()

void
phosh_private_keyboard_event_set_user_data
                               (struct phosh_private_keyboard_event *phosh_private_keyboard_event,
                                void *user_data);

phosh_private_keyboard_event_get_user_data ()

void *
phosh_private_keyboard_event_get_user_data
                               (struct phosh_private_keyboard_event *phosh_private_keyboard_event);

phosh_private_keyboard_event_get_version ()

uint32_t
phosh_private_keyboard_event_get_version
                               (struct phosh_private_keyboard_event *phosh_private_keyboard_event);

phosh_private_keyboard_event_grab_accelerator_request ()

void
phosh_private_keyboard_event_grab_accelerator_request
                               (struct phosh_private_keyboard_event *phosh_private_keyboard_event,
                                const char *accelerator);

phosh_private_keyboard_event_ungrab_accelerator_request ()

void
phosh_private_keyboard_event_ungrab_accelerator_request
                               (struct phosh_private_keyboard_event *phosh_private_keyboard_event,
                                uint32_t action_id);

phosh_private_keyboard_event_destroy ()

void
phosh_private_keyboard_event_destroy (struct phosh_private_keyboard_event *phosh_private_keyboard_event);

phosh_private_xdg_switcher_add_listener ()

int
phosh_private_xdg_switcher_add_listener
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher,
                                const struct phosh_private_xdg_switcher_listener *listener,
                                void *data);

phosh_private_xdg_switcher_set_user_data ()

void
phosh_private_xdg_switcher_set_user_data
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher,
                                void *user_data);

phosh_private_xdg_switcher_get_user_data ()

void *
phosh_private_xdg_switcher_get_user_data
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher);

phosh_private_xdg_switcher_get_version ()

uint32_t
phosh_private_xdg_switcher_get_version
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher);

phosh_private_xdg_switcher_list_xdg_surfaces ()

void
phosh_private_xdg_switcher_list_xdg_surfaces
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher);

phosh_private_xdg_switcher_destroy ()

void
phosh_private_xdg_switcher_destroy (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher);

phosh_private_xdg_switcher_raise_xdg_surface ()

void
phosh_private_xdg_switcher_raise_xdg_surface
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher,
                                const char *app_id,
                                const char *title);

phosh_private_xdg_switcher_close_xdg_surface ()

void
phosh_private_xdg_switcher_close_xdg_surface
                               (struct phosh_private_xdg_switcher *phosh_private_xdg_switcher,
                                const char *app_id,
                                const char *title);

Types and Values

PHOSH_PRIVATE_ERROR_ENUM

#define             PHOSH_PRIVATE_ERROR_ENUM

enum phosh_private_error

Members

PHOSH_PRIVATE_ERROR_INVALID_ARGUMENT

   

PHOSH_PRIVATE_ROTATE_DISPLAY

#define             PHOSH_PRIVATE_ROTATE_DISPLAY

PHOSH_PRIVATE_GET_XDG_SWITCHER

#define             PHOSH_PRIVATE_GET_XDG_SWITCHER

PHOSH_PRIVATE_GET_THUMBNAIL

#define             PHOSH_PRIVATE_GET_THUMBNAIL

PHOSH_PRIVATE_GET_KEYBOARD_EVENT

#define             PHOSH_PRIVATE_GET_KEYBOARD_EVENT

PHOSH_PRIVATE_ROTATE_DISPLAY_SINCE_VERSION

#define             PHOSH_PRIVATE_ROTATE_DISPLAY_SINCE_VERSION

PHOSH_PRIVATE_GET_XDG_SWITCHER_SINCE_VERSION

#define             PHOSH_PRIVATE_GET_XDG_SWITCHER_SINCE_VERSION

PHOSH_PRIVATE_GET_THUMBNAIL_SINCE_VERSION

#define             PHOSH_PRIVATE_GET_THUMBNAIL_SINCE_VERSION

PHOSH_PRIVATE_GET_KEYBOARD_EVENT_SINCE_VERSION

#define             PHOSH_PRIVATE_GET_KEYBOARD_EVENT_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_ENUM

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_ENUM

enum phosh_private_keyboard_event_error

Members

PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_INVALID_ARGUMENT

   

PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_INVALID_KEYSYM

   

PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_ALREADY_SUBSCRIBED

   

PHOSH_PRIVATE_KEYBOARD_EVENT_ERROR_MISC_ERROR

   

struct phosh_private_keyboard_event_listener

struct phosh_private_keyboard_event_listener {
	/**
	 * Report an accelerator press
	 *
	 * Forward an action to the client.
	 * @param action_id The previously assigned action_id
	 * @param timestamp The timestamp when the key has been pressed
	 * @since 5
	 */
	void (*accelerator_activated_event)(void *data,
					    struct phosh_private_keyboard_event *phosh_private_keyboard_event,
					    uint32_t action_id,
					    uint32_t timestamp);
	/**
	 * Report subscription failure
	 *
	 * A previous accelerator grab request has failed.
	 * @param accelerator The failed accelerator
	 * @param error The error code
	 * @since 5
	 */
	void (*grab_failed_event)(void *data,
				  struct phosh_private_keyboard_event *phosh_private_keyboard_event,
				  const char *accelerator,
				  uint32_t error);
	/**
	 * Report subscription success
	 *
	 * A previous accelerator grab request has succeeded.
	 * @param accelerator The subscribed accelerator
	 * @param action_id The id that has been assigned to the accelerator
	 * @since 5
	 */
	void (*grab_success_event)(void *data,
				   struct phosh_private_keyboard_event *phosh_private_keyboard_event,
				   const char *accelerator,
				   uint32_t action_id);
	/**
	 * Report unsubscription failure
	 *
	 * A previous accelerator ungrab request has failed.
	 * @param action_id The failed action
	 * @param error The error code
	 * @since 5
	 */
	void (*ungrab_failed_event)(void *data,
				    struct phosh_private_keyboard_event *phosh_private_keyboard_event,
				    uint32_t action_id,
				    uint32_t error);
	/**
	 * Report unsubscription success
	 *
	 * A previous accelerator ungrab request has suceeded.
	 * @param action The unsubscribed action
	 * @since 5
	 */
	void (*ungrab_success_event)(void *data,
				     struct phosh_private_keyboard_event *phosh_private_keyboard_event,
				     uint32_t action);
};

PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_ACCELERATOR_REQUEST

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_ACCELERATOR_REQUEST

PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_ACCELERATOR_REQUEST

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_ACCELERATOR_REQUEST

PHOSH_PRIVATE_KEYBOARD_EVENT_DESTROY

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_DESTROY

PHOSH_PRIVATE_KEYBOARD_EVENT_ACCELERATOR_ACTIVATED_EVENT_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_ACCELERATOR_ACTIVATED_EVENT_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_FAILED_EVENT_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_FAILED_EVENT_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_SUCCESS_EVENT_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_SUCCESS_EVENT_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_FAILED_EVENT_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_FAILED_EVENT_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_SUCCESS_EVENT_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_SUCCESS_EVENT_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_ACCELERATOR_REQUEST_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_GRAB_ACCELERATOR_REQUEST_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_ACCELERATOR_REQUEST_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_UNGRAB_ACCELERATOR_REQUEST_SINCE_VERSION

PHOSH_PRIVATE_KEYBOARD_EVENT_DESTROY_SINCE_VERSION

#define             PHOSH_PRIVATE_KEYBOARD_EVENT_DESTROY_SINCE_VERSION

PHOSH_PRIVATE_XDG_SWITCHER_ERROR_ENUM

#define             PHOSH_PRIVATE_XDG_SWITCHER_ERROR_ENUM

enum phosh_private_xdg_switcher_error

Members

PHOSH_PRIVATE_XDG_SWITCHER_ERROR_INVALID_ARGUMENT

   

struct phosh_private_xdg_switcher_listener

struct phosh_private_xdg_switcher_listener {
	/**
	 * report an xdg surface
	 *
	 * 
	 * @param app_id the app_id of the xdg surface
	 * @param title the title of the xdg surface
	 * @since 2
	 */
	void (*xdg_surface)(void *data,
			    struct phosh_private_xdg_switcher *phosh_private_xdg_switcher,
			    const char *app_id,
			    const char *title);
	/**
	 * all xdg surfaces were sent
	 *
	 * 
	 * @since 2
	 */
	void (*list_xdg_surfaces_done)(void *data,
				       struct phosh_private_xdg_switcher *phosh_private_xdg_switcher);
};

PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES

#define             PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES

PHOSH_PRIVATE_XDG_SWITCHER_DESTROY

#define             PHOSH_PRIVATE_XDG_SWITCHER_DESTROY

PHOSH_PRIVATE_XDG_SWITCHER_RAISE_XDG_SURFACE

#define             PHOSH_PRIVATE_XDG_SWITCHER_RAISE_XDG_SURFACE

PHOSH_PRIVATE_XDG_SWITCHER_CLOSE_XDG_SURFACE

#define             PHOSH_PRIVATE_XDG_SWITCHER_CLOSE_XDG_SURFACE

PHOSH_PRIVATE_XDG_SWITCHER_XDG_SURFACE_SINCE_VERSION

#define             PHOSH_PRIVATE_XDG_SWITCHER_XDG_SURFACE_SINCE_VERSION

PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES_DONE_SINCE_VERSION

#define             PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES_DONE_SINCE_VERSION

PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES_SINCE_VERSION

#define             PHOSH_PRIVATE_XDG_SWITCHER_LIST_XDG_SURFACES_SINCE_VERSION

PHOSH_PRIVATE_XDG_SWITCHER_DESTROY_SINCE_VERSION

#define             PHOSH_PRIVATE_XDG_SWITCHER_DESTROY_SINCE_VERSION

PHOSH_PRIVATE_XDG_SWITCHER_RAISE_XDG_SURFACE_SINCE_VERSION

#define             PHOSH_PRIVATE_XDG_SWITCHER_RAISE_XDG_SURFACE_SINCE_VERSION

PHOSH_PRIVATE_XDG_SWITCHER_CLOSE_XDG_SURFACE_SINCE_VERSION

#define             PHOSH_PRIVATE_XDG_SWITCHER_CLOSE_XDG_SURFACE_SINCE_VERSION

struct phosh_private

struct phosh_private;

struct phosh_private_keyboard_event

struct phosh_private_keyboard_event;

struct phosh_private_xdg_switcher

struct phosh_private_xdg_switcher;

struct wl_surface

struct wl_surface;

struct zwlr_foreign_toplevel_handle_v1

struct zwlr_foreign_toplevel_handle_v1;

struct zwlr_screencopy_frame_v1

struct zwlr_screencopy_frame_v1;