Struct KdeScreenEdgeManagerV1

pub struct KdeScreenEdgeManagerV1 { /* private fields */ }

screen edge manager

This interface allows clients to associate actions with screen edges. For example, showing a surface by moving the pointer to a screen edge.

Potential ways to trigger the screen edge are subject to compositor policies. As an example, the compositor may consider the screen edge to be triggered if the pointer hits its associated screen border. Other ways may include using touchscreen or touchpad gestures.

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 KdeScreenEdgeManagerV1

pub fn destroy(&self)

destroy the screen edge manager

Destroy the screen edge manager. This doesn’t destroy objects created with this manager.

pub fn get_auto_hide_screen_edge<U: Send + Sync + 'static, D: Dispatch<KdeAutoHideScreenEdgeV1, U> + 'static>( &self, border: Border, surface: &WlSurface, qh: &QueueHandle<D>, udata: U, ) -> KdeAutoHideScreenEdgeV1

create an auto hide edge

Create a new auto hide screen edge object associated with the specified surface and the border.

Creating a kde_auto_hide_screen_edge_v1 object does not change the visibility of the surface. The kde_auto_hide_screen_edge_v1.activate request must be issued in order to hide the surface.

The “border” argument must be a valid enum entry, otherwise the invalid_border protocol error is raised.

The invalid_role protocol error will be raised if the specified surface does not have layer_surface role.

Trait Implementations

impl Borrow<ObjectId> for KdeScreenEdgeManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for KdeScreenEdgeManagerV1

fn clone(&self) -> KdeScreenEdgeManagerV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KdeScreenEdgeManagerV1

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

Formats the value using the given formatter.

impl Hash for KdeScreenEdgeManagerV1

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

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

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

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 KdeScreenEdgeManagerV1