Struct LockSelection 

pub struct LockSelection<'a> { /* private fields */ }

A selection of session lock surfaces matching a selector

Provides methods to interact with all matching lock surfaces at once. Created via Shell::select_lock().

Implementations

impl<'a> LockSelection<'a>

pub fn on_callback<F, R>(&self, callback_name: &str, handler: F) -> &Self

where F: Fn(CallbackContext) -> R + Clone + 'static, R: IntoValue,

Registers a callback handler for all matching lock surfaces

Handler receives a CallbackContext with surface identity and shell control. Callbacks are stored and applied when the lock is activated, and automatically applied to new surfaces when outputs are hotplugged during an active lock.

pub fn on_callback_with_args<F, R>( &self, callback_name: &str, handler: F, ) -> &Self

where F: Fn(&[Value], CallbackContext) -> R + Clone + 'static, R: IntoValue,

Registers a callback handler that receives arguments for all matching lock surfaces

pub fn with_component<F>(&self, f: F)

where F: FnMut(&ComponentInstance),

Executes a function with each matching lock component instance

Returns immediately if no lock surfaces are active. During activation, this iterates over all lock component instances matching the selector.

pub fn set_property(&self, name: &str, value: &Value) -> Result<(), Error>

Sets a property value on all matching lock surfaces

If the lock is inactive, the property operation is stored and will be applied when the lock is activated. If the lock is active, the property is set immediately on all matching component instances.

pub fn get_property(&self, name: &str) -> Result<Vec<Value>, Error>

Gets property values from all matching lock surfaces

Returns an empty vector if the lock is inactive.

pub fn count(&self) -> usize

Returns the number of lock surfaces matching the selector

Returns 0 if the lock is inactive.

pub fn is_empty(&self) -> bool

Checks if no lock surfaces match the selector

Returns true if the lock is inactive or no surfaces match the selector.

pub fn info(&self) -> Vec<SurfaceInfo>

Returns information about all matching lock surfaces

Returns an empty vector if the lock is inactive.