UniformListScrollHandle

Struct UniformListScrollHandle 

Source
pub struct UniformListScrollHandle(pub Rc<RefCell<UniformListScrollState>>);
Expand description

A handle for controlling the scroll position of a uniform list. This should be stored in your view and passed to the uniform_list on each frame.

Tuple Fields§

§0: Rc<RefCell<UniformListScrollState>>

Implementations§

Source§

impl UniformListScrollHandle

Source

pub fn new() -> Self

Create a new scroll handle to bind to a uniform list.

Source

pub fn scroll_to_item(&self, ix: usize, strategy: ScrollStrategy)

Scroll the list so that the given item index is visible.

This uses non-strict scrolling: if the item is already fully visible, no scrolling occurs. If the item is out of view, it scrolls the minimum amount to bring it into view according to the strategy.

Source

pub fn scroll_to_item_strict(&self, ix: usize, strategy: ScrollStrategy)

Scroll the list so that the given item index is at scroll strategy position.

This uses strict scrolling: the item will always be scrolled to match the strategy position, even if it’s already visible. Use this when you need precise positioning.

Source

pub fn scroll_to_item_with_offset( &self, ix: usize, strategy: ScrollStrategy, offset: usize, )

Scroll the list to the given item index with an offset in number of items.

This uses non-strict scrolling: if the item is already visible within the offset region, no scrolling occurs.

The offset parameter shrinks the effective viewport by the specified number of items from the corresponding edge, then applies the scroll strategy within that reduced viewport:

  • ScrollStrategy::Top: Shrinks from top, positions item at the new top
  • ScrollStrategy::Center: Shrinks from top, centers item in the reduced viewport
  • ScrollStrategy::Bottom: Shrinks from bottom, positions item at the new bottom
Source

pub fn scroll_to_item_strict_with_offset( &self, ix: usize, strategy: ScrollStrategy, offset: usize, )

Scroll the list so that the given item index is at the exact scroll strategy position with an offset.

This uses strict scrolling: the item will always be scrolled to match the strategy position, even if it’s already visible.

The offset parameter shrinks the effective viewport by the specified number of items from the corresponding edge, then applies the scroll strategy within that reduced viewport:

  • ScrollStrategy::Top: Shrinks from top, positions item at the new top
  • ScrollStrategy::Center: Shrinks from top, centers item in the reduced viewport
  • ScrollStrategy::Bottom: Shrinks from bottom, positions item at the new bottom
Source

pub fn y_flipped(&self) -> bool

Check if the list is flipped vertically.

Source

pub fn is_scrollable(&self) -> bool

Checks if the list can be scrolled vertically.

Source

pub fn scroll_to_bottom(&self)

Scroll to the bottom of the list.

Trait Implementations§

Source§

impl Clone for UniformListScrollHandle

Source§

fn clone(&self) -> UniformListScrollHandle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UniformListScrollHandle

Source§

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

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

impl Default for UniformListScrollHandle

Source§

fn default() -> UniformListScrollHandle

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more