Struct ScrollColumnScope 

pub struct ScrollColumnScope { /* private fields */ }

A ScrollColumn and its builder.

Implementations

impl ScrollColumnScope

pub fn scroll_state(self, state: &ScrollState) -> Self

Binds a ScrollState so the application can read offset() and max_offset() or call scroll_to and animate_scroll_to.

pub fn snap(self, snap: Snap) -> Self

Where the content comes to rest once a drag or a fling ends.

Snap::None, the default, stops wherever the user left it. Snap::ItemStart stops with the start edge of the nearest direct child on the start of the visible area, like CSS scroll-snap-align: start. The Renderer runs the snap, so it follows the platform’s fling physics.

impl ScrollColumnScope

pub fn modifier(self, modifier: Modifier) -> Self

What sits around it. Compose’s modifier parameter.

impl ScrollColumnScope

pub fn content(self, content: impl FnOnce())

Composes this widget with content as its children.

impl ScrollColumnScope

pub fn on_pointer( self, kinds: PointerKinds, handler: impl FnMut(PointerEvent) + 'static, ) -> Self

Subscribes the node to the kinds of pointer input in kinds. The handler runs on the same call as the input; calling consume on the event keeps it from the nearest subscribed ancestor and from the Renderer’s own handling.

A node that never calls this has no pointer input at all, and costs nothing.

impl ScrollColumnScope

pub fn on_click(self, handler: impl FnMut() + 'static) -> Self

Makes the container a button. The Renderer gives it keyboard focus, runs the handler on a click and on Enter or Space, announces it to assistive technology as a button, and shows hover, pressed and focus state.

A container that never calls this is not a control and costs nothing.

impl ScrollColumnScope

pub fn on_focus_gained(self, handler: impl FnMut() + 'static) -> Self

Runs when this node or a descendant inside it gains keyboard focus.

pub fn on_focus_lost(self, handler: impl FnMut() + 'static) -> Self

Runs when this node and its descendants lose keyboard focus.

pub fn on_key_down(self, handler: impl FnMut(KeyEvent) + 'static) -> Self

Sees each key pressed while this node or a descendant inside it holds focus; calling consume on the event keeps the Renderer from acting on it.

pub fn on_key_up(self, handler: impl FnMut(KeyEvent) + 'static) -> Self

Sees each key released while this node or a descendant inside it holds focus.

pub fn focus_handle(self, handle: &FocusHandle) -> Self

Binds handle to this node, so handle.request() puts keyboard focus here.

pub fn on_motion_finished( self, handler: impl FnMut(MotionFinished) + 'static, ) -> Self

Runs once when this node’s size motion comes to rest, with the size it settled at in dp. The node needs Modifier::motion for its size to move; without it nothing is reported. A run interrupted by a newer size is not reported, only the one that settles, and under reduced motion it arrives in the frame the size changes in.

Trait Implementations

impl Drop for ScrollColumnScope

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.