Struct ScrollView

pub struct ScrollView {
    pub scroll_x: f32,
    pub scroll_y: f32,
    pub on_scroll: Option<Arc<dyn Fn(&mut EventContext<'_>, f32, f32) + Sync + Send>>,
    pub inner_width: f32,
    pub inner_height: f32,
    pub container_width: f32,
    pub container_height: f32,
    pub scroll_to_cursor: bool,
    pub show_horizontal_scrollbar: bool,
    pub show_vertical_scrollbar: bool,
}

A container a view which allows the user to scroll any overflowed content.

Fields

scroll_x: f32

Progress of scroll position between 0 and 1 for the x axis

scroll_y: f32

Progress of scroll position between 0 and 1 for the y axis

on_scroll: Option<Arc<dyn Fn(&mut EventContext<'_>, f32, f32) + Sync + Send>>

Callback called when the scrollview is scrolled.

inner_width: f32

Width of the inner VStack which holds the content (typically bigger than container_width)

inner_height: f32

Height of the inner VStack which holds the content (typically bigger than container_height)

container_width: f32

Width of the outer ScrollView which wraps the inner (typically smaller than inner_width)

container_height: f32

Height of the outer ScrollView which wraps the inner (typically smaller than inner_height)

scroll_to_cursor: bool

Whether the scrollbar should move to the cursor when pressed.

show_horizontal_scrollbar: bool

Whether the horizontal scrollbar should be visible.

show_vertical_scrollbar: bool

Whether the vertical scrollbar should be visible.

Implementations

impl ScrollView

pub fn new<F>(cx: &mut Context, content: F) -> Handle<'_, ScrollView>

where F: 'static + FnOnce(&mut Context),

Creates a new ScrollView.

Trait Implementations

impl Clone for ScrollView

fn clone(&self) -> ScrollView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Data for ScrollView

fn same(&self, other: &ScrollView) -> bool

A method which determines whether two pieces of data are the same.

impl View for ScrollView

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css.

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view.

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>

where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view.

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view.

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)

Provides a way to configure the accessibility features of a view.