Struct ZcosmicOverlapNotifyV1

pub struct ZcosmicOverlapNotifyV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

get notifications of other elements overlapping layer surfaces

The purpose of this protocol is to enable layer-shell client to get notifications if part of their surfaces are occluded other elements (currently toplevels and other layer-surfaces).

You can request a notification object for any of your zwlr_layer_surface_v1 surfaces, which will then emit overlap events.

This interface has no events.

Implementations

impl ZcosmicOverlapNotifyV1

pub fn notify_on_overlap<U, D>( &self, layer_surface: &ZwlrLayerSurfaceV1, qh: &QueueHandle<D>, udata: U, ) -> ZcosmicOverlapNotificationV1

where U: Send + Sync + 'static, D: Dispatch<ZcosmicOverlapNotificationV1, U> + 'static,

get notified if a layer-shell is obstructed by a toplevel

Requests notifications for toplevels and layer-surfaces entering and leaving the surface-area of the given zwlr_layer_surface_v1. This can be used e.g. to implement auto-hide functionality.

To stop receiving notifications, destroy the returned zcosmic_overlap_notification_v1 object.

Trait Implementations

impl Borrow<ObjectId> for ZcosmicOverlapNotifyV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZcosmicOverlapNotifyV1

fn clone(&self) -> ZcosmicOverlapNotifyV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZcosmicOverlapNotifyV1

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

Formats the value using the given formatter.

impl Hash for ZcosmicOverlapNotifyV1

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

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

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

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

Send a request for this object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ZcosmicOverlapNotifyV1

Create an inert object proxy

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

Parse a event for this object

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