Trait Widget 

pub trait Widget {
    // Required method
    fn render(&self, surface: &mut Surface<'_>);
}

A type that draws itself into a Surface, without retaining any state: the minimal shape shared by every widget-like consumer.

Examples

use retroglyph_core::color::Style;
use retroglyph_core::grid::{Grid, Rect};
use retroglyph_ui::widget::Widget;
use retroglyph_ui::Surface;

struct Marker(char);

impl Widget for Marker {
    fn render(&self, surface: &mut Surface<'_>) {
        surface.put((0, 0), self.0, Style::new());
    }
}

let area = Rect::new(0, 0, 4, 1);
let mut grid = Grid::new(4, 1);
Marker('*').render(&mut Surface::new(&mut grid, area, 0));

Required Methods

fn render(&self, surface: &mut Surface<'_>)

Draw this widget into surface, filling surface.area().

Coordinates on every Surface drawing method are local to surface itself, where (0, 0) is surface.area()’s own top-left corner, not the underlying grid’s. Placement should therefore be built from Surface::width/Surface::height (or surface.area().at_origin() for a rect), never from surface.area()’s own left/top: those are absolute grid coordinates, and passing them straight to a drawing call only lands correctly for a surface whose area happens to start at the grid origin.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Widget for BoxBorder

impl Widget for Boxed<'_>

impl Widget for Button<'_>

impl Widget for Gauge<'_>

impl Widget for Log<'_>

impl Widget for Panel<'_>

impl Widget for Paragraph<'_>

Available on crate feature egc only.

impl Widget for PrintLine<'_>

impl Widget for ProgressBar

impl Widget for Scrollbar

impl Widget for Sparkline<'_>

impl Widget for StatBar<'_>

impl Widget for Tabs<'_>

impl Widget for Text<'_>

impl<const N: usize> Widget for PerfOverlay<'_, N>