Struct ScrollArea 

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

Utility widget for rendering a combination of a Block and one or two Scroll(bars). Any of these can be None.

Implementations

impl<'a> ScrollArea<'a>

pub fn new() -> Self

pub fn style(self, style: Style) -> Self

Set the base style.

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

Sets the block.

pub fn ignore_block(self) -> Self

Ignores the block when rendering and renders only the scrollbars. The block is still considered when calculating everything.

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

Sets the horizontal scroll.

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

Sets the vertical scroll.

pub fn ignore_scroll(self) -> Self

Ignores the scrollbars when rendering and renders only the block. The scrollbars are still considered when calculating everything.

pub fn padding(&self) -> Padding

What is the combined Padding.

pub fn inner( &self, area: Rect, hscroll_state: Option<&ScrollState>, vscroll_state: Option<&ScrollState>, ) -> Rect

Calculate the size of the inner area.

Trait Implementations

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

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

Returns a duplicate 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

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 Self::State)

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

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 Self::State)

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