Struct ZwlrForeignToplevelHandleV1

pub struct ZwlrForeignToplevelHandleV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

an opened toplevel

A zwlr_foreign_toplevel_handle_v1 object represents an opened toplevel window. Each app may have multiple opened toplevels.

Each toplevel has a list of outputs it is visible on, conveyed to the client with the output_enter and output_leave events.

See also the Request enum for this interface.

Implementations

impl ZwlrForeignToplevelHandleV1

pub fn title(&self, title: String)

title change

This event is emitted whenever the title of the toplevel changes.

pub fn app_id(&self, app_id: String)

app-id change

This event is emitted whenever the app-id of the toplevel changes.

pub fn output_enter(&self, output: &WlOutput)

toplevel entered an output

This event is emitted whenever the toplevel becomes visible on the given output. A toplevel may be visible on multiple outputs.

pub fn output_leave(&self, output: &WlOutput)

toplevel left an output

This event is emitted whenever the toplevel stops being visible on the given output. It is guaranteed that an entered-output event with the same output has been emitted before this event.

pub fn state(&self, state: Vec<u8>)

the toplevel state changed

This event is emitted immediately after the zlw_foreign_toplevel_handle_v1 is created and each time the toplevel state changes, either because of a compositor action or because of a request in this protocol.

pub fn done(&self)

all information about the toplevel has been sent

This event is sent after all changes in the toplevel state have been sent.

This allows changes to the zwlr_foreign_toplevel_handle_v1 properties to be seen as atomic, even if they happen via multiple events.

pub fn closed(&self)

this toplevel has been destroyed

This event means the toplevel has been destroyed. It is guaranteed there won’t be any more events for this zwlr_foreign_toplevel_handle_v1. The toplevel itself becomes inert so any requests will be ignored except the destroy request.

pub fn parent(&self, parent: Option<&ZwlrForeignToplevelHandleV1>)

parent change

This event is emitted whenever the parent of the toplevel changes.

No event is emitted when the parent handle is destroyed by the client.

Trait Implementations

impl Borrow<ObjectId> for ZwlrForeignToplevelHandleV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwlrForeignToplevelHandleV1

fn clone(&self) -> ZwlrForeignToplevelHandleV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwlrForeignToplevelHandleV1

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

Formats the value using the given formatter.

impl Hash for ZwlrForeignToplevelHandleV1

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

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

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

type Request = Request

The request enum for this interface

type Event<'event> = 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: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<ZwlrForeignToplevelHandleV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ZwlrForeignToplevelHandleV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ZwlrForeignToplevelHandleV1, <ZwlrForeignToplevelHandleV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ZwlrForeignToplevelHandleV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

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

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

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

Creates a weak handle to this object

impl Eq for ZwlrForeignToplevelHandleV1