Struct Legends 

pub struct Legends<CA, CM>
where
    CA: EzArgs,
    CM: EzMsg,
{ /* private fields */ }

A component to display a colored indicator alternating colors based on the frame rate of the terminal.

Implementations

impl<CA, CM> Legends<CA, CM>

where CA: EzArgs, CM: EzMsg,

pub fn new(legends: Vec<Legend>) -> Self

Create a new Legends component with the given Legends.

pub fn set_legends(&mut self, legends: Vec<Legend>)

Reset this Legends component with the given Legends.

Trait Implementations

impl<CID, CA, CS, CM> Component<CID, CA, CS, CM> for Legends<CA, CM>

where CID: EzCptIds, CA: EzArgs, CS: EzState, CM: EzMsg,

fn on_event( &mut self, _event: EzEvent<CID, CM>, state: &mut State<CS>, ) -> Vec<EzEvent<CID, CM>>

Method to implement to handle events. The component will receive any event if it is focused; but only events it is subscribed to otherwise.

fn init(&mut self, state: &mut State<CS>) -> Vec<EzEvent<CID, CM>>

Method called on first tick only.

fn tick(&mut self, state: &mut State<CS>) -> Vec<EzEvent<CID, CM>>

Method called on every tick. You should implement it only if you need to save a reference to the state or if your business logic needs to execute some code on a regular basis.

fn focusable(&self) -> bool

Whether the component is focusable or not.

fn legend(&self) -> Option<Legend>

Get the component’s hotkeys legend.

fn capture_focus(&mut self, forward: bool) -> bool

Returns true if the focus is handled internally. Let’s say this component has two inner focusable area:

impl<CA, CM> Debug for Legends<CA, CM>

where CA: EzArgs + Debug, CM: EzMsg + Debug,

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

Formats the value using the given formatter.

impl<CA, CM> MockComponent for Legends<CA, CM>

where CA: EzArgs, CM: EzMsg,

fn draw(&mut self, area: Rect, buf: &mut Buffer, theme: &Theme)

Draw the component in the given area of the given buffer.

impl<CA, CM> MockProps for Legends<CA, CM>

where CA: EzArgs, CM: EzMsg,

fn props(&self) -> Option<&Props>

Get a reference to the component’s attribute

fn props_mut(&mut self) -> Option<&mut Props>

Get a mutable reference to the component’s attribute