Enum Request

#[non_exhaustive]
pub enum Request<'a> {
    Destroy,
    SetToplevelTag {
        toplevel: XdgToplevel,
        tag: String,
    },
    SetToplevelDescription {
        toplevel: XdgToplevel,
        description: String,
    },
}

Available on crate feature wayland and Linux only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Destroy

destroy toplevel tag object

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

This is a destructor, once sent this object cannot be used any longer.

SetToplevelTag

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.

Fields

toplevel: XdgToplevel

tag: String

untranslated tag

SetToplevelDescription

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.

Fields

toplevel: XdgToplevel

description: String

translated description

Implementations

impl<'a> Request<'a>

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.