Struct ZxdgToplevelDecorationV1

pub struct ZxdgToplevelDecorationV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

decoration object for a toplevel surface

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.

See also the Event enum for this interface.

Implementations

impl ZxdgToplevelDecorationV1

pub fn destroy(&self)

destroy the decoration object

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

pub fn set_mode(&self, mode: Mode)

set 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.

If an invalid mode is supplied by the client, the invalid_mode protocol error is raised by the compositor.

pub fn unset_mode(&self)

unset the decoration mode

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.

Trait Implementations

impl Borrow<ObjectId> for ZxdgToplevelDecorationV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZxdgToplevelDecorationV1

fn clone(&self) -> ZxdgToplevelDecorationV1

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZxdgToplevelDecorationV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<D> Dispatch<ZxdgToplevelDecorationV1, WindowData, D> for XdgShell

where D: Dispatch<ZxdgToplevelDecorationV1, WindowData> + WindowHandler,

fn event( _: &mut D, decoration: &ZxdgToplevelDecorationV1, event: Event, _: &WindowData, _: &Connection, _: &QueueHandle<D>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Hash for ZxdgToplevelDecorationV1

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ZxdgToplevelDecorationV1>> for ZxdgToplevelDecorationV1

fn eq(&self, other: &Weak<ZxdgToplevelDecorationV1>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ZxdgToplevelDecorationV1

fn eq(&self, other: &ZxdgToplevelDecorationV1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for ZxdgToplevelDecorationV1

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: Send + Sync + 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request( &self, req: <ZxdgToplevelDecorationV1 as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I>( &self, req: <ZxdgToplevelDecorationV1 as Proxy>::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

where I: Proxy,

Send a request for this object that creates another object.

fn from_id( conn: &Connection, id: ObjectId, ) -> Result<ZxdgToplevelDecorationV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ZxdgToplevelDecorationV1

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZxdgToplevelDecorationV1, <ZxdgToplevelDecorationV1 as Proxy>::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <ZxdgToplevelDecorationV1 as Proxy>::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZxdgToplevelDecorationV1