Skip to main content

Widget

termint::widgets

Trait Widget

pub trait Widget: Any {
    // Required methods
    fn render(&self, buffer: &mut Buffer, rect: Rect, cache: &mut Cache);
    fn height(&self, size: &Vec2) -> usize;
    fn width(&self, size: &Vec2) -> usize;

    // Provided method
    fn children(&self) -> Vec<&Element> { ... }
}

Expand description

Trait implemented by all the widgets. Trait implemented by all the widgets.

A widget is a visual component that can render itself to a Buffer and report its size requirements for layout purposes.

Use Element to store and manipulate widgets in a uniform way.

Users will use Widget trait directly only when implementing custom widget, otherwise they will use built-in widgets like [Span], [List] and so on.

Required Methods§

fn render(&self, buffer: &mut Buffer, rect: Rect, cache: &mut Cache)

Renders the widget into the given Buffer within the provided Rect bounds.

fn height(&self, size: &Vec2) -> usize

Returns the height of the Widget based on the width of the given size.

fn width(&self, size: &Vec2) -> usize

Returns the width of the Widget based on the height of the given size.

Provided Methods§

fn children(&self) -> Vec<&Element>

Gets widget’s children

Implementations§

pub fn as_any(&self) -> &dyn Any

pub fn as_any_mut(&mut self) -> &mut dyn Any

Trait Implementations§

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

Formats the value using the given formatter. Read more

fn from(value: BgGrad<W>) -> Self

Converts to this type from the input type.

fn from(value: Block<W>) -> Self

Converts to this type from the input type.

fn from(value: Grad) -> Self

Converts to this type from the input type.

fn from(value: Grid) -> Self

Converts to this type from the input type.

fn from(value: Layout) -> Self

Converts to this type from the input type.

fn from(value: List) -> Self

Converts to this type from the input type.

fn from(value: Overlay) -> Self

Converts to this type from the input type.

fn from(value: Paragraph) -> Self

Converts to this type from the input type.

fn from(value: ProgressBar) -> Self

Converts to this type from the input type.

fn from(value: Scrollable<W>) -> Self

Converts to this type from the input type.

fn from(value: Scrollbar) -> Self

Converts to this type from the input type.

fn from(value: Spacer) -> Self

Converts to this type from the input type.

fn from(value: Span) -> Self

Converts to this type from the input type.

fn from(value: T) -> Self

Converts to this type from the input type.

fn from(value: Table) -> Self

Converts to this type from the input type.

Implementors§