FormBuffer

Struct FormBuffer 

Source
pub struct FormBuffer<'a, W>
where W: Eq + Hash + Clone,
{ /* private fields */ }
👎Deprecated since 1.2.0: merged into form::Form
Expand description

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§

Source§

impl<'a, W> FormBuffer<'a, W>
where W: Eq + Hash + Clone,

Source

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

👎Deprecated since 1.2.0: merged into form::Form

Is the given area visible?

Source

pub fn render_block(&mut self)

👎Deprecated since 1.2.0: merged into form::Form

Render all blocks for the current page.

Source

pub fn render_label<FN>(&mut self, widget: W, render_fn: FN) -> bool
where FN: FnOnce(&Cow<'static, str>, Rect, &mut Buffer),

👎Deprecated since 1.2.0: merged into form::Form

Render a manual label.

Source

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

👎Deprecated since 1.2.0: merged into form::Form

Render a stateless widget and its label, if any.

Source

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,

👎Deprecated since 1.2.0: merged into form::Form

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

Source

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,

👎Deprecated since 1.2.0: merged into form::Form

Render a stateful widget and its label, if any.

Source

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,

👎Deprecated since 1.2.0: merged into form::Form

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.

Source

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

👎Deprecated since 1.2.0: merged into form::Form

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.

Source

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

👎Deprecated since 1.2.0: merged into form::Form

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

Source

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

👎Deprecated since 1.2.0: merged into form::Form

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

Source

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

👎Deprecated since 1.2.0: merged into form::Form

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.

Source

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

👎Deprecated since 1.2.0: merged into form::Form

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

Source

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

👎Deprecated since 1.2.0: merged into form::Form

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

Source

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

👎Deprecated since 1.2.0: merged into form::Form

Get access to the buffer during rendering a page.

Trait Implementations§

Source§

impl<'a, W> Debug for FormBuffer<'a, W>
where W: Eq + Hash + Clone + Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, W> Freeze for FormBuffer<'a, W>

§

impl<'a, W> !RefUnwindSafe for FormBuffer<'a, W>

§

impl<'a, W> !Send for FormBuffer<'a, W>

§

impl<'a, W> !Sync for FormBuffer<'a, W>

§

impl<'a, W> Unpin for FormBuffer<'a, W>

§

impl<'a, W> !UnwindSafe for FormBuffer<'a, W>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.