Struct Instance 

pub struct Instance { /* private fields */ }

Available on crate feature v1_1 only.

An instance of the object used to control locking the screen. Multiple instances can exist at once, but only one can be locked at a time.

Signals

failed

The ::failed signal is fired when the lock could not be acquired.

locked

The ::locked signal is fired when the screen is successfully locked.

monitor

The ::monitor signal is fired once for each monitor that exists when a lock is started, and then whenever a new monitor is detected during the lock. You generally want to call Instance::assign_window_to_monitor() once in the handler for this signal with a newly created window and the given monitor.

This API does not directly tell you when a monitor is removed (GTK APIs can be used for that), however the window you send to Instance::assign_window_to_monitor() will be automatically unmapped and dereferenced when its monitor is removed or the screen is unlocked.

unlocked

The ::unlocked signal is fired when the session is unlocked, which may have been caused by a call to Instance::unlock() or by the compositor.

GLib type: GObject with reference counted clone semantics.

Implementations

impl Instance

pub fn new() -> Instance

Returns

new session lock instance

pub fn assign_window_to_monitor( &self, window: &impl IsA<Window>, monitor: &Monitor, )

This must be called with a different unrealized window once for each monitor immediately after calling gtk_session_lock_lock(). Hiding a window that is active on a monitor or not letting a window be resized by the library is not allowed (may result in a Wayland protocol error). The window will be unmapped and gtk_window_destroy() called on it when the current lock ends.

window

The GTK Window to use as a lock surface

monitor

The monitor to show it on

pub fn is_locked(&self) -> bool

Returns if this instance currently holds a lock.

pub fn lock(&self) -> bool

Lock the screen. This should be called before assigning any windows to monitors. If this function fails the ::failed signal is emitted, if it succeeds the ::locked signal is emitted. The ::failed signal may be emitted before the function returns (for example, if another Instance holds a lock) or later (if another process holds a lock). The only case where neither signal is triggered is if the instance is already locked.

Returns

false on immediate fail, true if lock acquisition was successfully started

pub fn unlock(&self)

If the screen is locked by this instance unlocks it and fires ::unlocked. Otherwise has no effect

pub fn connect_failed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

The ::failed signal is fired when the lock could not be acquired.

pub fn connect_locked<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

The ::locked signal is fired when the screen is successfully locked.

pub fn connect_monitor<F: Fn(&Self, &Monitor) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_2 only.

The ::monitor signal is fired once for each monitor that exists when a lock is started, and then whenever a new monitor is detected during the lock. You generally want to call assign_window_to_monitor() once in the handler for this signal with a newly created window and the given monitor.

This API does not directly tell you when a monitor is removed (GTK APIs can be used for that), however the window you send to assign_window_to_monitor() will be automatically unmapped and dereferenced when its monitor is removed or the screen is unlocked.

monitor

the gdk::Monitor that exists or was added

pub fn connect_unlocked<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

The ::unlocked signal is fired when the session is unlocked, which may have been caused by a call to unlock() or by the compositor.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Instance

type ParamSpec = ParamSpecObject

type SetValue = Instance

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, Instance>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Instance

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

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 Ord for Instance

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Instance

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Instance

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for Instance

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Instance

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Instance