Struct iced_native::widget::scrollable::Scrollable

pub struct Scrollable<'a, Message, Renderer> { /* private fields */ }

A widget that can vertically display an infinite amount of content with a scrollbar.

Implementations

impl<'a, Message, Renderer: Renderer> Scrollable<'a, Message, Renderer>

pub fn new(state: &'a mut State) -> Self

Creates a new Scrollable with the given State.

pub fn spacing(self, units: u16) -> Self

Sets the vertical spacing between elements.

Custom margins per element do not exist in Iced. You should use this method instead! While less flexible, it helps you keep spacing between elements consistent.

pub fn padding<P: Into<Padding>>(self, padding: P) -> Self

Sets the Padding of the Scrollable.

pub fn width(self, width: Length) -> Self

Sets the width of the Scrollable.

pub fn height(self, height: Length) -> Self

Sets the height of the Scrollable.

pub fn max_width(self, max_width: u32) -> Self

Sets the maximum width of the Scrollable.

pub fn max_height(self, max_height: u32) -> Self

Sets the maximum height of the Scrollable in pixels.

pub fn align_items(self, align_items: Alignment) -> Self

Sets the horizontal alignment of the contents of the Scrollable .

pub fn scrollbar_width(self, scrollbar_width: u16) -> Self

Sets the scrollbar width of the Scrollable . Silently enforces a minimum value of 1.

pub fn scrollbar_margin(self, scrollbar_margin: u16) -> Self

Sets the scrollbar margin of the Scrollable .

pub fn scroller_width(self, scroller_width: u16) -> Self

Sets the scroller width of the Scrollable .

It silently enforces a minimum value of 1.

pub fn on_scroll(self, f: impl Fn(f32) -> Message + 'static) -> Self

Sets a function to call when the Scrollable is scrolled.

The function takes the new relative offset of the Scrollable (e.g. 0 means top, while 1 means bottom).

pub fn style(self, style_sheet: impl Into<Box<dyn StyleSheet + 'a>>) -> Self

Sets the style of the Scrollable .

pub fn push<E>(self, child: E) -> Self where
    E: Into<Element<'a, Message, Renderer>>, 

Adds an element to the Scrollable.

Trait Implementations

impl<'a, Message, Renderer> From<Scrollable<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
    Renderer: 'a + Renderer,
    Message: 'a, 

fn from(
    scrollable: Scrollable<'a, Message, Renderer>
) -> Element<'a, Message, Renderer>

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Scrollable<'a, Message, Renderer> where
    Renderer: Renderer, 

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node

Returns the Node of the Widget.

fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    renderer: &Renderer,
    clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle,
    renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw(
    &self,
    renderer: &mut Renderer,
    style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn overlay(
    &mut self,
    layout: Layout<'_>,
    renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the Widget, if there is any.