Struct ExtForeignToplevelListV1

pub struct ExtForeignToplevelListV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

list toplevels

A toplevel is defined as a surface with a role similar to xdg_toplevel. XWayland surfaces may be treated like toplevels in this protocol.

After a client binds the ext_foreign_toplevel_list_v1, each mapped toplevel window will be sent using the ext_foreign_toplevel_list_v1.toplevel event.

Clients which only care about the current state can perform a roundtrip after binding this global.

For each instance of ext_foreign_toplevel_list_v1, the compositor must create a new ext_foreign_toplevel_handle_v1 object for each mapped toplevel.

If a compositor implementation sends the ext_foreign_toplevel_list_v1.finished event after the global is bound, the compositor must not send any ext_foreign_toplevel_list_v1.toplevel events.

See also the Event enum for this interface.

Implementations

impl ExtForeignToplevelListV1

pub fn stop(&self)

stop sending events

This request indicates that the client no longer wishes to receive events for new toplevels.

The Wayland protocol is asynchronous, meaning the compositor may send further toplevel events until the stop request is processed. The client should wait for a ext_foreign_toplevel_list_v1.finished event before destroying this object.

pub fn destroy(&self)

destroy the ext_foreign_toplevel_list_v1 object

This request should be called either when the client will no longer use the ext_foreign_toplevel_list_v1 or after the finished event has been received to allow destruction of the object.

If a client wishes to destroy this object it should send a ext_foreign_toplevel_list_v1.stop request and wait for a ext_foreign_toplevel_list_v1.finished event, then destroy the handles and then this object.

Trait Implementations

impl Borrow<ObjectId> for ExtForeignToplevelListV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtForeignToplevelListV1

fn clone(&self) -> ExtForeignToplevelListV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtForeignToplevelListV1

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

Formats the value using the given formatter.

impl<D> Dispatch<ExtForeignToplevelListV1, GlobalData, D> for ForeignToplevelList

where D: Dispatch<ExtForeignToplevelListV1, GlobalData> + Dispatch<ExtForeignToplevelHandleV1, ForeignToplevelData> + ForeignToplevelListHandler + 'static,

fn event( state: &mut D, proxy: &ExtForeignToplevelListV1, event: Event, _: &GlobalData, conn: &Connection, qh: &QueueHandle<D>, )

Called when an event from the server is processed

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

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

impl Hash for ExtForeignToplevelListV1

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

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

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

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

Send a request for this object.

fn send_constructor<I>( &self, req: <ExtForeignToplevelListV1 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<ExtForeignToplevelListV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ExtForeignToplevelListV1

Create an inert object proxy

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

Parse a event for this object

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