Enum FocusTarget 

pub enum FocusTarget<O = ()> {
    CanvasField(usize),
    InternalCanvasField(usize),
    Button(usize),
    Section(usize),
    SectionItem {
        section: usize,
        item: usize,
    },
    Overlay(O),
    ModalItem(usize),
    Custom(String),
}

A focusable element of a page.

O is the application-defined overlay type carried by FocusTarget::Overlay — your own enum of the modal overlays your TUI has (a command bar, a search palette, a sidebar, …). The crate provides no overlay names; you define them. Apps that use no named overlays leave O at its default ().

Variants

CanvasField(usize)

InternalCanvasField(usize)

Button(usize)

Section(usize)

SectionItem

Fields

section: usize

item: usize

Overlay(O)

ModalItem(usize)

Focus on item N inside the currently open modal overlay. The crate names no modal kinds: a dialog button, a picker row, or any other in-modal item is just a ModalItem. The dialog feature layers its button conventions on top of this.

Custom(String)

Implementations

impl<O> FocusTarget<O>

pub fn is_canvas(&self) -> bool

pub fn is_button(&self) -> bool

pub fn is_overlay(&self) -> bool

pub fn is_top_level_navigable(&self) -> bool

impl<O: Clone> FocusTarget<O>

pub fn to_overlay(&self) -> Option<O>

The overlay identity if this target is an Overlay.

Trait Implementations

impl<O: Clone> Clone for FocusTarget<O>

fn clone(&self) -> FocusTarget<O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O: Debug> Debug for FocusTarget<O>

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

Formats the value using the given formatter.

impl<'de, O> Deserialize<'de> for FocusTarget<O>

where O: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<O: Hash> Hash for FocusTarget<O>

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<O: PartialEq> PartialEq for FocusTarget<O>

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

where O: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<O: Eq> Eq for FocusTarget<O>

impl<O> StructuralPartialEq for FocusTarget<O>