Struct Caption 

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

A label/caption linked to another widget.

*** unstable ***

Implementations

impl<'a> Caption<'a>

pub fn new() -> Self

New

pub fn parse(txt: &'a str) -> Self

Uses ‘_’ as special character.

Item

The first ‘_’ marks the navigation-char. Pipe ‘|’ separates the item text and the hotkey text.

pub fn text(self, txt: &'a str) -> Self

Set the label text.

You probably want to use parse instead. This is only useful if you want manual control over highlight-range and hotkey text.

pub fn spacing(self, spacing: u16) -> Self

Spacing between text and hotkey-text.

pub fn hotkey(self, hotkey: KeyEvent) -> Self

Alternate navigation key

pub fn hotkey_text(self, hotkey: &'a str) -> Self

Hotkey text

pub fn hotkey_align(self, align: HotkeyAlignment) -> Self

Alignment of the hotkey text.

pub fn hotkey_policy(self, policy: HotkeyPolicy) -> Self

Policy for when to show the hotkey text.

pub fn link(self, widget: &impl HasFocus) -> Self

Set the linked widget.

pub fn highlight(self, bytes: Range<usize>) -> Self

Byte-range into text to be highlighted.

pub fn navchar(self, navchar: char) -> Self

Navigation-char.

pub fn align(self, align: Alignment) -> Self

Label alignment.

pub fn styles(self, styles: CaptionStyle) -> Self

Set all styles.

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

Base style.

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

Hover style.

pub fn hover_opt(self, style: Option<Style>) -> Self

Hover style.

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

Shortcut highlight style.

pub fn highlight_style_opt(self, style: Option<Style>) -> Self

Shortcut highlight style.

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

Style for the hotkey.

pub fn hotkey_style_opt(self, style: Option<Style>) -> Self

Style for the hotkey.

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

Base-style when the main widget is focused.

pub fn focus_style_opt(self, style: Option<Style>) -> Self

Base-style when the main widget is focused.

pub fn text_width(&self) -> u16

Inherent width

pub fn hotkey_width(&self) -> u16

Inherent width

pub fn width(&self) -> u16

Inherent width

pub fn height(&self) -> u16

Inherent height

Trait Implementations

impl<'a> Clone for Caption<'a>

fn clone(&self) -> Caption<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Caption<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Caption<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> StatefulWidget for &Caption<'a>

type State = CaptionState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl<'a> StatefulWidget for Caption<'a>

type State = CaptionState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.