xdg_decoration_unstable_v1

• # zxdg_decoration_manager_v1

  This interface allows a compositor to announce support for server-side decorations. A window decoration is a set of window controls as deemed appropriate by the party managing them, such as user interface components used to move, resize and change a window's state. A client can use this protocol to request being decorated by a supporting compositor. If compositor and client do not negotiate the use of a server-side decoration using this protocol, clients continue to self-decorate as they see fit. 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.

  Requests

  • #

    destroy

    destroy the decoration manager object
    void zxdg_decoration_manager_v1_destroy(

    struct zxdg_decoration_manager_v1* zxdg_decoration_manager_v1

    )
    Destroy the decoration manager. This doesn't destroy objects created with the manager.
  • #

    get_toplevel_decoration

    create a new toplevel decoration object
    struct zxdg_toplevel_decoration_v1* zxdg_decoration_manager_v1_get_toplevel_decoration(

    struct zxdg_decoration_manager_v1* zxdg_decoration_manager_v1,

    struct xdg_toplevel* toplevel

    )
    Create a new decoration object associated with the given toplevel. Creating an xdg_toplevel_decoration from an xdg_toplevel which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg_toplevel_decoration.configure event must also be treated as errors.

• # zxdg_toplevel_decoration_v1

  The decoration object allows the compositor to toggle server-side window decorations for a toplevel surface. The client can request to switch to another mode. The xdg_toplevel_decoration object must be destroyed before its xdg_toplevel.

  Requests

  • #

    destroy

    destroy the decoration object
    void zxdg_toplevel_decoration_v1_destroy(

    struct zxdg_toplevel_decoration_v1* zxdg_toplevel_decoration_v1

    )
    Switch back to a mode without any server-side decorations at the next commit.
  • #

    set_mode

    set the decoration mode
    void zxdg_toplevel_decoration_v1_set_mode(

    struct zxdg_toplevel_decoration_v1* zxdg_toplevel_decoration_v1,

    uint32_t mode /* the decoration mode */

    )
    Set the toplevel surface decoration mode. This informs the compositor that the client prefers the provided decoration mode. After requesting a decoration mode, the compositor will respond by emitting an xdg_surface.configure event. The client should then update its content, drawing it without decorations if the received mode is server-side decorations. The client must also acknowledge the configure when committing the new content (see xdg_surface.ack_configure). The compositor can decide not to use the client's mode and enforce a different mode instead. Clients whose decoration mode depend on the xdg_toplevel state may send a set_mode request in response to an xdg_surface.configure event and wait for the next xdg_surface.configure event to prevent unwanted state. Such clients are responsible for preventing configure loops and must make sure not to send multiple successive set_mode requests with the same decoration mode.
  • #

    unset_mode

    unset the decoration mode
    void zxdg_toplevel_decoration_v1_unset_mode(

    struct zxdg_toplevel_decoration_v1* zxdg_toplevel_decoration_v1

    )
    Unset the toplevel surface decoration mode. This informs the compositor that the client doesn't prefer a particular decoration mode. This request has the same semantics as set_mode.

  Events

  • #

    configure

    notify a decoration mode change
    uint32_t mode /* the decoration mode */
    The configure event configures the effective decoration mode. The configured state should not be applied immediately. Clients must send an ack_configure in response to this event. See xdg_surface.configure and xdg_surface.ack_configure for details. A configure event can be sent at any time. The specified mode must be obeyed by the client.

  Enums

  • #

    error
    ZXDG_TOPLEVEL_DECORATION_V1_ERROR_UNCONFIGURED_BUFFER /* xdg_toplevel has a buffer attached before configure */
    ZXDG_TOPLEVEL_DECORATION_V1_ERROR_ALREADY_CONSTRUCTED /* xdg_toplevel already has a decoration object */
    ZXDG_TOPLEVEL_DECORATION_V1_ERROR_ORPHANED /* xdg_toplevel destroyed before the decoration object */
  • #

    mode

    window decoration modes
    ZXDG_TOPLEVEL_DECORATION_V1_MODE_CLIENT_SIDE /* no server-side window decoration */
    ZXDG_TOPLEVEL_DECORATION_V1_MODE_SERVER_SIDE /* server-side window decoration */
    These values describe window decoration modes.

Copyright Info