Struct ForeignToplevelHandle 

pub struct ForeignToplevelHandle { /* private fields */ }

Available on crate feature wayland_frontend only.

Handle of a toplevel, used to update title or app_id, after initial handle creation

eg.

use smithay::wayland::foreign_toplevel_list::ForeignToplevelHandle;
let handle: ForeignToplevelHandle = todo!();

// Handle can be used to update title and app_id
handle.send_title("abc");
handle.send_app_id("com.example");
handle.send_done();

// Handle can also be used to close the window, after this call the handle will become inert,
// and the handle will no longer be announced to clients
handle.send_closed();

Implementations

impl ForeignToplevelHandle

pub fn downgrade(&self) -> ForeignToplevelWeakHandle

Downgrade strong ForeignToplevelHandle to weak ForeignToplevelWeakHandle

pub fn from_resource(resource: &ExtForeignToplevelHandleV1) -> Option<Self>

Attempt to retrieve ForeignToplevelHandle from an existing resource

pub fn resources(&self) -> Vec<ExtForeignToplevelHandleV1>

Retrieve ExtForeignToplevelHandleV1 instances for this handle.

pub fn resources_for_client( &self, client: &Client, ) -> Vec<ExtForeignToplevelHandleV1>

Retrieve ExtForeignToplevelHandleV1 instances for this handle of a given Client.

pub fn user_data(&self) -> &UserDataMap

Access the UserDataMap associated with this ForeignToplevelHandle

pub fn send_title(&self, title: &str)

The title of the toplevel has changed.

Self::send_done has to be called to finalize the update

pub fn send_app_id(&self, app_id: &str)

The app_id of the toplevel has changed.

Self::send_done has to be called to finalize the update

pub fn send_done(&self)

This event is should be sent after all changes in the toplevel state have been sent.

pub fn send_closed(&self)

The toplevel has been closed

pub fn identifier(&self) -> String

A stable identifier for a toplevel

pub fn title(&self) -> String

The title of the toplevel

pub fn app_id(&self) -> String

The app id of the toplevel

pub fn is_closed(&self) -> bool

The toplevel has been closed

Trait Implementations

impl Clone for ForeignToplevelHandle

fn clone(&self) -> ForeignToplevelHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForeignToplevelHandle

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

Formats the value using the given formatter.

impl<D: ForeignToplevelListHandler> Dispatch<ExtForeignToplevelHandleV1, ForeignToplevelHandle, D> for ForeignToplevelListState

fn request( _state: &mut D, _client: &Client, _context: &ExtForeignToplevelHandleV1, request: Request, _data: &ForeignToplevelHandle, _dh: &DisplayHandle, _data_init: &mut DataInit<'_, D>, )

Called when a request from a client is processed.

fn destroyed( _state: &mut D, _client: ClientId, resource: &ExtForeignToplevelHandleV1, handle: &ForeignToplevelHandle, )

Called when the object this user data is associated with has been destroyed.