Struct rat_widget::scrolled::ScrollArea

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

Utility widget for layout/rendering the combined block and scrollbars.

It layouts the scrollbars on top of the border and leaves the corners free if necessary.

Implementations

impl<'a> ScrollArea<'a>

pub fn new() -> ScrollArea<'a>

pub fn block(self, block: Option<Block<'a>>) -> ScrollArea<'a>

Sets the block.

pub fn h_scroll(self, scroll: Option<Scroll<'a>>) -> ScrollArea<'a>

Sets the horizontal scroll.

pub fn v_scroll(self, scroll: Option<Scroll<'a>>) -> ScrollArea<'a>

Sets the vertical scroll.

impl<'a> ScrollArea<'a>

pub fn inner(&self, area: Rect, state: ScrollAreaState<'_>) -> Rect

Calculates the inner area for the widget.

Panic Panics if the orientation doesn’t match, h_scroll doesn’t accept ScrollBarOrientation::Vertical* and v_scroll doesn’t accept ScrollBarOrientation::Horizontal*.

Panics if the state doesn’t contain the necessary scroll-states.

Trait Implementations

impl<'a> Clone for ScrollArea<'a>

fn clone(&self) -> ScrollArea<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ScrollArea<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ScrollArea<'a>

fn default() -> ScrollArea<'a>

Returns the “default value” for a type.

impl<'a> StatefulWidget for ScrollArea<'a>

type State = ScrollAreaState<'a>

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <ScrollArea<'a> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.