Struct KdeLockscreenOverlayV1

pub struct KdeLockscreenOverlayV1 { /* private fields */ }

Allow surfaces over the lockscreen

Allows a client to request a surface to be visible when the system is locked.

This is meant to be used for specific high urgency cases like phone calls or alarms.

Warning! The protocol described in this file is a desktop environment implementation detail. Regular clients must not use this protocol. Backward incompatible changes may be added without bumping the major version of the extension.

This interface has no events.

Implementations

impl KdeLockscreenOverlayV1

pub fn allow(&self, surface: &WlSurface)

Tell about which surface could be raised above the lockscreen

Informs the compositor that the surface could be shown when the screen is locked. This request should be called while the surface is unmapped.

pub fn destroy(&self)

Destroy the kde_lockscreen_overlay_v1

This won’t affect the surface previously marked with the allow request.

Trait Implementations

impl Borrow<ObjectId> for KdeLockscreenOverlayV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for KdeLockscreenOverlayV1

fn clone(&self) -> KdeLockscreenOverlayV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KdeLockscreenOverlayV1

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

Formats the value using the given formatter.

impl Hash for KdeLockscreenOverlayV1

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

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

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

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 KdeLockscreenOverlayV1