Struct tty_form::control::StaticText

pub struct StaticText { /* private fields */ }

Static, unfocusable, formatable display text. May be dependent on other form elements.

Examples

use tty_interface::Style;

use tty_form::{
    step::CompoundStep,
    control::{Control, StaticText},
};

let mut text = StaticText::new("Hello, world!");
text.set_style(Style::new().set_bold(true));

let mut step = CompoundStep::new();
text.add_to(&mut step);

Implementations

impl StaticText

pub fn new(text: &str) -> Self

Create a new static text control with the specified content.

pub fn set_text(&mut self, text: &str)

Set the text for this control.

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

Set the optional style for this control.

pub fn set_dependency(&mut self, id: DependencyId, action: Action)

Sets a dependency on the specified ID, performing some action if it evaluates true.

Trait Implementations

impl Control for StaticText

fn focusable(&self) -> bool

Whether this control is a focusable input.

fn update(&mut self, _input: KeyEvent)

Updates the control’s state from the given input event.

fn help(&self) -> Option<Segment>

This control’s descriptive help text, if available.

fn text(&self) -> (Segment, Option<u16>)

This control’s rendered contents and an optional offset for the cursor.

fn drawer(&self) -> Option<DrawerContents>

This control’s drawer contents, if available.

fn evaluation(&self) -> Option<(DependencyId, Evaluation)>

This control’s dependency evaluation which other controls may react to.

fn dependency(&self) -> Option<(DependencyId, Action)>

This control’s dependency which it may react to.

fn evaluate(&self, _evaluation: &Evaluation) -> bool

Perform an evaluation against this control’s current state.

fn add_to(self, step: &mut CompoundStep)

Finish configuration and add this control to the specified form step.