blob: fd17c6e9ea7ed1e3880a68da540e3b07589a8e5e [file] [log] [blame]
/* Generated by wayland-scanner 1.13.0 */
#ifndef REMOTE_SHELL_UNSTABLE_V1_CLIENT_PROTOCOL_H
#define REMOTE_SHELL_UNSTABLE_V1_CLIENT_PROTOCOL_H
#include <stdint.h>
#include <stddef.h>
#include "wayland-client.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @page page_remote_shell_unstable_v1 The remote_shell_unstable_v1 protocol
* Create remote desktop-style surfaces
*
* @section page_desc_remote_shell_unstable_v1 Description
*
* remote_shell allows clients to turn a wl_surface into a "real window"
* which can be stacked and activated by the user.
*
* Warning! The protocol described in this file is experimental and backward
* incompatible changes may be made. Backward compatible changes may be added
* together with the corresponding interface version bump. Backward
* incompatible changes are done by bumping the version number in the protocol
* and interface names and resetting the interface version. Once the protocol
* is to be declared stable, the 'z' prefix and the version number in the
* protocol and interface names are removed and the interface version number is
* reset.
*
* @section page_ifaces_remote_shell_unstable_v1 Interfaces
* - @subpage page_iface_zcr_remote_shell_v1 - remote_shell
* - @subpage page_iface_zcr_remote_surface_v1 - A desktop window
* - @subpage page_iface_zcr_notification_surface_v1 - A notification window
* - @subpage page_iface_zcr_input_method_surface_v1 - An input method window
* @section page_copyright_remote_shell_unstable_v1 Copyright
* <pre>
*
* Copyright 2016 The Chromium Authors.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
* </pre>
*/
struct wl_surface;
struct zcr_input_method_surface_v1;
struct zcr_notification_surface_v1;
struct zcr_remote_shell_v1;
struct zcr_remote_surface_v1;
/**
* @page page_iface_zcr_remote_shell_v1 zcr_remote_shell_v1
* @section page_iface_zcr_remote_shell_v1_desc Description
*
* The global interface that allows clients to turn a wl_surface into a
* "real window" which is remotely managed but can be stacked, activated
* and made fullscreen by the user.
* @section page_iface_zcr_remote_shell_v1_api API
* See @ref iface_zcr_remote_shell_v1.
*/
/**
* @defgroup iface_zcr_remote_shell_v1 The zcr_remote_shell_v1 interface
*
* The global interface that allows clients to turn a wl_surface into a
* "real window" which is remotely managed but can be stacked, activated
* and made fullscreen by the user.
*/
extern const struct wl_interface zcr_remote_shell_v1_interface;
/**
* @page page_iface_zcr_remote_surface_v1 zcr_remote_surface_v1
* @section page_iface_zcr_remote_surface_v1_desc Description
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface
* and allows for remotely managed windows.
*
* It provides requests to treat surfaces like windows, allowing to set
* properties like app id and geometry.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the remote_surface state to take effect.
*
* For a surface to be mapped by the compositor the client must have
* committed both an remote_surface state and a buffer.
* @section page_iface_zcr_remote_surface_v1_api API
* See @ref iface_zcr_remote_surface_v1.
*/
/**
* @defgroup iface_zcr_remote_surface_v1 The zcr_remote_surface_v1 interface
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface
* and allows for remotely managed windows.
*
* It provides requests to treat surfaces like windows, allowing to set
* properties like app id and geometry.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the remote_surface state to take effect.
*
* For a surface to be mapped by the compositor the client must have
* committed both an remote_surface state and a buffer.
*/
extern const struct wl_interface zcr_remote_surface_v1_interface;
/**
* @page page_iface_zcr_notification_surface_v1 zcr_notification_surface_v1
* @section page_iface_zcr_notification_surface_v1_desc Description
*
* An interface that may be implemented by a wl_surface to host
* notification contents.
* @section page_iface_zcr_notification_surface_v1_api API
* See @ref iface_zcr_notification_surface_v1.
*/
/**
* @defgroup iface_zcr_notification_surface_v1 The zcr_notification_surface_v1 interface
*
* An interface that may be implemented by a wl_surface to host
* notification contents.
*/
extern const struct wl_interface zcr_notification_surface_v1_interface;
/**
* @page page_iface_zcr_input_method_surface_v1 zcr_input_method_surface_v1
* @section page_iface_zcr_input_method_surface_v1_desc Description
*
* An interface that may be implemented by a wl_surface to host IME contents.
* @section page_iface_zcr_input_method_surface_v1_api API
* See @ref iface_zcr_input_method_surface_v1.
*/
/**
* @defgroup iface_zcr_input_method_surface_v1 The zcr_input_method_surface_v1 interface
*
* An interface that may be implemented by a wl_surface to host IME contents.
*/
extern const struct wl_interface zcr_input_method_surface_v1_interface;
#ifndef ZCR_REMOTE_SHELL_V1_CONTAINER_ENUM
#define ZCR_REMOTE_SHELL_V1_CONTAINER_ENUM
/**
* @ingroup iface_zcr_remote_shell_v1
* containers for remote surfaces
*
* Determine how a remote surface should be stacked relative to other
* shell surfaces.
*/
enum zcr_remote_shell_v1_container {
/**
* default container
*/
ZCR_REMOTE_SHELL_V1_CONTAINER_DEFAULT = 1,
/**
* system modal container
*/
ZCR_REMOTE_SHELL_V1_CONTAINER_OVERLAY = 2,
};
#endif /* ZCR_REMOTE_SHELL_V1_CONTAINER_ENUM */
#ifndef ZCR_REMOTE_SHELL_V1_STATE_TYPE_ENUM
#define ZCR_REMOTE_SHELL_V1_STATE_TYPE_ENUM
/**
* @ingroup iface_zcr_remote_shell_v1
* state types for remote surfaces
*
* Defines common show states for shell surfaces.
*/
enum zcr_remote_shell_v1_state_type {
/**
* normal window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_NORMAL = 1,
/**
* minimized window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_MINIMIZED = 2,
/**
* maximized window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_MAXIMIZED = 3,
/**
* fullscreen window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_FULLSCREEN = 4,
/**
* pinned window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_PINNED = 5,
/**
* trusted pinned window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_TRUSTED_PINNED = 6,
/**
* moving window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_MOVING = 7,
/**
* resizing window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_RESIZING = 8,
/**
* left snapped window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_LEFT_SNAPPED = 9,
/**
* right snapped window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_RIGHT_SNAPPED = 10,
/**
* pip window state
*/
ZCR_REMOTE_SHELL_V1_STATE_TYPE_PIP = 11,
};
#endif /* ZCR_REMOTE_SHELL_V1_STATE_TYPE_ENUM */
#ifndef ZCR_REMOTE_SHELL_V1_ERROR_ENUM
#define ZCR_REMOTE_SHELL_V1_ERROR_ENUM
enum zcr_remote_shell_v1_error {
/**
* given wl_surface has another role
*/
ZCR_REMOTE_SHELL_V1_ERROR_ROLE = 0,
/**
* invalid notification key
*/
ZCR_REMOTE_SHELL_V1_ERROR_INVALID_NOTIFICATION_KEY = 1,
};
#endif /* ZCR_REMOTE_SHELL_V1_ERROR_ENUM */
#ifndef ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_ENUM
#define ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_ENUM
/**
* @ingroup iface_zcr_remote_shell_v1
* the layout mode
*
* Determine how a client should layout surfaces.
*/
enum zcr_remote_shell_v1_layout_mode {
/**
* multiple windows
*/
ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_WINDOWED = 1,
/**
* restricted mode for tablet
*/
ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_TABLET = 2,
};
#endif /* ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_ENUM */
/**
* @ingroup iface_zcr_remote_shell_v1
* @struct zcr_remote_shell_v1_listener
*/
struct zcr_remote_shell_v1_listener {
/**
* activated surface changed
*
* Notifies client that the activated surface changed.
*/
void (*activated)(void *data,
struct zcr_remote_shell_v1 *zcr_remote_shell_v1,
struct wl_surface *gained_active,
struct wl_surface *lost_active);
/**
* suggests a re-configuration of remote shell
*
* [Deprecated] Suggests a re-configuration of remote shell.
*/
void (*configuration_changed)(void *data,
struct zcr_remote_shell_v1 *zcr_remote_shell_v1,
int32_t width,
int32_t height,
int32_t transform,
wl_fixed_t scale_factor,
int32_t work_area_inset_left,
int32_t work_area_inset_top,
int32_t work_area_inset_right,
int32_t work_area_inset_bottom,
uint32_t layout_mode);
/**
* area of remote shell
*
* Defines an area of the remote shell used for layout. Each
* series of "workspace" events must be terminated by a "configure"
* event.
* @param is_internal 1 if screen is built-in
* @since 5
*/
void (*workspace)(void *data,
struct zcr_remote_shell_v1 *zcr_remote_shell_v1,
uint32_t id_hi,
uint32_t id_lo,
int32_t x,
int32_t y,
int32_t width,
int32_t height,
int32_t inset_left,
int32_t inset_top,
int32_t inset_right,
int32_t inset_bottom,
int32_t transform,
wl_fixed_t scale_factor,
uint32_t is_internal);
/**
* suggests configuration of remote shell
*
* Suggests a new configuration of the remote shell. Preceded by
* a series of "workspace" events.
* @since 5
*/
void (*configure)(void *data,
struct zcr_remote_shell_v1 *zcr_remote_shell_v1,
uint32_t layout_mode);
/**
* initialize scale configuration
*
* Sends the default device scale factor.
* @param scale DP to pixels ratio, in 8.24 fixed point format
* @since 8
*/
void (*default_device_scale_factor)(void *data,
struct zcr_remote_shell_v1 *zcr_remote_shell_v1,
int32_t scale);
};
/**
* @ingroup iface_zcr_remote_shell_v1
*/
static inline int
zcr_remote_shell_v1_add_listener(struct zcr_remote_shell_v1 *zcr_remote_shell_v1,
const struct zcr_remote_shell_v1_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) zcr_remote_shell_v1,
(void (**)(void)) listener, data);
}
#define ZCR_REMOTE_SHELL_V1_DESTROY 0
#define ZCR_REMOTE_SHELL_V1_GET_REMOTE_SURFACE 1
#define ZCR_REMOTE_SHELL_V1_GET_NOTIFICATION_SURFACE 2
#define ZCR_REMOTE_SHELL_V1_GET_INPUT_METHOD_SURFACE 3
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_ACTIVATED_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_CONFIGURATION_CHANGED_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_WORKSPACE_SINCE_VERSION 5
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_CONFIGURE_SINCE_VERSION 5
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_DEFAULT_DEVICE_SCALE_FACTOR_SINCE_VERSION 8
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_GET_REMOTE_SURFACE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_GET_NOTIFICATION_SURFACE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_shell_v1
*/
#define ZCR_REMOTE_SHELL_V1_GET_INPUT_METHOD_SURFACE_SINCE_VERSION 17
/** @ingroup iface_zcr_remote_shell_v1 */
static inline void
zcr_remote_shell_v1_set_user_data(struct zcr_remote_shell_v1 *zcr_remote_shell_v1, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) zcr_remote_shell_v1, user_data);
}
/** @ingroup iface_zcr_remote_shell_v1 */
static inline void *
zcr_remote_shell_v1_get_user_data(struct zcr_remote_shell_v1 *zcr_remote_shell_v1)
{
return wl_proxy_get_user_data((struct wl_proxy *) zcr_remote_shell_v1);
}
static inline uint32_t
zcr_remote_shell_v1_get_version(struct zcr_remote_shell_v1 *zcr_remote_shell_v1)
{
return wl_proxy_get_version((struct wl_proxy *) zcr_remote_shell_v1);
}
/**
* @ingroup iface_zcr_remote_shell_v1
*
* Destroy this remote_shell object.
*
* Destroying a bound remote_shell object while there are surfaces
* still alive created by this remote_shell object instance is illegal
* and will result in a protocol error.
*/
static inline void
zcr_remote_shell_v1_destroy(struct zcr_remote_shell_v1 *zcr_remote_shell_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_shell_v1,
ZCR_REMOTE_SHELL_V1_DESTROY);
wl_proxy_destroy((struct wl_proxy *) zcr_remote_shell_v1);
}
/**
* @ingroup iface_zcr_remote_shell_v1
*
* This creates an remote_surface for the given surface and gives it the
* remote_surface role. A wl_surface can only be given a remote_surface
* role once. If get_remote_surface is called with a wl_surface that
* already has an active remote_surface associated with it, or if it had
* any other role, an error is raised.
*
* See the documentation of remote_surface for more details about what an
* remote_surface is and how it is used.
*/
static inline struct zcr_remote_surface_v1 *
zcr_remote_shell_v1_get_remote_surface(struct zcr_remote_shell_v1 *zcr_remote_shell_v1, struct wl_surface *surface, uint32_t container)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) zcr_remote_shell_v1,
ZCR_REMOTE_SHELL_V1_GET_REMOTE_SURFACE, &zcr_remote_surface_v1_interface, NULL, surface, container);
return (struct zcr_remote_surface_v1 *) id;
}
/**
* @ingroup iface_zcr_remote_shell_v1
*
* Creates a notification_surface for the given surface, gives it the
* notification_surface role and associated it with a notification id.
*/
static inline struct zcr_notification_surface_v1 *
zcr_remote_shell_v1_get_notification_surface(struct zcr_remote_shell_v1 *zcr_remote_shell_v1, struct wl_surface *surface, const char *notification_key)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) zcr_remote_shell_v1,
ZCR_REMOTE_SHELL_V1_GET_NOTIFICATION_SURFACE, &zcr_notification_surface_v1_interface, NULL, surface, notification_key);
return (struct zcr_notification_surface_v1 *) id;
}
/**
* @ingroup iface_zcr_remote_shell_v1
*
* Creates an input_method_surface for the given surface, gives it
* the input_method_surface role.
*/
static inline struct zcr_input_method_surface_v1 *
zcr_remote_shell_v1_get_input_method_surface(struct zcr_remote_shell_v1 *zcr_remote_shell_v1, struct wl_surface *surface)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) zcr_remote_shell_v1,
ZCR_REMOTE_SHELL_V1_GET_INPUT_METHOD_SURFACE, &zcr_input_method_surface_v1_interface, NULL, surface);
return (struct zcr_input_method_surface_v1 *) id;
}
#ifndef ZCR_REMOTE_SURFACE_V1_SYSTEMUI_VISIBILITY_STATE_ENUM
#define ZCR_REMOTE_SURFACE_V1_SYSTEMUI_VISIBILITY_STATE_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* systemui visibility behavior
*
* Determine the visibility behavior of the system UI.
*/
enum zcr_remote_surface_v1_systemui_visibility_state {
/**
* system ui is visible
*/
ZCR_REMOTE_SURFACE_V1_SYSTEMUI_VISIBILITY_STATE_VISIBLE = 1,
/**
* system ui autohides and is not sticky
*/
ZCR_REMOTE_SURFACE_V1_SYSTEMUI_VISIBILITY_STATE_AUTOHIDE_NON_STICKY = 2,
/**
* system ui autohides and is sticky
*/
ZCR_REMOTE_SURFACE_V1_SYSTEMUI_VISIBILITY_STATE_AUTOHIDE_STICKY = 3,
};
#endif /* ZCR_REMOTE_SURFACE_V1_SYSTEMUI_VISIBILITY_STATE_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_ORIENTATION_ENUM
#define ZCR_REMOTE_SURFACE_V1_ORIENTATION_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* window orientation
*
* The orientation of the window.
*/
enum zcr_remote_surface_v1_orientation {
/**
* portrait
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_PORTRAIT = 1,
/**
* landscape
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LANDSCAPE = 2,
};
#endif /* ZCR_REMOTE_SURFACE_V1_ORIENTATION_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_WINDOW_TYPE_ENUM
#define ZCR_REMOTE_SURFACE_V1_WINDOW_TYPE_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* window type
*
* The type of the window.
*/
enum zcr_remote_surface_v1_window_type {
/**
* normal app window
*/
ZCR_REMOTE_SURFACE_V1_WINDOW_TYPE_NORMAL = 1,
/**
* window is treated as systemui
*/
ZCR_REMOTE_SURFACE_V1_WINDOW_TYPE_SYSTEM_UI = 2,
};
#endif /* ZCR_REMOTE_SURFACE_V1_WINDOW_TYPE_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_ENUM
#define ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* bounds_change_reason
*
* Specifies the cause of the window bounds change event.
*/
enum zcr_remote_surface_v1_bounds_change_reason {
/**
* the window is being moved by drag operation
*/
ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_DRAG_MOVE = 1,
/**
* the window is being resized by drag operation.
*/
ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_DRAG_RESIZE = 2,
/**
* the window is resized to left snapped state
*/
ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_SNAP_TO_LEFT = 3,
/**
* the window is resized to right snapped state
*/
ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_SNAP_TO_RIGHT = 4,
/**
* the window bounds is moved due to other WM operations
*/
ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_MOVE = 5,
/**
* the window bounds is reiszed due to other WM operations
*/
ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_RESIZE = 6,
};
#endif /* ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGE_REASON_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_ENUM
#define ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* resize direction
*
* The resize direction for drag operation
*/
enum zcr_remote_surface_v1_resize_direction {
/**
* move only, no resize
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_NONE = 0,
/**
* resize to the left
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_LEFT = 1,
/**
* resize to the top left
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_TOPLEFT = 2,
/**
* resize to the top
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_TOP = 3,
/**
* resize to the top right
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_TOPRIGHT = 4,
/**
* resize to the right
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_RIGHT = 5,
/**
* resize to the buttom right
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_BOTTOMRIGHT = 6,
/**
* resize to the bottom
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_BOTTOM = 7,
/**
* resize to the bottom left
*/
ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_BOTTOMLEFT = 8,
};
#endif /* ZCR_REMOTE_SURFACE_V1_RESIZE_DIRECTION_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_ENUM
#define ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* frame types
*
* Frame type that can be used to decorate a surface.
*/
enum zcr_remote_surface_v1_frame_type {
/**
* no frame
*/
ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_NONE = 0,
/**
* caption with shadow
*/
ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_NORMAL = 1,
/**
* shadow only
*/
ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_SHADOW = 2,
/**
* autohide frame with shadow
*/
ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_AUTOHIDE = 3,
/**
* overlay frame with shadow
*/
ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_OVERLAY = 4,
};
#endif /* ZCR_REMOTE_SURFACE_V1_FRAME_TYPE_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_ENUM
#define ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* frame button types
*
* The mask that represents buttons on frame.
*/
enum zcr_remote_surface_v1_frame_button_type {
/**
* a button to naviate backwards
*/
ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_BACK = 1,
/**
* a button to minimize the window
*/
ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_MINIMIZE = 2,
/**
* a button to maximize or restore
*/
ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_MAXIMIZE_RESTORE = 4,
/**
* a button to activate application's menu
*/
ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_MENU = 8,
/**
* a button to close the window
*/
ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_CLOSE = 16,
/**
* a mask to turn the maximize_restore button to zoom button
*/
ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_ZOOM = 32,
};
#endif /* ZCR_REMOTE_SURFACE_V1_FRAME_BUTTON_TYPE_ENUM */
#ifndef ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_ENUM
#define ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_ENUM
/**
* @ingroup iface_zcr_remote_surface_v1
* orientation lock request for remote surfaces
*
* Defines orientation request when a remote surface is in foreground.
*/
enum zcr_remote_surface_v1_orientation_lock {
/**
* no orientation lock
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_NONE = 1,
/**
* primary or secondary portrait
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_PORTRAIT = 2,
/**
* primary or secondary landscape
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_LANDSCAPE = 3,
/**
* keep current orientation
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_CURRENT = 4,
/**
* primary portrait
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_PORTRAIT_PRIMARY = 5,
/**
* primary landscape
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_LANDSCAPE_PRIMARY = 6,
/**
* secondary portrait
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_PORTRAIT_SECONDARY = 7,
/**
* secondary landscape
*/
ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_LANDSCAPE_SECONDARY = 8,
};
#endif /* ZCR_REMOTE_SURFACE_V1_ORIENTATION_LOCK_ENUM */
/**
* @ingroup iface_zcr_remote_surface_v1
* @struct zcr_remote_surface_v1_listener
*/
struct zcr_remote_surface_v1_listener {
/**
* surface wants to be closed
*
* The close event is sent by the compositor when the user wants
* the surface to be closed. This should be equivalent to the user
* clicking the close button in client-side decorations, if your
* application has any...
*
* This is only a request that the user intends to close your
* window. The client may choose to ignore this request, or show a
* dialog to ask the user to save their data...
*/
void (*close)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1);
/**
* surface state type changed
*
* [Deprecated] The state_type_changed event is sent by the
* compositor when the surface state changed.
*
* This is an event to notify that the window state changed in
* compositor. The state change may be triggered by a client's
* request, or some user action directly handled by the compositor.
* The client may choose to ignore this event.
*/
void (*state_type_changed)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
uint32_t state_type);
/**
* suggest a surface change
*
* The configure event asks the client to change surface state.
*
* The client must apply the origin offset to window positions in
* set_window_geometry requests.
*
* The states listed in the event are state_type values, and might
* change due to a client request or an event directly handled by
* the compositor.
*
* Clients should arrange their surface for the new state, and then
* send an ack_configure request with the serial sent in this
* configure event at some point before committing the new surface.
*
* If the client receives multiple configure events before it can
* respond to one, it is free to discard all but the last event it
* received.
* @since 5
*/
void (*configure)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
int32_t origin_offset_x,
int32_t origin_offset_y,
struct wl_array *states,
uint32_t serial);
/**
* announce window geometry commit
*
* Notify the client of committed window geometry.
*
* The compositor sends this event when it commits window geometry.
* The client may use this information to convert coordinates of
* input events using the latest committed geometry.
* @since 9
*/
void (*window_geometry_changed)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
int32_t x,
int32_t y,
int32_t width,
int32_t height);
/**
* The compositor requested to change the bounds
*
* The compositor requested to change its bounds.
* "bounds_change_reason" specifies the cause of the bounds change.
* The client may apply the different move/resize strategy
* depending on the reason.
*
* "display_id_hi", "display_id_lo" specifies in which workspace
* the surface should live in.
*
* The client responds with set_window_geometry request, with the
* bounds it is resized to (this may be different from the bounds
* requested).
*
* The client may ignore move request depending on the state, e.g,
* if it becomes resizable or other constrants.
* @since 10
*/
void (*bounds_changed)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
uint32_t workspace_id_hi,
uint32_t workspace_id_lo,
int32_t x,
int32_t y,
int32_t width,
int32_t height,
uint32_t bounds_change_reason);
/**
* Notifies that a drag to move/resize started.
*
* Notifies a client that the compositor started drag operation.
* "direction" specifies which direction it is being resized.
* "none" direction means just move but not resize.
*
* This will be followed by series of the "bounds_changed" event
* with "drag_resize" or "drag_move" reasons to update the window
* bounds druing the drag operation.
* @since 10
*/
void (*drag_started)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
uint32_t direction);
/**
* Notifies that a drag operation has finished.
*
* Called when the drag operation is finished. "x" and "y"
* specifies the position of the pointer device used to drag.
* "canceled" is true if the drag operation is aborted during drag
* (e.g. by capture change or user action.)
* @param canceled true if the operation was canceled
* @since 10
*/
void (*drag_finished)(void *data,
struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
int32_t x,
int32_t y,
int32_t canceled);
};
/**
* @ingroup iface_zcr_remote_surface_v1
*/
static inline int
zcr_remote_surface_v1_add_listener(struct zcr_remote_surface_v1 *zcr_remote_surface_v1,
const struct zcr_remote_surface_v1_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) zcr_remote_surface_v1,
(void (**)(void)) listener, data);
}
#define ZCR_REMOTE_SURFACE_V1_DESTROY 0
#define ZCR_REMOTE_SURFACE_V1_SET_APP_ID 1
#define ZCR_REMOTE_SURFACE_V1_SET_WINDOW_GEOMETRY 2
#define ZCR_REMOTE_SURFACE_V1_SET_SCALE 3
#define ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SHADOW 4
#define ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SHADOW_BACKGROUND_OPACITY 5
#define ZCR_REMOTE_SURFACE_V1_SET_TITLE 6
#define ZCR_REMOTE_SURFACE_V1_SET_TOP_INSET 7
#define ZCR_REMOTE_SURFACE_V1_ACTIVATE 8
#define ZCR_REMOTE_SURFACE_V1_MAXIMIZE 9
#define ZCR_REMOTE_SURFACE_V1_MINIMIZE 10
#define ZCR_REMOTE_SURFACE_V1_RESTORE 11
#define ZCR_REMOTE_SURFACE_V1_FULLSCREEN 12
#define ZCR_REMOTE_SURFACE_V1_UNFULLSCREEN 13
#define ZCR_REMOTE_SURFACE_V1_PIN 14
#define ZCR_REMOTE_SURFACE_V1_UNPIN 15
#define ZCR_REMOTE_SURFACE_V1_SET_SYSTEM_MODAL 16
#define ZCR_REMOTE_SURFACE_V1_UNSET_SYSTEM_MODAL 17
#define ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SURFACE_SHADOW 18
#define ZCR_REMOTE_SURFACE_V1_SET_SYSTEMUI_VISIBILITY 19
#define ZCR_REMOTE_SURFACE_V1_SET_ALWAYS_ON_TOP 20
#define ZCR_REMOTE_SURFACE_V1_UNSET_ALWAYS_ON_TOP 21
#define ZCR_REMOTE_SURFACE_V1_ACK_CONFIGURE 22
#define ZCR_REMOTE_SURFACE_V1_MOVE 23
#define ZCR_REMOTE_SURFACE_V1_SET_ORIENTATION 24
#define ZCR_REMOTE_SURFACE_V1_SET_WINDOW_TYPE 25
#define ZCR_REMOTE_SURFACE_V1_RESIZE 26
#define ZCR_REMOTE_SURFACE_V1_SET_RESIZE_OUTSET 27
#define ZCR_REMOTE_SURFACE_V1_START_MOVE 28
#define ZCR_REMOTE_SURFACE_V1_SET_CAN_MAXIMIZE 29
#define ZCR_REMOTE_SURFACE_V1_UNSET_CAN_MAXIMIZE 30
#define ZCR_REMOTE_SURFACE_V1_SET_MIN_SIZE 31
#define ZCR_REMOTE_SURFACE_V1_SET_MAX_SIZE 32
#define ZCR_REMOTE_SURFACE_V1_SET_SNAPPED_TO_LEFT 33
#define ZCR_REMOTE_SURFACE_V1_SET_SNAPPED_TO_RIGHT 34
#define ZCR_REMOTE_SURFACE_V1_START_RESIZE 35
#define ZCR_REMOTE_SURFACE_V1_SET_FRAME 36
#define ZCR_REMOTE_SURFACE_V1_SET_FRAME_BUTTONS 37
#define ZCR_REMOTE_SURFACE_V1_SET_EXTRA_TITLE 38
#define ZCR_REMOTE_SURFACE_V1_SET_ORIENTATION_LOCK 39
#define ZCR_REMOTE_SURFACE_V1_PIP 40
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_CLOSE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_STATE_TYPE_CHANGED_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_CONFIGURE_SINCE_VERSION 5
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_WINDOW_GEOMETRY_CHANGED_SINCE_VERSION 9
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_BOUNDS_CHANGED_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_DRAG_STARTED_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_DRAG_FINISHED_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_APP_ID_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_WINDOW_GEOMETRY_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_SCALE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SHADOW_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SHADOW_BACKGROUND_OPACITY_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_TITLE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_TOP_INSET_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_ACTIVATE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_MAXIMIZE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_MINIMIZE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_RESTORE_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_FULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_UNFULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_PIN_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_UNPIN_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_SYSTEM_MODAL_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_UNSET_SYSTEM_MODAL_SINCE_VERSION 1
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SURFACE_SHADOW_SINCE_VERSION 2
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_SYSTEMUI_VISIBILITY_SINCE_VERSION 3
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_ALWAYS_ON_TOP_SINCE_VERSION 4
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_UNSET_ALWAYS_ON_TOP_SINCE_VERSION 4
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_ACK_CONFIGURE_SINCE_VERSION 5
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_MOVE_SINCE_VERSION 5
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_ORIENTATION_SINCE_VERSION 6
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_WINDOW_TYPE_SINCE_VERSION 7
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_RESIZE_SINCE_VERSION 9
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_RESIZE_OUTSET_SINCE_VERSION 9
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_START_MOVE_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_CAN_MAXIMIZE_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_UNSET_CAN_MAXIMIZE_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_MIN_SIZE_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_MAX_SIZE_SINCE_VERSION 10
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_SNAPPED_TO_LEFT_SINCE_VERSION 11
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_SNAPPED_TO_RIGHT_SINCE_VERSION 11
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_START_RESIZE_SINCE_VERSION 12
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_FRAME_SINCE_VERSION 13
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_FRAME_BUTTONS_SINCE_VERSION 13
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_EXTRA_TITLE_SINCE_VERSION 13
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_SET_ORIENTATION_LOCK_SINCE_VERSION 14
/**
* @ingroup iface_zcr_remote_surface_v1
*/
#define ZCR_REMOTE_SURFACE_V1_PIP_SINCE_VERSION 15
/** @ingroup iface_zcr_remote_surface_v1 */
static inline void
zcr_remote_surface_v1_set_user_data(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) zcr_remote_surface_v1, user_data);
}
/** @ingroup iface_zcr_remote_surface_v1 */
static inline void *
zcr_remote_surface_v1_get_user_data(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
return wl_proxy_get_user_data((struct wl_proxy *) zcr_remote_surface_v1);
}
static inline uint32_t
zcr_remote_surface_v1_get_version(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
return wl_proxy_get_version((struct wl_proxy *) zcr_remote_surface_v1);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Unmap and destroy the window. The window will be effectively
* hidden from the user's point of view, and all state will be lost.
*/
static inline void
zcr_remote_surface_v1_destroy(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_DESTROY);
wl_proxy_destroy((struct wl_proxy *) zcr_remote_surface_v1);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set an application identifier for the surface.
*/
static inline void
zcr_remote_surface_v1_set_app_id(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, const char *app_id)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_APP_ID, app_id);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* The window geometry of a window is its "visible bounds" from the
* user's perspective. Client-side decorations often have invisible
* portions like drop-shadows which should be ignored for the
* purposes of aligning, placing and constraining windows.
*
* The window geometry is double buffered, and will be applied at the
* time wl_surface.commit of the corresponding wl_surface is called.
*
* Once the window geometry of the surface is set once, it is not
* possible to unset it, and it will remain the same until
* set_window_geometry is called again, even if a new subsurface or
* buffer is attached.
*
* If never set, the value is the full bounds of the output. This
* updates dynamically on every commit.
*
* The arguments are given in the output coordinate space.
*
* The width and height must be greater than zero.
*/
static inline void
zcr_remote_surface_v1_set_window_geometry(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_WINDOW_GEOMETRY, x, y, width, height);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set a scale factor that will be applied to surface and all descendants.
*/
static inline void
zcr_remote_surface_v1_set_scale(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, wl_fixed_t scale)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_SCALE, scale);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* [Deprecated] Request that surface needs a rectangular shadow.
*
* This is only a request that the surface should have a rectangular
* shadow. The compositor may choose to ignore this request.
*
* The arguments are given in the output coordinate space and specifies
* the inner bounds of the shadow.
*
* The arguments are given in the output coordinate space.
* Specifying zero width and height will disable the shadow.
*/
static inline void
zcr_remote_surface_v1_set_rectangular_shadow(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SHADOW, x, y, width, height);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* [Deprecated] Suggests the window's background opacity when the shadow is requested.
*/
static inline void
zcr_remote_surface_v1_set_rectangular_shadow_background_opacity(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, wl_fixed_t opacity)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SHADOW_BACKGROUND_OPACITY, opacity);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set a short title for the surface.
*
* This string may be used to identify the surface in a task bar,
* window list, or other user interface elements provided by the
* compositor.
*
* The string must be encoded in UTF-8.
*/
static inline void
zcr_remote_surface_v1_set_title(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, const char *title)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_TITLE, title);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set distance from the top of the surface to the contents.
*
* This distance typically represents the size of the window caption.
*/
static inline void
zcr_remote_surface_v1_set_top_inset(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_TOP_INSET, height);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Make the surface active and bring it to the front.
*/
static inline void
zcr_remote_surface_v1_activate(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_ACTIVATE, serial);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is maximized. The window geometry will be updated
* to whatever the compositor finds appropriate for a maximized window.
*
* This is only a request that the window should be maximized. The
* compositor may choose to ignore this request. The client should
* listen to set_maximized events to determine if the window was
* maximized or not.
*/
static inline void
zcr_remote_surface_v1_maximize(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_MAXIMIZE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is minimized.
*
* This is only a request that the window should be minimized. The
* compositor may choose to ignore this request. The client should
* listen to set_minimized events to determine if the window was
* minimized or not.
*/
static inline void
zcr_remote_surface_v1_minimize(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_MINIMIZE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is restored. This restores the window geometry
* to what it was before the window was minimized, maximized or made
* fullscreen.
*
* This is only a request that the window should be restored. The
* compositor may choose to ignore this request. The client should
* listen to unset_maximized, unset_minimize and unset_fullscreen
* events to determine if the window was restored or not.
*/
static inline void
zcr_remote_surface_v1_restore(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_RESTORE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is made fullscreen.
*
* This is only a request that the window should be made fullscreen.
* The compositor may choose to ignore this request. The client should
* listen to set_fullscreen events to determine if the window was
* made fullscreen or not.
*/
static inline void
zcr_remote_surface_v1_fullscreen(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_FULLSCREEN);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is made unfullscreen.
*
* This is only a request that the window should be made unfullscreen.
* The compositor may choose to ignore this request. The client should
* listen to unset_fullscreen events to determine if the window was
* made unfullscreen or not.
*/
static inline void
zcr_remote_surface_v1_unfullscreen(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_UNFULLSCREEN);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is pinned.
*
* This is only a request that the window should be pinned.
* The compositor may choose to ignore this request. The client should
* listen to state_changed events to determine if the window was
* pinned or not. If trusted flag is non-zero, the app can prevent users
* from exiting the pinned mode.
*/
static inline void
zcr_remote_surface_v1_pin(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t trusted)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_PIN, trusted);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is unpinned.
*
* This is only a request that the window should be unpinned.
* The compositor may choose to ignore this request. The client should
* listen to unset_pinned events to determine if the window was
* unpinned or not.
*/
static inline void
zcr_remote_surface_v1_unpin(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_UNPIN);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Suggests a surface should become system modal.
*/
static inline void
zcr_remote_surface_v1_set_system_modal(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_SYSTEM_MODAL);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Suggests a surface should become non system modal.
*/
static inline void
zcr_remote_surface_v1_unset_system_modal(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_UNSET_SYSTEM_MODAL);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface needs a rectangular shadow.
*
* This is only a request that the surface should have a rectangular
* shadow. The compositor may choose to ignore this request.
*
* The arguments are given in the remote surface coordinate space and
* specifies inner bounds of the shadow. Specifying zero width and height
* will disable the shadow.
*/
static inline void
zcr_remote_surface_v1_set_rectangular_surface_shadow(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_RECTANGULAR_SURFACE_SHADOW, x, y, width, height);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Requests how the surface will change the visibility of the system UI when it is made active.
*/
static inline void
zcr_remote_surface_v1_set_systemui_visibility(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t visibility)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_SYSTEMUI_VISIBILITY, visibility);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is made to be always on top.
*
* This is only a request that the window should be always on top.
* The compositor may choose to ignore this request.
*
*/
static inline void
zcr_remote_surface_v1_set_always_on_top(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_ALWAYS_ON_TOP);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is made to be not always on top.
*
* This is only a request that the window should be not always on top.
* The compositor may choose to ignore this request.
*/
static inline void
zcr_remote_surface_v1_unset_always_on_top(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_UNSET_ALWAYS_ON_TOP);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* When a configure event is received, if a client commits the
* surface in response to the configure event, then the client
* must make an ack_configure request sometime before the commit
* request, passing along the serial of the configure event.
*
* For instance, the compositor might use this information during display
* configuration to change its coordinate space for set_window_geometry
* requests only when the client has switched to the new coordinate space.
*
* If the client receives multiple configure events before it
* can respond to one, it only has to ack the last configure event.
*
* A client is not required to commit immediately after sending
* an ack_configure request - it may even ack_configure several times
* before its next surface commit.
*
* A client may send multiple ack_configure requests before committing, but
* only the last request sent before a commit indicates which configure
* event the client really is responding to.
*/
static inline void
zcr_remote_surface_v1_ack_configure(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_ACK_CONFIGURE, serial);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Start an interactive, user-driven move of the surface.
*
* The compositor responds to this request with a configure event that
* transitions to the "moving" state. The client must only initiate motion
* after acknowledging the state change. The compositor can assume that
* subsequent set_window_geometry requests are position updates until the
* next state transition is acknowledged.
*
* The compositor may ignore move requests depending on the state of the
* surface, e.g. fullscreen or maximized.
*/
static inline void
zcr_remote_surface_v1_move(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_MOVE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set an orientation for the surface.
*/
static inline void
zcr_remote_surface_v1_set_orientation(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t orientation)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_ORIENTATION, orientation);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set the type of window. This is only a hint to the compositor and the
* compositor is free to ignore it.
*/
static inline void
zcr_remote_surface_v1_set_window_type(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t type)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_WINDOW_TYPE, type);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* [Deprecated] Start an interactive, user-driven resize of the surface.
*
* The compositor responds to this request with a configure event that
* transitions to the "resizing" state. The client must only initiate
* resizing after acknowledging the state change. The compositor can assume
* that subsequent set_window_geometry requests are resizes until the next
* state transition is acknowledged.
*
* The compositor may ignore resize requests depending on the state of the
* surface, e.g. fullscreen or maximized.
*/
static inline void
zcr_remote_surface_v1_resize(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_RESIZE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Expand input region of surface with resize outset.
*
* The compositor clips the input region of each surface to its bounds,
* unless the client requests a resize outset. In that case, the input
* region of the root surface is expanded to allow for some leeway around
* visible bounds when starting a user-driven resize.
*/
static inline void
zcr_remote_surface_v1_set_resize_outset(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t outset)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_RESIZE_OUTSET, outset);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request an interactive, user-driven move of the surface. "x"
* and "y" specifies the starting point of the pointer device
* that initiated the move.
*
* The compositor responds to this request with a drag_started
* event with "none" direction. Please see drag_started event
* for more details.
*
* The compositor may ignore move requests depending on the state of the
* surface, e.g. fullscreen or maximized.
*/
static inline void
zcr_remote_surface_v1_start_move(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t x, int32_t y)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_START_MOVE, x, y);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface can be in maximzied state.
*/
static inline void
zcr_remote_surface_v1_set_can_maximize(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_CAN_MAXIMIZE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface can not be in maximzied state.
*/
static inline void
zcr_remote_surface_v1_unset_can_maximize(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_UNSET_CAN_MAXIMIZE);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set a minimum size of the surface.
*
* Values set in this way are double-buffered. They will get
* applied on the next commit.
*/
static inline void
zcr_remote_surface_v1_set_min_size(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_MIN_SIZE, width, height);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Set a maximum size of the surface.
*
* Values set in this way are double-buffered. They will get
* applied on the next commit.
*
* Setting the same size as minimum size makes the surface
* unresizable.
*/
static inline void
zcr_remote_surface_v1_set_max_size(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_MAX_SIZE, width, height);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is snapped to left.
*/
static inline void
zcr_remote_surface_v1_set_snapped_to_left(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_SNAPPED_TO_LEFT);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is snapped to right.
*/
static inline void
zcr_remote_surface_v1_set_snapped_to_right(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_SNAPPED_TO_RIGHT);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request to start an interactive, user-driven resize of the surface.
* "x" and "y" specifies the starting point of the pointer device
* that initiated the reize.
*
* The compositor responds to this request with a "drag_started"
* event, followed by "bounds_changed" events, and ends the
* resize operation with a "drag_finhsed" event. The compositor
* determines the new bounds using the resize_direction and the
* pointer event location.
*
* The compositor may ignore resize requests depending on the state of the
* surface, e.g. fullscreen or maximized, or no drag event is in pregress.
*/
static inline void
zcr_remote_surface_v1_start_resize(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t resize_direction, int32_t x, int32_t y)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_START_RESIZE, resize_direction, x, y);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Enables compositor side frame decoration. |type|
* specifies the type of frame to use for the surface.
*/
static inline void
zcr_remote_surface_v1_set_frame(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t type)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_FRAME, type);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Updates the frame's button state. |visible_buttons| and |enabled_buttons|
* are the union of button mask defined in |frame_button_type| enum.
*
* The mask present in |enabled_buttons| but not in |visible_buttons| will
* be ignored.
*/
static inline void
zcr_remote_surface_v1_set_frame_buttons(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t visible_buttons, uint32_t enabled_buttons)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_FRAME_BUTTONS, visible_buttons, enabled_buttons);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* The extra informational string about the surface. This can be
* used to show the debug information in the title bar, or log
* messages.
*
* This is different from "set_title" which is used to identify
* the surface.
*
* The string must be encoded in UTF-8.
*/
static inline void
zcr_remote_surface_v1_set_extra_title(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, const char *extra_title)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_EXTRA_TITLE, extra_title);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request a specific orientation behavior when this surface is in foreground.
*/
static inline void
zcr_remote_surface_v1_set_orientation_lock(struct zcr_remote_surface_v1 *zcr_remote_surface_v1, uint32_t orientation_lock)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_SET_ORIENTATION_LOCK, orientation_lock);
}
/**
* @ingroup iface_zcr_remote_surface_v1
*
* Request that surface is set to Picture-in-Picture (PIP).
*/
static inline void
zcr_remote_surface_v1_pip(struct zcr_remote_surface_v1 *zcr_remote_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_remote_surface_v1,
ZCR_REMOTE_SURFACE_V1_PIP);
}
#define ZCR_NOTIFICATION_SURFACE_V1_DESTROY 0
#define ZCR_NOTIFICATION_SURFACE_V1_SET_APP_ID 1
/**
* @ingroup iface_zcr_notification_surface_v1
*/
#define ZCR_NOTIFICATION_SURFACE_V1_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_zcr_notification_surface_v1
*/
#define ZCR_NOTIFICATION_SURFACE_V1_SET_APP_ID_SINCE_VERSION 16
/** @ingroup iface_zcr_notification_surface_v1 */
static inline void
zcr_notification_surface_v1_set_user_data(struct zcr_notification_surface_v1 *zcr_notification_surface_v1, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) zcr_notification_surface_v1, user_data);
}
/** @ingroup iface_zcr_notification_surface_v1 */
static inline void *
zcr_notification_surface_v1_get_user_data(struct zcr_notification_surface_v1 *zcr_notification_surface_v1)
{
return wl_proxy_get_user_data((struct wl_proxy *) zcr_notification_surface_v1);
}
static inline uint32_t
zcr_notification_surface_v1_get_version(struct zcr_notification_surface_v1 *zcr_notification_surface_v1)
{
return wl_proxy_get_version((struct wl_proxy *) zcr_notification_surface_v1);
}
/**
* @ingroup iface_zcr_notification_surface_v1
*
* Unmap and destroy the notification surface.
*/
static inline void
zcr_notification_surface_v1_destroy(struct zcr_notification_surface_v1 *zcr_notification_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_notification_surface_v1,
ZCR_NOTIFICATION_SURFACE_V1_DESTROY);
wl_proxy_destroy((struct wl_proxy *) zcr_notification_surface_v1);
}
/**
* @ingroup iface_zcr_notification_surface_v1
*
* Set an application identifier for the notification surface.
*/
static inline void
zcr_notification_surface_v1_set_app_id(struct zcr_notification_surface_v1 *zcr_notification_surface_v1, const char *app_id)
{
wl_proxy_marshal((struct wl_proxy *) zcr_notification_surface_v1,
ZCR_NOTIFICATION_SURFACE_V1_SET_APP_ID, app_id);
}
#define ZCR_INPUT_METHOD_SURFACE_V1_DESTROY 0
/**
* @ingroup iface_zcr_input_method_surface_v1
*/
#define ZCR_INPUT_METHOD_SURFACE_V1_DESTROY_SINCE_VERSION 1
/** @ingroup iface_zcr_input_method_surface_v1 */
static inline void
zcr_input_method_surface_v1_set_user_data(struct zcr_input_method_surface_v1 *zcr_input_method_surface_v1, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) zcr_input_method_surface_v1, user_data);
}
/** @ingroup iface_zcr_input_method_surface_v1 */
static inline void *
zcr_input_method_surface_v1_get_user_data(struct zcr_input_method_surface_v1 *zcr_input_method_surface_v1)
{
return wl_proxy_get_user_data((struct wl_proxy *) zcr_input_method_surface_v1);
}
static inline uint32_t
zcr_input_method_surface_v1_get_version(struct zcr_input_method_surface_v1 *zcr_input_method_surface_v1)
{
return wl_proxy_get_version((struct wl_proxy *) zcr_input_method_surface_v1);
}
/**
* @ingroup iface_zcr_input_method_surface_v1
*
* Unmap and destroy the input mtehod surface.
*/
static inline void
zcr_input_method_surface_v1_destroy(struct zcr_input_method_surface_v1 *zcr_input_method_surface_v1)
{
wl_proxy_marshal((struct wl_proxy *) zcr_input_method_surface_v1,
ZCR_INPUT_METHOD_SURFACE_V1_DESTROY);
wl_proxy_destroy((struct wl_proxy *) zcr_input_method_surface_v1);
}
#ifdef __cplusplus
}
#endif
#endif