Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(500)

Unified Diff: third_party/wayland-protocols/include/protocol/remote-shell-unstable-v1-server-protocol.h

Issue 2062133002: third_party: Update to version 6 of remote_shell_protocol (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/wayland-protocols/include/protocol/remote-shell-unstable-v1-server-protocol.h
diff --git a/third_party/wayland-protocols/include/protocol/remote-shell-unstable-v1-server-protocol.h b/third_party/wayland-protocols/include/protocol/remote-shell-unstable-v1-server-protocol.h
index 3a2a1712a2338cc5856a23f1b56ee9d920f973b8..8e0592bc1e994732919e92da8fe21be324dc05f5 100644
--- a/third_party/wayland-protocols/include/protocol/remote-shell-unstable-v1-server-protocol.h
+++ b/third_party/wayland-protocols/include/protocol/remote-shell-unstable-v1-server-protocol.h
@@ -1,56 +1,17 @@
-/* Generated by wayland-scanner 1.11.0 */
-
-#ifndef REMOTE_SHELL_UNSTABLE_V1_SERVER_PROTOCOL_H
-#define REMOTE_SHELL_UNSTABLE_V1_SERVER_PROTOCOL_H
-
-#include <stdint.h>
-#include <stddef.h>
-#include "wayland-server.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-struct wl_client;
-struct wl_resource;
-
-/**
- * @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_zwp_remote_shell_v1 - remote_shell
- * - @subpage page_iface_zwp_remote_surface_v1 - A desktop 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
@@ -58,84 +19,42 @@ struct wl_resource;
* 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;
+
+#ifndef REMOTE_SHELL_UNSTABLE_V1_SERVER_PROTOCOL_H
+#define REMOTE_SHELL_UNSTABLE_V1_SERVER_PROTOCOL_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdint.h>
+#include <stddef.h>
+#include "wayland-util.h"
+
+struct wl_client;
+struct wl_resource;
+
struct zwp_remote_shell_v1;
struct zwp_remote_surface_v1;
+struct zwp_notification_surface_v1;
-/**
- * @page page_iface_zwp_remote_shell_v1 zwp_remote_shell_v1
- * @section page_iface_zwp_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_zwp_remote_shell_v1_api API
- * See @ref iface_zwp_remote_shell_v1.
- */
-/**
- * @defgroup iface_zwp_remote_shell_v1 The zwp_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 zwp_remote_shell_v1_interface;
-/**
- * @page page_iface_zwp_remote_surface_v1 zwp_remote_surface_v1
- * @section page_iface_zwp_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_zwp_remote_surface_v1_api API
- * See @ref iface_zwp_remote_surface_v1.
- */
-/**
- * @defgroup iface_zwp_remote_surface_v1 The zwp_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 zwp_remote_surface_v1_interface;
+extern const struct wl_interface zwp_notification_surface_v1_interface;
#ifndef ZWP_REMOTE_SHELL_V1_CONTAINER_ENUM
#define ZWP_REMOTE_SHELL_V1_CONTAINER_ENUM
/**
- * @ingroup iface_zwp_remote_shell_v1
- * containers for remote surfaces
+ * zwp_remote_shell_v1_container - containers for remote surfaces
+ * @ZWP_REMOTE_SHELL_V1_CONTAINER_DEFAULT: default container
+ * @ZWP_REMOTE_SHELL_V1_CONTAINER_OVERLAY: system modal container
*
* Determine how a remote surface should be stacked relative to other
* shell surfaces.
*/
enum zwp_remote_shell_v1_container {
- /**
- * default container
- */
ZWP_REMOTE_SHELL_V1_CONTAINER_DEFAULT = 1,
- /**
- * system modal container
- */
ZWP_REMOTE_SHELL_V1_CONTAINER_OVERLAY = 2,
};
#endif /* ZWP_REMOTE_SHELL_V1_CONTAINER_ENUM */
@@ -143,20 +62,24 @@ enum zwp_remote_shell_v1_container {
#ifndef ZWP_REMOTE_SHELL_V1_ERROR_ENUM
#define ZWP_REMOTE_SHELL_V1_ERROR_ENUM
enum zwp_remote_shell_v1_error {
- /**
- * given wl_surface has another role
- */
ZWP_REMOTE_SHELL_V1_ERROR_ROLE = 0,
};
#endif /* ZWP_REMOTE_SHELL_V1_ERROR_ENUM */
/**
- * @ingroup iface_zwp_remote_shell_v1
- * @struct zwp_remote_shell_v1_interface
+ * zwp_remote_shell_v1 - remote_shell
+ * @destroy: destroy remote_shell
+ * @get_remote_surface: create a remote shell surface from a surface
+ * @get_notification_surface: create a notification surface from a
+ * surface
+ *
+ * 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.
*/
struct zwp_remote_shell_v1_interface {
/**
- * destroy remote_shell
+ * destroy - destroy remote_shell
*
* Destroy this remote_shell object.
*
@@ -167,7 +90,11 @@ struct zwp_remote_shell_v1_interface {
void (*destroy)(struct wl_client *client,
struct wl_resource *resource);
/**
- * create a remote shell surface from a surface
+ * get_remote_surface - create a remote shell surface from a
+ * surface
+ * @id: (none)
+ * @surface: (none)
+ * @container: (none)
*
* This creates an remote_surface for the given surface and gives
* it the remote_surface role. A wl_surface can only be given a
@@ -183,36 +110,34 @@ struct zwp_remote_shell_v1_interface {
uint32_t id,
struct wl_resource *surface,
uint32_t container);
+ /**
+ * get_notification_surface - create a notification surface from
+ * a surface
+ * @id: (none)
+ * @surface: (none)
+ * @notification_id: (none)
+ *
+ * Creates a notification_surface for the given surface, gives it
+ * the notification_surface role and associated it with a
+ * notification id.
+ * @since: 4
+ */
+ void (*get_notification_surface)(struct wl_client *client,
+ struct wl_resource *resource,
+ uint32_t id,
+ struct wl_resource *surface,
+ const char *notification_id);
};
#define ZWP_REMOTE_SHELL_V1_CONFIGURE 0
#define ZWP_REMOTE_SHELL_V1_ACTIVATED 1
-/**
- * @ingroup iface_zwp_remote_shell_v1
- */
-#define ZWP_REMOTE_SHELL_V1_CONFIGURE_SINCE_VERSION 1
-/**
- * @ingroup iface_zwp_remote_shell_v1
- */
-#define ZWP_REMOTE_SHELL_V1_ACTIVATED_SINCE_VERSION 1
-
-/**
- * @ingroup iface_zwp_remote_shell_v1
- * Sends an configure event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_shell_v1_send_configure(struct wl_resource *resource_, int32_t width, int32_t height, int32_t work_area_inset_left, int32_t work_area_inset_top, int32_t work_area_inset_right, int32_t work_area_inset_bottom)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SHELL_V1_CONFIGURE, width, height, work_area_inset_left, work_area_inset_top, work_area_inset_right, work_area_inset_bottom);
}
-/**
- * @ingroup iface_zwp_remote_shell_v1
- * Sends an activated event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_shell_v1_send_activated(struct wl_resource *resource_, struct wl_resource *gained_active, struct wl_resource *lost_active)
{
@@ -220,12 +145,35 @@ zwp_remote_shell_v1_send_activated(struct wl_resource *resource_, struct wl_reso
}
/**
- * @ingroup iface_zwp_remote_surface_v1
- * @struct zwp_remote_surface_v1_interface
+ * zwp_remote_surface_v1 - A desktop window
+ * @destroy: Destroy the remote_surface
+ * @set_app_id: set application ID
+ * @set_window_geometry: set the new window geometry
+ * @set_scale: set scale
+ * @fullscreen: fullscreen
+ * @maximize: maximize
+ * @minimize: minimize
+ * @restore: restore
+ * @pin: pin
+ * @unpin: unpin
+ * @unfullscreen: unfullscreen
+ *
+ * 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.
*/
struct zwp_remote_surface_v1_interface {
/**
- * Destroy the remote_surface
+ * destroy - Destroy the remote_surface
*
* Unmap and destroy the window. The window will be effectively
* hidden from the user's point of view, and all state will be
@@ -234,7 +182,8 @@ struct zwp_remote_surface_v1_interface {
void (*destroy)(struct wl_client *client,
struct wl_resource *resource);
/**
- * set application ID
+ * set_app_id - set application ID
+ * @app_id: (none)
*
* Set an application identifier for the surface.
*/
@@ -242,7 +191,11 @@ struct zwp_remote_surface_v1_interface {
struct wl_resource *resource,
const char *app_id);
/**
- * set the new window geometry
+ * set_window_geometry - set the new window geometry
+ * @x: (none)
+ * @y: (none)
+ * @width: (none)
+ * @height: (none)
*
* The window geometry of a window is its "visible bounds" from
* the user's perspective. Client-side decorations often have
@@ -272,7 +225,8 @@ struct zwp_remote_surface_v1_interface {
int32_t width,
int32_t height);
/**
- * set scale
+ * set_scale - set scale
+ * @scale: (none)
*
* Set a scale factor that will be applied to surface and all
* descendants.
@@ -281,7 +235,7 @@ struct zwp_remote_surface_v1_interface {
struct wl_resource *resource,
wl_fixed_t scale);
/**
- * fullscreen
+ * fullscreen - fullscreen
*
* Request that surface is made fullscreen.
*
@@ -289,12 +243,12 @@ struct zwp_remote_surface_v1_interface {
* 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.
- * @since 2
+ * @since: 2
*/
void (*fullscreen)(struct wl_client *client,
struct wl_resource *resource);
/**
- * maximize
+ * maximize - maximize
*
* Request that surface is maximized. The window geometry will be
* updated to whatever the compositor finds appropriate for a
@@ -304,12 +258,12 @@ struct zwp_remote_surface_v1_interface {
* compositor may choose to ignore this request. The client should
* listen to set_maximized events to determine if the window was
* maximized or not.
- * @since 2
+ * @since: 2
*/
void (*maximize)(struct wl_client *client,
struct wl_resource *resource);
/**
- * minimize
+ * minimize - minimize
*
* Request that surface is minimized.
*
@@ -317,12 +271,12 @@ struct zwp_remote_surface_v1_interface {
* compositor may choose to ignore this request. The client should
* listen to set_minimized events to determine if the window was
* minimized or not.
- * @since 2
+ * @since: 2
*/
void (*minimize)(struct wl_client *client,
struct wl_resource *resource);
/**
- * restore
+ * restore - restore
*
* Request that surface is restored. This restores the window
* geometry to what it was before the window was minimized,
@@ -332,12 +286,12 @@ struct zwp_remote_surface_v1_interface {
* 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.
- * @since 2
+ * @since: 2
*/
void (*restore)(struct wl_client *client,
struct wl_resource *resource);
/**
- * pin
+ * pin - pin
*
* Request that surface is pinned.
*
@@ -345,12 +299,12 @@ struct zwp_remote_surface_v1_interface {
* compositor may choose to ignore this request. The client should
* listen to set_pinned events to determine if the window was
* pinned or not.
- * @since 3
+ * @since: 3
*/
void (*pin)(struct wl_client *client,
struct wl_resource *resource);
/**
- * unpin
+ * unpin - unpin
*
* Request that surface is unpinned.
*
@@ -358,12 +312,12 @@ struct zwp_remote_surface_v1_interface {
* compositor may choose to ignore this request. The client should
* listen to unset_pinned events to determine if the window was
* unpinned or not.
- * @since 3
+ * @since: 3
*/
void (*unpin)(struct wl_client *client,
struct wl_resource *resource);
/**
- * unfullscreen
+ * unfullscreen - unfullscreen
*
* Request that surface is made unfullscreen.
*
@@ -371,7 +325,7 @@ struct zwp_remote_surface_v1_interface {
* 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.
- * @since 3
+ * @since: 3
*/
void (*unfullscreen)(struct wl_client *client,
struct wl_resource *resource);
@@ -389,172 +343,89 @@ struct zwp_remote_surface_v1_interface {
#define ZWP_REMOTE_SURFACE_V1_SET_PINNED 9
#define ZWP_REMOTE_SURFACE_V1_UNSET_PINNED 10
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_SET_FULLSCREEN_SINCE_VERSION 1
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_UNSET_FULLSCREEN_SINCE_VERSION 1
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_CLOSE_SINCE_VERSION 1
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_SET_MAXIMIZED_SINCE_VERSION 2
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_UNSET_MAXIMIZED_SINCE_VERSION 2
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_SET_MINIMIZED_SINCE_VERSION 2
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_UNSET_MINIMIZED_SINCE_VERSION 2
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_SET_PIN_SINCE_VERSION 3
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_UNSET_PIN_SINCE_VERSION 3
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_SET_PINNED_SINCE_VERSION 3
-/**
- * @ingroup iface_zwp_remote_surface_v1
- */
-#define ZWP_REMOTE_SURFACE_V1_UNSET_PINNED_SINCE_VERSION 3
-
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an set_fullscreen event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_set_fullscreen(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_SET_FULLSCREEN);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an unset_fullscreen event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_unset_fullscreen(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_UNSET_FULLSCREEN);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an close event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_close(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_CLOSE);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an set_maximized event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_set_maximized(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_SET_MAXIMIZED);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an unset_maximized event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_unset_maximized(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_UNSET_MAXIMIZED);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an set_minimized event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_set_minimized(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_SET_MINIMIZED);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an unset_minimized event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_unset_minimized(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_UNSET_MINIMIZED);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an set_pin event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_set_pin(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_SET_PIN);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an unset_pin event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_unset_pin(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_UNSET_PIN);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an set_pinned event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_set_pinned(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_SET_PINNED);
}
-/**
- * @ingroup iface_zwp_remote_surface_v1
- * Sends an unset_pinned event to the client owning the resource.
- * @param resource_ The client's resource
- */
static inline void
zwp_remote_surface_v1_send_unset_pinned(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, ZWP_REMOTE_SURFACE_V1_UNSET_PINNED);
}
+/**
+ * zwp_notification_surface_v1 - A notification window
+ * @destroy: Destroy the notification_surface
+ *
+ * An interface that may be implemented by a wl_surface to host
+ * notification contents.
+ */
+struct zwp_notification_surface_v1_interface {
+ /**
+ * destroy - Destroy the notification_surface
+ *
+ * Unmap and destroy the notification surface.
+ */
+ void (*destroy)(struct wl_client *client,
+ struct wl_resource *resource);
+};
+
#ifdef __cplusplus
}
#endif

Powered by Google App Engine
This is Rietveld 408576698