Struct DualPagerBuffer

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

Renders directly to the frame 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, W> DualPagerBuffer<'a, W>

where W: Eq + Hash + Clone,

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

Is the given area visible?

pub fn render_block(&mut self)

Render all blocks for the current page.

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 a manual label.

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, if any.

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

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

Render an optional stateful widget and its label, if any.

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, if any.

pub fn render2<FN, WW, SS, R>( &mut self, widget: W, render_fn: FN, state: &mut SS, ) -> Option<R>

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

Render a stateful widget and its label, if any. The closure can return a second value, which will be forwarded if the widget is visible.

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

Calculate the necessary shift from view to screen. This does nothing as pager always places the widgets in screen coordinates.

Just to keep the api in sync with Clipper.

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

Relocate the widget area to screen coordinates. Returns None if the widget is not visible. This clips the area to page_area.

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

Relocate the label area to screen coordinates. Returns None if the widget is not visible. This clips the area to page_area.

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

Relocate an area from layout coordinates to screen coordinates. A result None indicates that the area is invisible.

This will clip the area to the page_area.

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

where S: RelocatableState,

Does nothing for pager. Just to keep the api in sync with Clipper.

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

where S: RelocatableState,

Clear the areas in the widget-state. This is called by render_xx whenever a widget is invisible.

pub fn buffer<'b>(&'b mut self) -> RefMut<'b, &'a mut Buffer>

Get access to the buffer during rendering a page.

Trait Implementations

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

where W: Eq + Hash + Clone + Debug,

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

Formats the value using the given formatter.