Struct DualPagerBuffer

pub struct DualPagerBuffer<'a> { /* 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> DualPagerBuffer<'a>

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

where W: Widget,

Render a widget to the buffer.

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

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

Render a widget to the buffer. This expects that the state is a RelocatableState, so it can reset the areas for hidden widgets.

pub fn render_widget_handle<W, Idx>( &mut self, widget: W, area: AreaHandle, tag: Idx, )

where W: Widget, [Rect]: Index<Idx, Output = Rect>,

Render a widget to the buffer.

pub fn render_stateful_handle<W, S, Idx>( &mut self, widget: W, area: AreaHandle, tag: Idx, state: &mut S, )

where W: StatefulWidget<State = S>, S: RelocatableState, [Rect]: Index<Idx, Output = Rect>,

Render a widget to the buffer.

This expects that the state is a RelocatableState, so it can reset the areas for hidden widgets.

pub fn layout(&self) -> &PagerLayout

Return the layout.

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

Is the given area visible?

pub fn is_visible_handle(&self, handle: AreaHandle) -> bool

Is the given area 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_handle(&self, handle: AreaHandle) -> Option<Box<[Rect]>>

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

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

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

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_mut(&mut self) -> &mut Buffer

Access the buffer. Note Use of render_xxx is preferred.

pub fn into_widget(self) -> DualPagerWidget

Rendering the content is finished.

Convert to the final widget to render the finishings.

Trait Implementations

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

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

Formats the value using the given formatter.