Struct AutoScroll

pub struct AutoScroll {
    pub scroll_offset: f32,
    pub enabled: bool,
    pub distance_from_min: f32,
    pub distance_from_max: f32,
    pub max_speed: f32,
}

Handles automatic scrolling when dragging items near the edges of the table’s view.

The AutoScroll struct allows the table to automatically scroll when the user drags items near the top or bottom edge of the view. It provides configurable parameters such as the speed of scrolling and the distances from the edges at which scrolling is triggered.

Fields

scroll_offset: f32

The current vertical scroll offset.

enabled: bool

Whether auto-scrolling is enabled or disabled.

distance_from_min: f32

The minimum distance from the top edge before auto-scrolling starts. Extra space due to the header being in the way. Default: 200.0

distance_from_max: f32

The minimum distance from the bottom edge before auto-scrolling starts. Default: 120.0

max_speed: f32

The maximum speed at which auto-scrolling occurs. Default: 30.0

Implementations

impl AutoScroll

pub fn new(enabled: bool) -> Self

Creates a new instance of AutoScroll with the option to enable or disable auto-scrolling.

Parameters:

• enabled: Whether auto-scrolling should be enabled.

Example:

let auto_scroll = AutoScroll::new(true); // Enables auto-scrolling

pub const fn distance_from_min(self, distance: f32) -> Self

Sets the minimum distance from the top edge at which auto-scrolling is triggered.

Parameters:

• distance: The distance from the top edge in pixels.

Returns:

An updated instance of AutoScroll with the specified distance_from_min value.

Considerations:

• Add some extra distance due to the header being in the way of selection

Example:

let auto_scroll = AutoScroll::new(true).distance_from_min(100.0); // Auto-scrolls when 100 pixels from top

pub const fn distance_from_max(self, distance: f32) -> Self

Sets the minimum distance from the bottom edge at which auto-scrolling is triggered.

Parameters:

• distance: The distance from the bottom edge in pixels.

Returns:

An updated instance of AutoScroll with the specified distance_from_max value.

Example:

let auto_scroll = AutoScroll::new(true).distance_from_max(80.0); // Auto-scrolls when 80 pixels from bottom

pub const fn max_speed(self, speed: f32) -> Self

Sets the maximum scroll speed when auto-scrolling is triggered.

Parameters:

• speed: The maximum scroll speed

Returns:

An updated instance of AutoScroll with the specified max_speed.

Example:

let auto_scroll = AutoScroll::new(true).max_speed(50.0); // Sets the max scroll speed to 50.0

Trait Implementations

impl Default for AutoScroll

fn default() -> Self

Returns the “default value” for a type.