Struct ZcosmicToplevelInfoV1

pub struct ZcosmicToplevelInfoV1 { /* private fields */ }

list toplevels and properties thereof

The purpose of this protocol is to enable clients such as taskbars or docks to access a list of opened applications and basic properties thereof.

It thus extends ext_foreign_toplevel_v1 to provide more information and actions on foreign toplevels.

See also the Request enum for this interface.

Implementations

impl ZcosmicToplevelInfoV1

pub fn toplevel(&self, toplevel: &ZcosmicToplevelHandleV1)

a toplevel has been created

This event is never emitted for clients binding version 2 of this protocol, they should use get_cosmic_toplevel instead.

This event is emitted for clients binding version 1 whenever a new toplevel window is created. It is emitted for all toplevels, regardless of the app that has created them.

All initial properties of the toplevel (title, app_id, states, etc.) will be sent immediately after this event via the corresponding events in zcosmic_toplevel_handle_v1.

pub fn finished(&self)

the compositor has finished with the toplevel manager

This event indicates that the compositor is done sending events to the zcosmic_toplevel_info_v1. The server will destroy the object immediately after sending this request, so it will become invalid and the client should free any resources associated with it.

Note: This event is emitted immediately after calling stop for clients binding version 2 of this protocol for backwards compatibility.

pub fn done(&self)

all information about active toplevels have been sent

This event is sent after all changes for currently active zcosmic_toplevel_handle_v1 have been sent.

This allows changes to multiple zcosmic_toplevel_handle_v1 handles and their properties to be seen as atomic, even if they happen via multiple events.

Trait Implementations

impl Borrow<ObjectId> for ZcosmicToplevelInfoV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicToplevelInfoV1

fn clone(&self) -> ZcosmicToplevelInfoV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicToplevelInfoV1

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

Formats the value using the given formatter.

impl Hash for ZcosmicToplevelInfoV1

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

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

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

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

Access the user-data associated with this object

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

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<Self, InvalidId>

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: Self::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 ZcosmicToplevelInfoV1