Struct iced_pure::widget::scrollable::Scrollable
source · [−]pub struct Scrollable<'a, Message, Renderer> { /* private fields */ }
Expand description
A widget that can vertically display an infinite amount of content with a scrollbar.
Implementations
sourceimpl<'a, Message, Renderer: Renderer> Scrollable<'a, Message, Renderer>
impl<'a, Message, Renderer: Renderer> Scrollable<'a, Message, Renderer>
sourcepub fn new(content: impl Into<Element<'a, Message, Renderer>>) -> Self
pub fn new(content: impl Into<Element<'a, Message, Renderer>>) -> Self
Creates a new Scrollable
.
sourcepub fn height(self, height: Length) -> Self
pub fn height(self, height: Length) -> Self
Sets the height of the Scrollable
.
sourcepub fn scrollbar_width(self, scrollbar_width: u16) -> Self
pub fn scrollbar_width(self, scrollbar_width: u16) -> Self
Sets the scrollbar width of the Scrollable
.
Silently enforces a minimum value of 1.
sourcepub fn scrollbar_margin(self, scrollbar_margin: u16) -> Self
pub fn scrollbar_margin(self, scrollbar_margin: u16) -> Self
Sets the scrollbar margin of the Scrollable
.
sourcepub fn scroller_width(self, scroller_width: u16) -> Self
pub fn scroller_width(self, scroller_width: u16) -> Self
Sets the scroller width of the Scrollable
.
It silently enforces a minimum value of 1.
sourcepub fn on_scroll(self, f: impl Fn(f32) -> Message + 'a) -> Self
pub fn on_scroll(self, f: impl Fn(f32) -> Message + 'a) -> 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).
sourcepub fn style(self, style_sheet: impl Into<Box<dyn StyleSheet + 'a>>) -> Self
pub fn style(self, style_sheet: impl Into<Box<dyn StyleSheet + 'a>>) -> Self
Sets the style of the Scrollable
.
Trait Implementations
sourceimpl<'a, Message, Renderer> From<Scrollable<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
impl<'a, Message, Renderer> From<Scrollable<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
sourcefn from(
text_input: Scrollable<'a, Message, Renderer>
) -> Element<'a, Message, Renderer>
fn from(
text_input: Scrollable<'a, Message, Renderer>
) -> Element<'a, Message, Renderer>
Converts to this type from the input type.
sourceimpl<'a, Message, Renderer> Widget<Message, Renderer> for Scrollable<'a, Message, Renderer> where
Renderer: Renderer,
impl<'a, Message, Renderer> Widget<Message, Renderer> for Scrollable<'a, Message, Renderer> where
Renderer: Renderer,
sourcefn layout(&self, renderer: &Renderer, limits: &Limits) -> Node
fn layout(&self, renderer: &Renderer, limits: &Limits) -> Node
Returns the layout::Node
of the Widget
. Read more
sourcefn 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
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
sourcefn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
style: &Style,
layout: Layout<'_>,
cursor_position: Point,
_viewport: &Rectangle
)
fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
style: &Style,
layout: Layout<'_>,
cursor_position: Point,
_viewport: &Rectangle
)
Draws the Widget
using the associated Renderer
.
sourcefn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor_position: Point,
_viewport: &Rectangle,
renderer: &Renderer
) -> Interaction
fn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor_position: Point,
_viewport: &Rectangle,
renderer: &Renderer
) -> Interaction
Auto Trait Implementations
impl<'a, Message, Renderer> !RefUnwindSafe for Scrollable<'a, Message, Renderer>
impl<'a, Message, Renderer> !Send for Scrollable<'a, Message, Renderer>
impl<'a, Message, Renderer> !Sync for Scrollable<'a, Message, Renderer>
impl<'a, Message, Renderer> Unpin for Scrollable<'a, Message, Renderer>
impl<'a, Message, Renderer> !UnwindSafe for Scrollable<'a, Message, Renderer>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more