Skip to main content

SessionLock

Struct SessionLock 

Source
pub struct SessionLock { /* private fields */ }
Expand description

A lock screen: while locked is true, the compositor shows only its surfaces, one covering each output, and nothing else gets input. Lock with cx.session_lock from the crabshell crate. Every property takes a value or a closure.

use crabshell_ui::{Color, SessionLock, Style, Text};

let lock = SessionLock::new()
    .locked(true)
    .style(Style::new().background(Color::rgb(0, 0, 0)))
    .surface(|_cx, output| Text::new(format!("locked on {}", output.name())));

Implementations§

Source§

impl SessionLock

Source

pub fn new() -> SessionLock

A lock that never locks, with nothing on its surfaces.

Source

pub fn locked(self, locked: impl IntoProp<bool>) -> SessionLock

Sets whether the session is locked. Turning it false unlocks, as after the user’s password was checked.

Source

pub fn style(self, style: impl IntoProp<Style>) -> SessionLock

Sets the style of every output’s surface. Its color and font are inherited by every Text on them that doesn’t set its own.

Source

pub fn surface<W: Widget>( self, build: impl Fn(&Cx, &Output) -> W + 'static, ) -> SessionLock

Sets what each output’s surface shows: build runs for every output while the session locks, and for each output added while it is locked, under a context that goes with that surface.

Trait Implementations§

Source§

impl Default for SessionLock

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more