Struct KeyHintsState 

pub struct KeyHintsState { /* private fields */ }

State for a KeyHints component.

Contains all hints and display configuration.

Example

use envision::component::{KeyHintsState, KeyHintsLayout};

let state = KeyHintsState::new()
    .with_layout(KeyHintsLayout::Inline)
    .hint("Enter", "Select")
    .hint("Esc", "Cancel");

Implementations

impl KeyHintsState

pub fn new() -> Self

Creates a new empty KeyHints state.

Example

use envision::component::KeyHintsState;

let state = KeyHintsState::new();
assert!(state.is_empty());

pub fn with_hints(hints: Vec<KeyHint>) -> Self

Creates a new state with the given hints.

Example

use envision::component::{KeyHintsState, KeyHint};

let hints = vec![KeyHint::new("q", "Quit")];
let state = KeyHintsState::with_hints(hints);
assert_eq!(state.len(), 1);

pub fn with_layout(self, layout: KeyHintsLayout) -> Self

Sets the layout style.

Example

use envision::component::{KeyHintsState, KeyHintsLayout};

let state = KeyHintsState::new().with_layout(KeyHintsLayout::Inline);
assert_eq!(state.layout(), KeyHintsLayout::Inline);

pub fn with_key_action_separator(self, sep: impl Into<String>) -> Self

Sets the separator between key and action.

pub fn with_hint_separator(self, sep: impl Into<String>) -> Self

Sets the separator between hints.

pub fn with_key_style(self, style: Style) -> Self

Sets the style for keys.

pub fn with_action_style(self, style: Style) -> Self

Sets the style for actions.

pub fn hint(self, key: impl Into<String>, action: impl Into<String>) -> Self

Adds a hint using builder pattern.

Example

use envision::component::KeyHintsState;

let state = KeyHintsState::new()
    .hint("Enter", "Select")
    .hint("Esc", "Cancel")
    .hint("q", "Quit");

assert_eq!(state.len(), 3);

pub fn hint_with_priority( self, key: impl Into<String>, action: impl Into<String>, priority: u8, ) -> Self

Adds a hint with priority using builder pattern.

pub fn hints(&self) -> &[KeyHint]

Returns all hints.

pub fn visible_hints(&self) -> Vec<&KeyHint>

Returns only enabled hints, sorted by priority.

pub fn layout(&self) -> KeyHintsLayout

Returns the layout style.

pub fn len(&self) -> usize

Returns the number of hints.

pub fn is_empty(&self) -> bool

Returns true if there are no hints.

pub fn set_hints(&mut self, hints: Vec<KeyHint>)

Sets the hints.

pub fn add_hint(&mut self, hint: KeyHint)

Adds a hint.

pub fn remove_hint(&mut self, key: &str)

Removes a hint by key.

pub fn enable_hint(&mut self, key: &str)

Enables a hint by key.

pub fn disable_hint(&mut self, key: &str)

Disables a hint by key.

pub fn set_layout(&mut self, layout: KeyHintsLayout)

Sets the layout.

pub fn clear(&mut self)

Clears all hints.

pub fn key_style(&self) -> Style

Returns the key style.

pub fn action_style(&self) -> Style

Returns the action style.

pub fn set_key_style(&mut self, style: Style)

Sets the key style.

pub fn set_action_style(&mut self, style: Style)

Sets the action style.

pub fn is_disabled(&self) -> bool

Returns true if the key hints are disabled.

pub fn set_disabled(&mut self, disabled: bool)

Sets the disabled state.

pub fn with_disabled(self, disabled: bool) -> Self

Sets the disabled state using builder pattern.

Example

use envision::component::KeyHintsState;

let state = KeyHintsState::new()
    .with_disabled(true);
assert!(state.is_disabled());

Trait Implementations

impl Clone for KeyHintsState

fn clone(&self) -> KeyHintsState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyHintsState

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

Formats the value using the given formatter.

impl Default for KeyHintsState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyHintsState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyHintsState

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyHintsState