Struct XdgToplevelTagManagerV1

pub struct XdgToplevelTagManagerV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

protocol for setting toplevel tags

In order to make some window properties like position, size, “always on top” or user defined rules for window behavior persistent, the compositor needs some way to identify windows even after the application has been restarted. This protocol allows clients to make this possible by setting a tag for toplevels.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

This interface has no events.

Implementations

impl XdgToplevelTagManagerV1

pub fn destroy(&self)

destroy toplevel tag object

Destroy this toplevel tag manager object. This request has no other effects.

pub fn set_toplevel_tag(&self, toplevel: &XdgToplevel, tag: String)

set tag

Set a tag for a toplevel. The tag may be shown to the user in UI, so it’s preferable for it to be human readable, but it must be suitable for configuration files and should not be translated. Suitable tags would for example be “main window”, “settings”, “e-mail composer” or similar.

The tag does not need to be unique across applications, and the client may set the same tag for multiple windows, for example if the user has opened the same UI twice. How the potentially resulting conflicts are handled is compositor policy.

The client should set the tag as part of the initial commit on the associated toplevel, but it may set it at any time afterwards as well, for example if the purpose of the toplevel changes.

pub fn set_toplevel_description( &self, toplevel: &XdgToplevel, description: String, )

set description

Set a description for a toplevel. This description may be shown to the user in UI or read by a screen reader for accessibility purposes, and should be translated. It is recommended to make the description the translation of the tag.

The client should set the description as part of the initial commit on the associated toplevel, but it may set it at any time afterwards as well, for example if the purpose of the toplevel changes.

Trait Implementations

impl Borrow<ObjectId> for XdgToplevelTagManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XdgToplevelTagManagerV1

fn clone(&self) -> XdgToplevelTagManagerV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XdgToplevelTagManagerV1

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

Formats the value using the given formatter.

impl Hash for XdgToplevelTagManagerV1

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

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

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

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

Send a request for this object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> XdgToplevelTagManagerV1

Create an inert object proxy

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

Parse a event for this object

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