Guide API
Skip to main content

StatusDef

Struct StatusDef 

Source
pub struct StatusDef {
    pub range: HelpCtxRange,
    pub items: Vec<StatusItem>,
}
Expand description

A status-line definition: the items shown for a range of help contexts.

§Turbo Vision heritage

Ports TStatusDef (menus.h); the linked list of defs becomes the outer Vec<StatusDef> the StatusLine owns, and the inner items list is a Vec<StatusItem>.

Fields§

§range: HelpCtxRange

Which help contexts activate this def.

HelpCtxRange::All is the universal fallback used by nearly every app; HelpCtxRange::OneOf restricts the def to an explicit set of contexts. Place more-specific defs before the All def in the list — the status line picks the first match.

§Turbo Vision heritage

Replaces the TStatusDef::min/max integer pair (ushort min, max). Because HelpCtx is now a namespaced &'static str rather than an integer, a numeric range has no meaning; HelpCtxRange is the typed replacement.

§items: Vec<StatusItem>

The items displayed by the status line when this def is active.

Build this list with StatusItemsBuilder via StatusDef::list, or construct StatusItem values directly and collect them into a Vec. Items appear left-to-right on screen in Vec order; a text == None item is invisible but still contributes its accelerator binding.

Implementations§

Source§

impl StatusDef

Source

pub fn list() -> StatusDefListBuilder

Start a fluent builder chain for the Vec<StatusDef> that StatusLine::new expects.

Call def_all (the universal context-independent bar used by most apps) or def_one_of (context-specific bar) to append defs, then finish with build. The status line walks the list in order and activates the first def whose range matches the current help context, so place context-specific defs before the All def.

§Example
use tvision_rs::status::{StatusDef, StatusLine};
use tvision_rs::command::Command;
use tvision_rs::event::{Key, KeyEvent};

let defs = StatusDef::list()
    .def_all(|d| {
        d.item("~F1~ Help", KeyEvent::from(Key::F(1)), Command::HELP)
         .item("~Alt-X~ Exit", tvision_rs::menu::alt('x'), Command::QUIT)
         .key_item(KeyEvent::from(Key::F(10)), Command::MENU)
    })
    .build();

let _status_line = StatusLine::new(
    tvision_rs::view::Rect::new(0, 24, 80, 25),
    defs,
);

Trait Implementations§

Source§

impl Clone for StatusDef

Source§

fn clone(&self) -> StatusDef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StatusDef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for StatusDef

Source§

impl PartialEq for StatusDef

Source§

fn eq(&self, other: &StatusDef) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StatusDef

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CustomValue for T
where T: Any + Debug,

Source§

fn as_any_rc(self: Rc<T>) -> Rc<dyn Any>

Upcast Rc<Self> to Rc<dyn Any> so FieldValue::as_custom / FieldValue::value_as can downcast.
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.