Struct XdgToplevelIconManagerV1

pub struct XdgToplevelIconManagerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

interface to manage toplevel icons

This interface allows clients to create toplevel window icons and set them on toplevel windows to be displayed to the user.

See also the Request enum for this interface.

Implementations

impl XdgToplevelIconManagerV1

pub fn icon_size(&self, size: i32)

describes a supported & preferred icon size

This event indicates an icon size the compositor prefers to be available if the client has scalable icons and can render to any size.

When the ‘xdg_toplevel_icon_manager_v1’ object is created, the compositor may send one or more ‘icon_size’ events to describe the list of preferred icon sizes. If the compositor has no size preference, it may not send any ‘icon_size’ event, and it is up to the client to decide a suitable icon size.

A sequence of ‘icon_size’ events must be finished with a ‘done’ event. If the compositor has no size preferences, it must still send the ‘done’ event, without any preceding ‘icon_size’ events.

pub fn done(&self)

all information has been sent

This event is sent after all ‘icon_size’ events have been sent.

Trait Implementations

impl Borrow<ObjectId> for XdgToplevelIconManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XdgToplevelIconManagerV1

fn clone(&self) -> XdgToplevelIconManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XdgToplevelIconManagerV1

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

Formats the value using the given formatter.

impl Hash for XdgToplevelIconManagerV1

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

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

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

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

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

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