Struct ScrollHandle 

pub struct ScrollHandle(/* private fields */);

A handle to the scrollable aspects of an element. Used for accessing scroll state, like the current scroll offset, and for mutating the scroll state, like scrolling to a specific child.

Implementations

impl ScrollHandle

pub fn new() -> Self

Construct a new scroll handle.

pub fn offset(&self) -> Point<Pixels>

Get the current scroll offset.

pub fn max_offset(&self) -> Size<Pixels>

Get the maximum scroll offset.

pub fn top_item(&self) -> usize

Get the top child that’s scrolled into view.

pub fn bottom_item(&self) -> usize

Get the bottom child that’s scrolled into view.

pub fn bounds(&self) -> Bounds<Pixels>

Return the bounds into which this child is painted

pub fn bounds_for_item(&self, ix: usize) -> Option<Bounds<Pixels>>

Get the bounds for a specific child.

pub fn scroll_to_item(&self, ix: usize)

Update [ScrollHandleState]’s active item for scrolling to in prepaint

pub fn scroll_to_top_of_item(&self, ix: usize)

Update [ScrollHandleState]’s active item for scrolling to in prepaint This scrolls the minimal amount to ensure that the child is the first visible element

pub fn scroll_to_bottom(&self)

Scrolls to the bottom.

pub fn set_offset(&self, position: Point<Pixels>)

Set the offset explicitly. The offset is the distance from the top left of the parent container to the top left of the first child. As you scroll further down the offset becomes more negative.

pub fn logical_scroll_top(&self) -> (usize, Pixels)

Get the logical scroll top, based on a child index and a pixel offset.

pub fn logical_scroll_bottom(&self) -> (usize, Pixels)

Get the logical scroll bottom, based on a child index and a pixel offset.

pub fn children_count(&self) -> usize

Get the count of children for scrollable item.

Trait Implementations

impl Clone for ScrollHandle

fn clone(&self) -> ScrollHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollHandle

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

Formats the value using the given formatter.

impl Default for ScrollHandle

fn default() -> Self

Returns the “default value” for a type.