Struct dotrix_egui::ScrollArea

pub struct ScrollArea { /* fields omitted */ }

Add vertical scrolling to a contained Ui.

Implementations

impl ScrollArea

pub fn auto_sized() -> ScrollArea

Will make the area be as high as it is allowed to be (i.e. fill the Ui it is in)

pub fn from_max_height(max_height: f32) -> ScrollArea

Use f32::INFINITY if you want the scroll area to expand to fit the surrounding Ui

pub fn always_show_scroll(self, always_show_scroll: bool) -> ScrollArea

If false (default), the scroll bar will be hidden when not needed/ If true, the scroll bar will always be displayed even if not needed.

pub fn id_source(self, id_source: impl Hash) -> ScrollArea

A source for the unique Id, e.g. .id_source("second_scroll_area") or .id_source(loop_index).

pub fn scroll_offset(self, offset: f32) -> ScrollArea

Set the vertical scroll offset position.

See also: Ui::scroll_to_cursor and Response::scroll_to_me

pub fn enable_scrolling(self, enable: bool) -> ScrollArea

Control the scrolling behavior If true (default), the scroll area will respond to user scrolling If false, the scroll area will not respond to user scrolling

This can be used, for example, to optionally freeze scrolling while the user is inputing text in a TextEdit widget contained within the scroll area

impl ScrollArea

pub fn show<R>(self, ui: &mut Ui, add_contents: impl FnOnce(&mut Ui) -> R) -> R

Show the ScrollArea, and add the contents to the viewport.

If the inner area can be very long, consider using Self::show_rows instead.

pub fn show_rows<R>(
    self,
    ui: &mut Ui,
    row_height_sans_spacing: f32,
    num_rows: usize,
    add_contents: impl FnOnce(&mut Ui, Range<usize>) -> R
) -> R

Efficiently show only the visible part of a large number of rows.

let text_style = egui::TextStyle::Body;
let row_height = ui.fonts()[text_style].row_height();
// let row_height = ui.spacing().interact_size.y; // if you are adding buttons instead of labels.
let num_rows = 10_000;
egui::ScrollArea::auto_sized().show_rows(ui, row_height, num_rows, |ui, row_range| {
    for row in row_range {
        let text = format!("Row {}/{}", row + 1, num_rows);
        ui.label(text);
    }
});

pub fn show_viewport<R>(
    self,
    ui: &mut Ui,
    add_contents: impl FnOnce(&mut Ui, Rect) -> R
) -> R

This can be used to only paint the visible part of the contents.

add_contents is past the viewport, which is the relative view of the content. So if the passed rect has min = zero, then show the top left content (the user has not scrolled).

Trait Implementations

impl Clone for ScrollArea

pub fn clone(&self) -> ScrollArea

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollArea

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

Formats the value using the given formatter.