Struct iced_native::widget::scrollable::Scrollable

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

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

Implementations

impl<'a, Message, Renderer> Scrollable<'a, Message, Renderer>where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet,

pub fn new(content: impl Into<Element<'a, Message, Renderer>>) -> Self

Creates a new Scrollable.

pub fn id(self, id: Id) -> Self

Sets the Id of the Scrollable.

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

Sets the height of the Scrollable.

pub fn vertical_scroll(self, properties: Properties) -> Self

Configures the vertical scrollbar of the Scrollable .

pub fn horizontal_scroll(self, properties: Properties) -> Self

Configures the horizontal scrollbar of the Scrollable .

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

Sets a function to call when the Scrollable is scrolled.

The function takes the new relative x & y offset of the Scrollable (e.g. 0 means beginning, while 1 means end).

pub fn style(
    self,
    style: impl Into<<Renderer::Theme as StyleSheet>::Style>
) -> Self

Sets the style of the Scrollable .

Trait Implementations

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

fn from(
    text_input: 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,
    Renderer::Theme: StyleSheet,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&self, tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

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 layout::Node of the Widget.

fn operate(
    &self,
    tree: &mut Tree,
    layout: Layout<'_>,
    renderer: &Renderer,
    operation: &mut dyn Operation<Message>
)

Applies an Operation to the Widget.

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

Processes a runtime Event.

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

Draws the Widget using the associated Renderer.

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

Returns the current mouse::Interaction of the Widget.

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

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