Struct wayland_protocols::xdg::toplevel_icon::v1::generated::client::xdg_toplevel_icon_manager_v1::XdgToplevelIconManagerV1
source · pub struct XdgToplevelIconManagerV1 {
id: ObjectId,
version: u32,
data: Option<Arc<dyn ObjectData>>,
backend: WeakBackend,
}
Expand description
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.
Fields§
§id: ObjectId
§version: u32
§data: Option<Arc<dyn ObjectData>>
§backend: WeakBackend
Implementations§
source§impl XdgToplevelIconManagerV1
impl XdgToplevelIconManagerV1
sourcepub fn destroy(&self)
pub fn destroy(&self)
destroy the toplevel icon manager
Destroy the toplevel icon manager. This does not destroy objects created with the manager.
sourcepub fn create_icon<U: Send + Sync + 'static, D: Dispatch<XdgToplevelIconV1, U> + 'static>(
&self,
qh: &QueueHandle<D>,
udata: U,
) -> XdgToplevelIconV1
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.
sourcepub fn set_icon(&self, toplevel: &XdgToplevel, icon: Option<&XdgToplevelIconV1>)
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§
source§impl Borrow<ObjectId> for XdgToplevelIconManagerV1
impl Borrow<ObjectId> for XdgToplevelIconManagerV1
source§impl Clone for XdgToplevelIconManagerV1
impl Clone for XdgToplevelIconManagerV1
source§fn clone(&self) -> XdgToplevelIconManagerV1
fn clone(&self) -> XdgToplevelIconManagerV1
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for XdgToplevelIconManagerV1
impl Debug for XdgToplevelIconManagerV1
source§impl Hash for XdgToplevelIconManagerV1
impl Hash for XdgToplevelIconManagerV1
source§impl PartialEq<Weak<XdgToplevelIconManagerV1>> for XdgToplevelIconManagerV1
impl PartialEq<Weak<XdgToplevelIconManagerV1>> for XdgToplevelIconManagerV1
source§impl PartialEq for XdgToplevelIconManagerV1
impl PartialEq for XdgToplevelIconManagerV1
source§fn eq(&self, other: &XdgToplevelIconManagerV1) -> bool
fn eq(&self, other: &XdgToplevelIconManagerV1) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl Proxy for XdgToplevelIconManagerV1
impl Proxy for XdgToplevelIconManagerV1
source§fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
fn data<U: Send + Sync + 'static>(&self) -> Option<&U>
source§fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
fn object_data(&self) -> Option<&Arc<dyn ObjectData>>
source§fn backend(&self) -> &WeakBackend
fn backend(&self) -> &WeakBackend
source§fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>
source§fn send_constructor<I: Proxy>(
&self,
req: Self::Request<'_>,
data: Arc<dyn ObjectData>,
) -> Result<I, InvalidId>
fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>
source§fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>
source§fn inert(backend: WeakBackend) -> Self
fn inert(backend: WeakBackend) -> Self
source§fn parse_event(
conn: &Connection,
msg: Message<ObjectId, OwnedFd>,
) -> Result<(Self, Self::Event), DispatchError>
fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>
source§fn write_request<'a>(
&self,
conn: &Connection,
msg: Self::Request<'a>,
) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>
impl Eq for XdgToplevelIconManagerV1
Auto Trait Implementations§
impl Freeze for XdgToplevelIconManagerV1
impl !RefUnwindSafe for XdgToplevelIconManagerV1
impl Send for XdgToplevelIconManagerV1
impl Sync for XdgToplevelIconManagerV1
impl Unpin for XdgToplevelIconManagerV1
impl !UnwindSafe for XdgToplevelIconManagerV1
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.