Struct iced_native::widget::scrollable::State

pub struct State { /* private fields */ }

The local state of a Scrollable.

Implementations

impl State

pub fn new() -> Self

Creates a new State with the scrollbar(s) at the beginning.

pub fn scroll( &mut self, delta: Vector<f32>, bounds: Rectangle, content_bounds: Rectangle )

Apply a scrolling offset to the current State, given the bounds of the Scrollable and its contents.

pub fn scroll_y_to( &mut self, percentage: f32, bounds: Rectangle, content_bounds: Rectangle )

Scrolls the Scrollable to a relative amount along the y axis.

0 represents scrollbar at the beginning, while 1 represents scrollbar at the end.

pub fn scroll_x_to( &mut self, percentage: f32, bounds: Rectangle, content_bounds: Rectangle )

Scrolls the Scrollable to a relative amount along the x axis.

0 represents scrollbar at the beginning, while 1 represents scrollbar at the end.

pub fn snap_to(&mut self, offset: RelativeOffset)

Snaps the scroll position to a RelativeOffset.

pub fn unsnap(&mut self, bounds: Rectangle, content_bounds: Rectangle)

Unsnaps the current scroll position, if snapped, given the bounds of the Scrollable and its contents.

pub fn offset(&self, bounds: Rectangle, content_bounds: Rectangle) -> Vector

Returns the scrolling offset of the State, given the bounds of the Scrollable and its contents.

pub fn scrollers_grabbed(&self) -> bool

Returns whether any scroller is currently grabbed or not.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.

impl Scrollable for State

fn snap_to(&mut self, offset: RelativeOffset)

Snaps the scroll of the widget to the given percentage along the horizontal & vertical axis.

impl Copy for State