Struct ViewBuffer 

pub struct ViewBuffer<'a> { /* private fields */ }

Render to the temp buffer.

• It maps your widget area from layout coordinates to screen coordinates before rendering.
• It helps with cleanup of the widget state if your widget is currently invisible.

Implementations

impl<'a> ViewBuffer<'a>

pub fn render_widget<W>(&mut self, widget: W, area: Rect) -> bool

where W: Widget,

Render a widget to the temp buffer.

pub fn render<W, S>(&mut self, widget: W, area: Rect, state: &mut S) -> bool

where W: StatefulWidget<State = S>, S: RelocatableState,

Render a widget to the temp buffer. This expects that the state is a RelocatableState.

pub fn render_popup<W, S>( &mut self, widget: W, area: Rect, state: &mut S, ) -> bool

where W: StatefulWidget<State = S>, S: RelocatableState,

Render an additional popup widget for the given main widget.

Doesn’t call relocate().

pub fn layout(&self) -> Rect

Return the buffer layout.

pub fn is_visible_area(&self, area: Rect) -> bool

Is this area inside the buffer area.

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

👎Deprecated since 2.0.0: should not be public. use relocate2() instead.

Calculate the necessary shift from view to screen.

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

👎Deprecated since 2.0.0: wrong api, use is_visible_area() or locate_area2()

Does nothing for view. Only exists to match Clipper.

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

Validates that this area is inside the buffer area.

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

where S: RelocatableState,

👎Deprecated since 2.0.0: wrong api, use relocate2() instead

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 relocate2<S>(&self, area: Rect, 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,

👎Deprecated since 2.0.0: bad api, use relocate2() instead

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 relocate_hidden to zero them out.

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

Access the temporary buffer.

Note Use of render_widget is preferred.

pub fn into_widget(self) -> ViewWidget<'a>

👎Deprecated since 2.3.0: use finish() instead

Rendering the content is finished.

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

pub fn finish(self, tgt_buf: &mut Buffer, state: &mut ViewState)

Render the buffer.

Trait Implementations

impl<'a> Debug for ViewBuffer<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for ViewBuffer<'a>

fn drop(&mut self)

Executes the destructor for this type.