Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

A horizontal progress bar that fills value / max of the area it’s rendered into.

filled_style/empty_style default to Style::new(); set them with ProgressBar::filled_style/ProgressBar::empty_style. area.height() is ignored; only the first row is drawn.

Examples

use retroglyph_core::{Headless, Rect, Terminal};
use retroglyph_widgets::{ProgressBar, Widget};

let mut term = Terminal::new(Headless::new(10, 1));
ProgressBar::new(5, 10).render(Rect::new(0, 0, 10, 1), &mut term);

Implementations

impl ProgressBar

pub fn new(value: u32, max: u32) -> Self

A bar filling value / max, in the default style.

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

Set the style of the filled portion.

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

Set the style of the empty portion.

pub fn theme(self, theme: Theme) -> Self

Applies theme’s named roles to this bar: filled_style becomes theme.accent (progress reads as emphasis, the same role super::Tabs::theme/super::Button::theme use for a selected/focused state) on theme.panel_bg, and empty_style becomes theme.dim on theme.panel_bg.

Both set an explicit background rather than leaving it at Style::new()’s default: an unset background isn’t “transparent” once a real backend draws it (a bare Color::Default cell paints as solid black behind the glyph – see retroglyph-software’s DEFAULT_BG), which matters most for empty_style’s '░' glyph (it doesn’t fully cover its cell the way filled_style’s '█' does, so its background actually shows). This widget assumes it’s drawn on theme.panel_bg, true when composed with a themed super::Panel/ super::Modal. Drawing this bar directly on the raw screen background instead needs a manual .filled_style(...)/.empty_style(...) override afterwards.

Call before any manual ProgressBar::filled_style/ProgressBar::empty_style override you want to keep.

pub fn theme_on(self, theme: Theme, bg: Color) -> Self

Same as ProgressBar::theme, but filled_style/empty_style are drawn on bg instead of theme.panel_bg – for a bar drawn directly on a backdrop other than a themed super::Panel/super::Modal’s fill. ProgressBar::theme is exactly theme_on(theme, theme.panel_bg).

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProgressBar

impl Debug for ProgressBar

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

Formats the value using the given formatter.

impl<B: Backend> Widget<B> for ProgressBar

fn render(self, area: Rect, term: &mut Terminal<B>)

Draw this widget into area.