Skip to main content

ScrollState

Struct ScrollState 

Source
pub struct ScrollState { /* private fields */ }

Implementations§

Source§

impl ScrollState

Source

pub fn new() -> Self

Source

pub fn viewport_size(&self) -> Size

Source

pub fn content_size(&self) -> Size

Source

pub fn current_offset(&self) -> Vector

Source

pub fn max_offset(&self) -> Vector

Source

pub fn set_offset(&self, offset: Vector) -> bool

Updates the shared scroll offset, clamped to the current viewport and content metrics. Returns whether the effective offset changed.

Widgets bound to this state observe the new offset on their next layout pass; event handlers should request the corresponding invalidation.

Source

pub fn scroll_to_item(&self, index: usize) -> bool

Queues a virtual-scroll item to align with the viewport start on the next layout pass. Returns whether the pending request changed.

Resolving the request during layout keeps the target aligned with the item’s latest measured position, including requests made before the first render.

Source

pub fn scroll_to_item_with_ctx(&self, index: usize, ctx: &mut EventCtx) -> bool

Queues a virtual-scroll item and invalidates the bound viewport so the jump is laid out and repainted in the frame requested by an event.

Source

pub fn virtual_item_at(&self, y: f32) -> Option<usize>

Index of the virtual-scroll item whose extent contains the content offset y, measured from the top of the scrolled content. Offsets past the last item resolve to the last item; returns None before the bound VirtualScrollView has been laid out or when it has no items.

Scroll-spy navigation compares this against the current offset, for example virtual_item_at(current_offset().y + threshold).

Source

pub fn first_visible_item(&self) -> Option<usize>

Index of the virtual-scroll item at the top edge of the viewport.

Source

pub fn virtual_item_offset(&self, index: usize) -> Option<f32>

Content-space top of a virtual-scroll item from the latest layout.

Trait Implementations§

Source§

impl Clone for ScrollState

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScrollState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScrollState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.