Struct cursive::views::ScrollView

pub struct ScrollView<V> { /* private fields */ }

Wraps a view in a scrollable area.

Implementations

impl<V> ScrollView<V>

pub fn new(inner: V) -> ScrollView<V>

Creates a new ScrollView around view.

pub fn content_viewport(&self) -> Rect

Returns the viewport in the inner content.

pub fn inner_size(&self) -> XY<usize>

Returns the size of the content view, as it was on the last layout phase.

This is only the size the content thinks it has, and may be larger than the actual size used by this ScrollView.

pub fn is_at_top(&self) -> bool

Returns true if the top row of the content is in view.

pub fn is_at_bottom(&self) -> bool

Returns true if the bottom row of the content is in view.

pub fn is_at_left_edge(&self) -> bool

Return true if the left-most column of the content is in view.

pub fn is_at_right_edge(&self) -> bool

Return true if the right-most column of the content is in view.

pub fn set_scroll_strategy(&mut self, strategy: ScrollStrategy) -> EventResult

Defines the way scrolling is adjusted on content or size change.

The scroll strategy defines how the scrolling position is adjusted when the size of the view or the content change.

It is reset to ScrollStrategy::KeepRow whenever the user scrolls manually.

pub fn scroll_strategy(self, strategy: ScrollStrategy) -> ScrollView<V>

Defines the way scrolling is adjusted on content or size change.

Chainable variant.

pub fn set_show_scrollbars(&mut self, show_scrollbars: bool)

Control whether scroll bars are visibile.

Defaults to true.

pub fn show_scrollbars(self, show_scrollbars: bool) -> ScrollView<V>

Control whether scroll bars are visibile.

Chainable variant

pub fn set_offset<S>(&mut self, offset: S) -> EventResultwhere
    S: Into<XY<usize>>,

Sets the scroll offset to the given value

pub fn set_scroll_y(&mut self, enabled: bool) -> EventResult

Controls whether this view can scroll vertically.

Defaults to true.

pub fn set_scroll_x(&mut self, enabled: bool) -> EventResult

Controls whether this view can scroll horizontally.

Defaults to false.

pub fn scroll_y(self, enabled: bool) -> ScrollView<V>

Controls whether this view can scroll vertically.

Defaults to true.

Chainable variant.

pub fn scroll_x(self, enabled: bool) -> ScrollView<V>

Controls whether this view can scroll horizontally.

Defaults to false.

Chainable variant.

pub fn scroll_to_top(&mut self) -> EventResult

Programmatically scroll to the top of the view.

pub fn scroll_to_bottom(&mut self) -> EventResult

Programmatically scroll to the bottom of the view.

pub fn scroll_to_left(&mut self) -> EventResult

Programmatically scroll to the leftmost side of the view.

pub fn scroll_to_right(&mut self) -> EventResult

Programmatically scroll to the rightmost side of the view.

pub fn scroll_to_important_area(&mut self) -> EventResultwhere
    V: View,

Programmatically scroll until the child’s important area is in view.

pub fn into_inner(self) -> V

Returns the wrapped view.

pub fn set_on_scroll_inner<F>(&mut self, on_scroll: F)where
    F: 'static + FnMut(&mut ScrollView<V>, Rect) -> EventResult,

Sets a callback to be run whenever scrolling happens.

This lets the callback access the ScrollView itself (and its child) if necessary.

If you just need to run a callback on &mut Cursive, consider set_on_scroll.

pub fn set_on_scroll<F>(&mut self, on_scroll: F)where
    F: 'static + FnMut(&mut Cursive, Rect),

Sets a callback to be run whenever scrolling happens.

pub fn set_on_scroll_change_inner<F>(&mut self, on_scroll: F)where
    F: 'static + FnMut(&mut ScrollView<V>, Rect) -> EventResult,
    V: 'static,

Sets a callback to be run whenever the scroll offset changes.

pub fn set_on_scroll_change<F>(&mut self, on_scroll: F)where
    F: 'static + FnMut(&mut Cursive, Rect),
    V: 'static,

Sets a callback to be run whenever the scroll offset changes.

pub fn on_scroll_inner<F>(self, on_scroll: F) -> ScrollView<V>where
    F: 'static + Fn(&mut ScrollView<V>, Rect) -> EventResult,

Sets a callback to be run whenever scrolling happens.

This lets the callback access the ScrollView itself (and its child) if necessary.

If you just need to run a callback on &mut Cursive, consider set_on_scroll.

Chainable variant.

pub fn on_scroll<F>(self, on_scroll: F) -> ScrollView<V>where
    F: 'static + FnMut(&mut Cursive, Rect),

Sets a callback to be run whenever scrolling happens.

Chainable variant.

pub fn get_inner(&self) -> &V

Gets access to the inner view.

pub fn get_inner_mut(&mut self) -> &mut V

Gets mutable access to the inner view.

Trait Implementations

impl<V> Default for ScrollView<V>where
    V: Default,

fn default() -> ScrollView<V>

Returns the “default value” for a type.

impl<V> Scroller for ScrollView<V>

fn get_scroller_mut(&mut self) -> &mut Core

Returns a mutable access to the scroll core.

fn get_scroller(&self) -> &Core

Returns an immutable access to the scroll core.

impl<V> View for ScrollView<V>where
    V: View,

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn layout(&mut self, size: XY<usize>)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn required_size(&mut self, constraint: XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions.

fn call_on_any(
    &mut self,
    selector: &Selector<'_>,
    cb: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Runs a closure on the view identified by the given selector.

fn focus_view(
    &mut self,
    selector: &Selector<'_>
) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn important_area(&self, size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.