Struct XwaylandShellV1

pub struct XwaylandShellV1 { /* private fields */ }

Available on crate features staging and client only.

context object for Xwayland shell

xwayland_shell_v1 is a singleton global object that provides the ability to create a xwayland_surface_v1 object for a given wl_surface.

This interface is intended to be bound by the Xwayland server.

A compositor must not allow clients other than Xwayland to bind to this interface. A compositor should hide this global from other clients’ wl_registry. A client the compositor does not consider to be an Xwayland server attempting to bind this interface will result in an implementation-defined error.

An Xwayland server that has bound this interface must not set the WL_SURFACE_ID atom on a window.

This interface has no events.

Implementations

impl XwaylandShellV1

pub fn destroy(&self)

destroy the Xwayland shell object

Destroy the xwayland_shell_v1 object.

The child objects created via this interface are unaffected.

pub fn get_xwayland_surface<U: Send + Sync + 'static, D: Dispatch<XwaylandSurfaceV1, U> + 'static>( &self, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> XwaylandSurfaceV1

assign the xwayland_surface surface role

Create an xwayland_surface_v1 interface for a given wl_surface object and gives it the xwayland_surface role.

It is illegal to create an xwayland_surface_v1 for a wl_surface which already has an assigned role and this will result in the role protocol error.

See the documentation of xwayland_surface_v1 for more details about what an xwayland_surface_v1 is and how it is used.

Trait Implementations

impl Borrow<ObjectId> for XwaylandShellV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XwaylandShellV1

fn clone(&self) -> XwaylandShellV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XwaylandShellV1

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

Formats the value using the given formatter.

impl Hash for XwaylandShellV1

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

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<XwaylandShellV1>> for XwaylandShellV1

fn eq(&self, other: &Weak<XwaylandShellV1>) -> 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 XwaylandShellV1

fn eq(&self, other: &XwaylandShellV1) -> 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 XwaylandShellV1

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: Send + Sync + 'static>(&self) -> Option<&U>

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: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

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

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::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 XwaylandShellV1