Struct Scroll 

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

Scroll widget.

This is not a widget by itself, rather it is meant to be used analogous to Block. A widget that supports scrolling accepts one or two of these Scroll indicators.

Implementations

impl<'a> Scroll<'a>

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

pub fn horizontal() -> Scroll<'a>

Horizontal, bottom scrollbar.

pub fn vertical() -> Scroll<'a>

Vertical, right scrollbar.

pub fn policy(self, policy: ScrollbarPolicy) -> Scroll<'a>

Scrollbar policy.

pub fn get_policy(&self) -> ScrollbarPolicy

Scrollbar policy.

pub fn orientation(self, orientation: ScrollbarOrientation) -> Scroll<'a>

Scrollbar orientation.

pub fn get_orientation(&self) -> ScrollbarOrientation

Scrollbar orientation.

pub fn override_vertical(self) -> Scroll<'a>

Ensures a vertical orientation of the scrollbar.

If the orientation is not vertical it will be set to VerticalRight.

pub fn override_horizontal(self) -> Scroll<'a>

Ensures a horizontal orientation of the scrollbar.

If the orientation is not horizontal, it will be set to HorizontalBottom.

pub fn is_vertical(&self) -> bool

Is this a vertical scrollbar.

pub fn is_horizontal(&self) -> bool

Is this a horizontal scrollbar.

pub fn start_margin(self, start_margin: u16) -> Scroll<'a>

Leave a margin at the start of the scrollbar.

pub fn get_start_margin(&self) -> u16

Margin before the start of the scrollbar.

pub fn end_margin(self, end_margin: u16) -> Scroll<'a>

Leave a margin at the end of the scrollbar.

pub fn get_end_margin(&self) -> u16

Margin after the end of the scrollbar.

pub fn overscroll_by(self, overscroll: usize) -> Scroll<'a>

Set overscrolling to this value.

pub fn scroll_by(self, scroll: usize) -> Scroll<'a>

Set scroll increment.

pub fn styles(self, styles: ScrollStyle) -> Scroll<'a>

Set all styles.

pub fn thumb_symbol(self, thumb_symbol: &'a str) -> Scroll<'a>

Symbol for the Scrollbar.

pub fn thumb_style<S>(self, thumb_style: S) -> Scroll<'a>

where S: Into<Style>,

Style for the Scrollbar.

pub fn track_symbol(self, track_symbol: Option<&'a str>) -> Scroll<'a>

Symbol for the Scrollbar.

pub fn track_style<S>(self, track_style: S) -> Scroll<'a>

where S: Into<Style>,

Style for the Scrollbar.

pub fn begin_symbol(self, begin_symbol: Option<&'a str>) -> Scroll<'a>

Symbol for the Scrollbar.

pub fn begin_style<S>(self, begin_style: S) -> Scroll<'a>

where S: Into<Style>,

Style for the Scrollbar.

pub fn end_symbol(self, end_symbol: Option<&'a str>) -> Scroll<'a>

Symbol for the Scrollbar.

pub fn end_style<S>(self, end_style: S) -> Scroll<'a>

where S: Into<Style>,

Style for the Scrollbar.

pub fn min_symbol(self, min_symbol: Option<&'a str>) -> Scroll<'a>

Symbol when no Scrollbar is drawn.

pub fn min_style<S>(self, min_style: S) -> Scroll<'a>

where S: Into<Style>,

Style when no Scrollbar is drawn.

pub fn symbols(self, symbols: &ScrollSymbols) -> Scroll<'a>

Set all Scrollbar symbols.

pub fn style<S>(self, style: S) -> Scroll<'a>

where S: Into<Style>,

Set a style for all Scrollbar styles.

pub fn padding(&self) -> Padding

Padding needed to embed this Scroll.

Trait Implementations

impl<'a> Clone for Scroll<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Scroll<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Scroll<'a>

fn default() -> Scroll<'a>

Returns the “default value” for a type.

impl StatefulWidget for &Scroll<'_>

type State = ScrollState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <&Scroll<'_> 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.

impl StatefulWidget for Scroll<'_>

type State = ScrollState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <Scroll<'_> 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.