Struct ClipperBuffer

pub struct ClipperBuffer<'a, W>
where
    W: Eq + Clone + Hash,
{ /* private fields */ }

Implementations

impl<'a, W> ClipperBuffer<'a, W>

where W: Eq + Hash + Clone,

pub fn is_visible(&self, widget: W) -> bool

Is the widget visible.

pub fn render_label<FN, WW>(&mut self, widget: W, render_fn: FN) -> bool

where FN: FnOnce(&Option<Cow<'static, str>>) -> WW, WW: Widget,

Render the label for the given widget.

pub fn render_widget<FN, WW>(&mut self, widget: W, render_fn: FN) -> bool

where FN: FnOnce() -> WW, WW: Widget,

Render a stateless widget and its label.

pub fn render<FN, WW, SS>( &mut self, widget: W, render_fn: FN, state: &mut SS, ) -> bool

where FN: FnOnce() -> WW, WW: StatefulWidget<State = SS>, SS: RelocatableState,

Render a stateful widget and its label.

pub fn render_block(&mut self)

Render all visible blocks.

pub fn locate_widget(&self, widget: W) -> Option<Rect>

Get the buffer coordinates for the given widget.

pub fn locate_label(&self, widget: W) -> Option<Rect>

Get the buffer coordinates for the label of the given widget.

pub fn locate_area(&self, area: Rect) -> Option<Rect>

Relocate the area from layout coordinates to buffer coordinates, which is a noop as those are aligned.

But this will return None if the given area is outside the buffer.

pub fn shift(&self) -> (i16, i16)

Calculate the necessary shift from layout to screen.

pub fn relocate<S>(&self, state: &mut S)

where S: RelocatableState,

After rendering the widget to the buffer it may have stored areas in its state. These will be in buffer coordinates instead of screen coordinates.

Call this function to correct this after rendering.

pub fn hidden<S>(&self, state: &mut S)

where S: RelocatableState,

If a widget is not rendered because it is out of the buffer area, it may still have left over areas in its state.

This uses the mechanism for relocate to zero them out.

pub fn buffer(&mut self) -> &mut Buffer

Return a reference to the buffer.

pub fn into_widget(self) -> ClipperWidget<'a, W>

Rendering the content is finished.

Convert to the output widget that can be rendered in the target area.

Trait Implementations

impl<'a, W> Debug for ClipperBuffer<'a, W>

where W: Eq + Clone + Hash + Debug,

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

Formats the value using the given formatter.