Struct Annotate 

pub struct Annotate<W> { /* private fields */ }

A wrapper that adds annotation metadata to a widget.

When rendered, the annotation is registered with the current annotation context (if one is active).

Example

use envision::annotation::{Annotate, Annotation};
use ratatui::widgets::Paragraph;

// Wrap a widget with annotation
let annotated = Annotate::new(
    Paragraph::new("Click me"),
    Annotation::button("my-button").with_label("My Button"),
);

Implementations

impl<W> Annotate<W>

pub fn new(widget: W, annotation: Annotation) -> Self

Creates a new annotated widget.

pub fn annotation(&self) -> &Annotation

Returns a reference to the annotation.

pub fn annotation_mut(&mut self) -> &mut Annotation

Returns a mutable reference to the annotation.

pub fn inner(&self) -> &W

Returns a reference to the inner widget.

pub fn inner_mut(&mut self) -> &mut W

Returns a mutable reference to the inner widget.

pub fn into_inner(self) -> W

Unwraps and returns the inner widget.

pub fn focused(self, focused: bool) -> Self

Sets the focused state.

pub fn disabled(self, disabled: bool) -> Self

Sets the disabled state.

pub fn selected(self, selected: bool) -> Self

Sets the selected state.

pub fn value(self, value: impl Into<String>) -> Self

Sets the current value.

Trait Implementations

impl<W: Widget> Widget for Annotate<W>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.