Struct rat_widget::scrolled::Scroll

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

Scrolling indicator.

Meant to be used like Block.

Implementations

impl<'a> Scroll<'a>

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

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

Scrollbar policy.

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

Scrollbar orientation.

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

Set overscrolling.

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

Override default scroll increment.

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

Ensures a vertical orientation.

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

Ensures a horizotal orientation.

pub fn is_vertical(&self) -> bool

pub fn is_horizontal(&self) -> bool

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

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 no_symbol(self, no_symbol: Option<&'a str>) -> Scroll<'a>

Symbol when no Scrollbar is drawn.

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

where S: Into<Style>,

Style when no Scrollbar is drawn.

pub fn symbols(self, symbols: Set) -> 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.

Trait Implementations

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

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

Returns a copy 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<'a> StatefulWidget for Scroll<'a>

type State = ScrollState

State associated with the stateful widget.

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

impl<'a> StatefulWidgetRef for Scroll<'a>

type State = ScrollState

State associated with the stateful widget.

fn render_ref( &self, area: Rect, buf: &mut Buffer, state: &mut <Scroll<'a> as StatefulWidgetRef>::State, )

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