Struct KdeAutoHideScreenEdgeV1 

pub struct KdeAutoHideScreenEdgeV1 {
    id: ObjectId,
    version: u32,
    data: Option<Arc<dyn ObjectData>>,
    backend: WeakBackend,
}

auto hide screen edge

The auto hide screen edge object allows to hide the surface and make it visible by triggering the screen edge. The screen edge is inactive and the surface is visible by default.

This interface can be used to implement user interface elements such as auto-hide panels or docks.

kde_auto_hide_screen_edge_v1.activate activates the screen edge and makes the surface hidden. The surface can be made visible by triggering the screen edge or calling kde_auto_hide_screen_edge_v1.deactivate.

If the screen edge has been triggered, it won’t be re-activated again. Another kde_auto_hide_screen_edge_v1.activate request must be made by the client to activate the screen edge.

This interface has no events.

Fields

id: ObjectId

version: u32

data: Option<Arc<dyn ObjectData>>

backend: WeakBackend

Implementations

impl KdeAutoHideScreenEdgeV1

pub fn destroy(&self)

destroy the auto hide screen edge object

Destroy the auto hide screen edge object. If the screen edge is active, it will be deactivated and the surface will be made visible.

pub fn deactivate(&self)

deactivate the screen edge

Deactivate the screen edge. The surface will be made visible.

pub fn activate(&self)

activate the screen edge

Activate the screen edge. The surface will be hidden until the screen edge is triggered.

Trait Implementations

impl Borrow<ObjectId> for KdeAutoHideScreenEdgeV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for KdeAutoHideScreenEdgeV1

fn clone(&self) -> KdeAutoHideScreenEdgeV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KdeAutoHideScreenEdgeV1

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

Formats the value using the given formatter.

impl Hash for KdeAutoHideScreenEdgeV1

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

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

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

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 KdeAutoHideScreenEdgeV1