Struct wayland_protocols_wlr::input_inhibitor::v1::client::zwlr_input_inhibit_manager_v1::ZwlrInputInhibitManagerV1

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

inhibits input events to other clients

Clients can use this interface to prevent input events from being sent to any surfaces but its own, which is useful for example in lock screen software. It is assumed that access to this interface will be locked down to whitelisted clients by the compositor.

Note! This protocol is deprecated and not intended for production use. For screen lockers, use the ext-session-lock-v1 protocol.

This interface has no events.

Fields

id: ObjectId

version: u32

data: Option<Arc<dyn ObjectData>>

backend: WeakBackend

Implementations

impl ZwlrInputInhibitManagerV1

pub fn get_inhibitor<U: Send + Sync + 'static, D: Dispatch<ZwlrInputInhibitorV1, U> + 'static>( &self, qh: &QueueHandle<D>, udata: U, ) -> ZwlrInputInhibitorV1

inhibit input to other clients

Activates the input inhibitor. As long as the inhibitor is active, the compositor will not send input events to other clients.

Trait Implementations

impl Borrow<ObjectId> for ZwlrInputInhibitManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwlrInputInhibitManagerV1

fn clone(&self) -> ZwlrInputInhibitManagerV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwlrInputInhibitManagerV1

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

Formats the value using the given formatter.

impl Hash for ZwlrInputInhibitManagerV1

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

fn eq(&self, other: &Weak<ZwlrInputInhibitManagerV1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ZwlrInputInhibitManagerV1

fn eq(&self, other: &ZwlrInputInhibitManagerV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for ZwlrInputInhibitManagerV1

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 ZwlrInputInhibitManagerV1