Struct XdgToplevelIconManagerV1

pub struct XdgToplevelIconManagerV1 { /* private fields */ }

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 Event enum for this interface.

Implementations

impl XdgToplevelIconManagerV1

pub fn destroy(&self)

destroy the toplevel icon manager

Destroy the toplevel icon manager. This does not destroy objects created with the manager.

pub fn create_icon<U: Send + Sync + 'static, D: Dispatch<XdgToplevelIconV1, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U, ) -> XdgToplevelIconV1

create a new icon instance

Creates a new icon object. This icon can then be attached to a xdg_toplevel via the ‘set_icon’ request.

pub fn set_icon(&self, toplevel: &XdgToplevel, icon: Option<&XdgToplevelIconV1>)

set an icon on a toplevel window

This request assigns the icon ‘icon’ to ‘toplevel’, or clears the toplevel icon if ‘icon’ was null. This state is double-buffered and is applied on the next wl_surface.commit of the toplevel.

After making this call, the xdg_toplevel_icon_v1 provided as ‘icon’ can be destroyed by the client without ‘toplevel’ losing its icon. The xdg_toplevel_icon_v1 is immutable from this point, and any future attempts to change it must raise the ‘xdg_toplevel_icon_v1.immutable’ protocol error.

The compositor must set the toplevel icon from either the pixel data the icon provides, or by loading a stock icon using the icon name. See the description of ‘xdg_toplevel_icon_v1’ for details.

If ‘icon’ is set to null, the icon of the respective toplevel is reset to its default icon (usually the icon of the application, derived from its desktop-entry file, or a placeholder icon). If this request is passed an icon with no pixel buffers or icon name assigned, the icon must be reset just like if ‘icon’ was null.

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 copy 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

Formats the value using the given formatter.

impl Hash for XdgToplevelIconManagerV1

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

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 XdgToplevelIconManagerV1