Struct rat_widget::scrolled::Scrolled

pub struct Scrolled<'a, T> { /* private fields */ }

A wrapper widget that scrolls it’s content.

Implementations

impl<'a, T> Scrolled<'a, T>

pub fn new(inner: T) -> Scrolled<'a, T>

New scrolled widget.

pub fn vertical_overscroll(self, n: usize) -> Scrolled<'a, T>

Allow overscrolling the max_offset by n.

pub fn horizontal_overscroll(self, n: usize) -> Scrolled<'a, T>

Allow overscrolling the max_offset by n.

pub fn horizontal_scrollbar_policy( self, policy: ScrollbarPolicy, ) -> Scrolled<'a, T>

Horizontal scrollbar policy.

pub fn vertical_scrollbar_policy( self, policy: ScrollbarPolicy, ) -> Scrolled<'a, T>

Vertical scrollbar policy.

pub fn horizontal_scroll_position(self, pos: HScrollPosition) -> Scrolled<'a, T>

Position

pub fn vertical_scroll_position(self, pos: VScrollPosition) -> Scrolled<'a, T>

Position

pub fn block(self, block: Block<'a>) -> Scrolled<'a, T>

Block around the scrolled widget. The scrollbars are drawn as part of the block.

Attention: There must be a border at the sides where you want the scrollbars. Otherwise, the calculations for the scrollbar placement will be off somewhat.

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

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

Symbol for the Scrollbar.

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

where S: Into<Style>,

Style for the Scrollbar.

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

Symbol for the Scrollbar.

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

where S: Into<Style>,

Style for the Scrollbar.

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

Symbol for the Scrollbar.

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

where S: Into<Style>,

Style for the Scrollbar.

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

Symbol for the Scrollbar.

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

where S: Into<Style>,

Style for the Scrollbar.

pub fn symbols(self, symbols: Set) -> Scrolled<'a, T>

Set all Scrollbar symbols.

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

where S: Into<Style>,

Set a style for all Scrollbar styles.

impl<'a, W> Scrolled<'a, View<W>>

where W: Widget,

pub fn new_view(inner: W) -> Scrolled<'a, View<W>>

Create a Scrolled<View<W>> widget for widgets without builtin scrolling behaviour.

You need to set a view_size for the area the inner widget shall receive.

See Viewport too.

pub fn view_size(self, size: Size) -> Scrolled<'a, View<W>>

Size for the inner widget.

pub fn view_style(self, style: Style) -> Scrolled<'a, View<W>>

Style for the empty space outside the rendered buffer.

impl<'a, W> Scrolled<'a, Viewport<W>>

where W: StatefulWidget,

pub fn new_viewport(inner: W) -> Scrolled<'a, Viewport<W>>

Create a Scrolled<Viewport<W>> widget for widgets without builtin scrolling behaviour.

You need to set a view_size for the area the inner widget shall receive.

See Viewport too.

pub fn view_size(self, size: Size) -> Scrolled<'a, Viewport<W>>

Size for the inner widget.

pub fn view_style(self, style: Style) -> Scrolled<'a, Viewport<W>>

Style for the empty space outside the rendered buffer.

Trait Implementations

impl<'a, T> Clone for Scrolled<'a, T>

where T: Clone,

fn clone(&self) -> Scrolled<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Scrolled<'a, T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'a, T> Default for Scrolled<'a, T>

where T: Default,

fn default() -> Scrolled<'a, T>

Returns the “default value” for a type.

impl<'a, W> StatefulWidget for Scrolled<'a, W>

where W: StatefulWidget + ScrollingWidget<<W as StatefulWidget>::State>, <W as StatefulWidget>::State: ScrollingState,

type State = ScrolledState<<W as StatefulWidget>::State>

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <Scrolled<'a, W> 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, W> StatefulWidgetRef for Scrolled<'a, W>

where W: StatefulWidgetRef + ScrollingWidget<<W as StatefulWidgetRef>::State>, <W as StatefulWidgetRef>::State: ScrollingState,

type State = ScrolledState<<W as StatefulWidgetRef>::State>

State associated with the stateful widget.

fn render_ref( &self, area: Rect, buf: &mut Buffer, state: &mut <Scrolled<'a, W> 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.