Enum KeyboardInteractivity

#[non_exhaustive]
#[repr(u32)]
pub enum KeyboardInteractivity {
    None = 0,
    Exclusive = 1,
    OnDemand = 2,
}

Available on crate feature client only.

types of keyboard interaction possible for a layer shell surface

Types of keyboard interaction possible for layer shell surfaces. The rationale for this is twofold: (1) some applications are not interested in keyboard events and not allowing them to be focused can improve the desktop experience; (2) some applications will want to take exclusive keyboard focus.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None = 0

no keyboard focus is possible

This value indicates that this surface is not interested in keyboard events and the compositor should never assign it the keyboard focus.

This is the default value, set for newly created layer shell surfaces.

This is useful for e.g. desktop widgets that display information or only have interaction with non-keyboard input devices.

Exclusive = 1

request exclusive keyboard focus

Request exclusive keyboard focus if this surface is above the shell surface layer.

For the top and overlay layers, the seat will always give exclusive keyboard focus to the top-most layer which has keyboard interactivity set to exclusive. If this layer contains multiple surfaces with keyboard interactivity set to exclusive, the compositor determines the one receiving keyboard events in an implementation- defined manner. In this case, no guarantee is made when this surface will receive keyboard focus (if ever).

For the bottom and background layers, the compositor is allowed to use normal focus semantics.

This setting is mainly intended for applications that need to ensure they receive all keyboard events, such as a lock screen or a password prompt.

OnDemand = 2

request regular keyboard focus semantics

This requests the compositor to allow this surface to be focused and unfocused by the user in an implementation-defined manner. The user should be able to unfocus this surface even regardless of the layer it is on.

Typically, the compositor will want to use its normal mechanism to manage keyboard focus between layer shell surfaces with this setting and regular toplevels on the desktop layer (e.g. click to focus). Nevertheless, it is possible for a compositor to require a special interaction to focus or unfocus layer shell surfaces (e.g. requiring a click even if focus follows the mouse normally, or providing a keybinding to switch focus between layers).

This setting is mainly intended for desktop shell components (e.g. panels) that allow keyboard interaction. Using this option can allow implementing a desktop shell that can be fully usable without the mouse.

Trait Implementations

impl Clone for KeyboardInteractivity

fn clone(&self) -> KeyboardInteractivity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardInteractivity

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

Formats the value using the given formatter.

impl From<KeyboardInteractivity> for u32

fn from(val: KeyboardInteractivity) -> u32

Converts to this type from the input type.

impl Hash for KeyboardInteractivity

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

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

This method returns an Ordering between self and other.

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 PartialEq for KeyboardInteractivity

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

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

This method returns an ordering between self and other values if one exists.

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 TryFrom<u32> for KeyboardInteractivity

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<KeyboardInteractivity, ()>

Performs the conversion.

impl Copy for KeyboardInteractivity

impl Eq for KeyboardInteractivity

impl StructuralPartialEq for KeyboardInteractivity