Struct cosmic::iced_widget::scrollable::Scrollable
source · pub struct Scrollable<'a, Message, Theme = Theme, Renderer = Renderer>{ /* private fields */ }
Expand description
A widget that can vertically display an infinite amount of content with a scrollbar.
§Example
use iced::widget::{column, scrollable, vertical_space};
enum Message {
// ...
}
fn view(state: &State) -> Element<'_, Message> {
scrollable(column![
"Scroll me!",
vertical_space().height(3000),
"You did it!",
]).into()
}
Implementations§
source§impl<'a, Message, Theme, Renderer> Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> Scrollable<'a, Message, Theme, Renderer>
sourcepub fn new(
content: impl Into<Element<'a, Message, Theme, Renderer>>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn new( content: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> Scrollable<'a, Message, Theme, Renderer>
Creates a new vertical Scrollable
.
sourcepub fn with_direction(
content: impl Into<Element<'a, Message, Theme, Renderer>>,
direction: impl Into<Direction>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn with_direction( content: impl Into<Element<'a, Message, Theme, Renderer>>, direction: impl Into<Direction>, ) -> Scrollable<'a, Message, Theme, Renderer>
Creates a new vertical Scrollable
.
sourcepub fn direction(
self,
direction: impl Into<Direction>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn direction( self, direction: impl Into<Direction>, ) -> Scrollable<'a, Message, Theme, Renderer>
Creates a new Scrollable
with the given Direction
.
sourcepub fn id(self, id: Id) -> Scrollable<'a, Message, Theme, Renderer>
pub fn id(self, id: Id) -> Scrollable<'a, Message, Theme, Renderer>
Sets the Id
of the Scrollable
.
sourcepub fn width(
self,
width: impl Into<Length>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn width( self, width: impl Into<Length>, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the width of the Scrollable
.
sourcepub fn height(
self,
height: impl Into<Length>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn height( self, height: impl Into<Length>, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the height of the Scrollable
.
sourcepub fn on_scroll(
self,
f: impl Fn(Viewport) -> Message + 'a,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn on_scroll( self, f: impl Fn(Viewport) -> Message + 'a, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets a function to call when the Scrollable
is scrolled.
The function takes the Viewport
of the Scrollable
sourcepub fn anchor_top(self) -> Scrollable<'a, Message, Theme, Renderer>
pub fn anchor_top(self) -> Scrollable<'a, Message, Theme, Renderer>
Anchors the vertical Scrollable
direction to the top.
sourcepub fn anchor_bottom(self) -> Scrollable<'a, Message, Theme, Renderer>
pub fn anchor_bottom(self) -> Scrollable<'a, Message, Theme, Renderer>
Anchors the vertical Scrollable
direction to the bottom.
sourcepub fn anchor_left(self) -> Scrollable<'a, Message, Theme, Renderer>
pub fn anchor_left(self) -> Scrollable<'a, Message, Theme, Renderer>
Anchors the horizontal Scrollable
direction to the left.
sourcepub fn anchor_right(self) -> Scrollable<'a, Message, Theme, Renderer>
pub fn anchor_right(self) -> Scrollable<'a, Message, Theme, Renderer>
Anchors the horizontal Scrollable
direction to the right.
sourcepub fn anchor_x(
self,
alignment: Anchor,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn anchor_x( self, alignment: Anchor, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the Anchor
of the horizontal direction of the Scrollable
, if applicable.
sourcepub fn anchor_y(
self,
alignment: Anchor,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn anchor_y( self, alignment: Anchor, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the Anchor
of the vertical direction of the Scrollable
, if applicable.
sourcepub fn spacing(
self,
new_spacing: impl Into<Pixels>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn spacing( self, new_spacing: impl Into<Pixels>, ) -> Scrollable<'a, Message, Theme, Renderer>
Embeds the Scrollbar
into the Scrollable
, instead of floating on top of the
content.
The spacing
provided will be used as space between the Scrollbar
and the contents
of the Scrollable
.
sourcepub fn style(
self,
style: impl Fn(&Theme, Status) -> Style + 'a,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the style of this Scrollable
.
sourcepub fn class(
self,
class: impl Into<<Theme as Catalog>::Class<'a>>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the style class of the Scrollable
.
sourcepub fn name(
self,
name: impl Into<Cow<'a, str>>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn name( self, name: impl Into<Cow<'a, str>>, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the name of the Scrollable
.
sourcepub fn description_widget(
self,
description: &impl Describes,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn description_widget( self, description: &impl Describes, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the description of the Scrollable
.
sourcepub fn description(
self,
description: impl Into<Cow<'a, str>>,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn description( self, description: impl Into<Cow<'a, str>>, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the description of the Scrollable
.
sourcepub fn label(
self,
label: &dyn Labels,
) -> Scrollable<'a, Message, Theme, Renderer>
pub fn label( self, label: &dyn Labels, ) -> Scrollable<'a, Message, Theme, Renderer>
Sets the label of the Scrollable
.
Trait Implementations§
source§impl<'a, Message, Theme, Renderer> From<Scrollable<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> From<Scrollable<'a, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>
source§fn from(
text_input: Scrollable<'a, Message, Theme, Renderer>,
) -> Element<'a, Message, Theme, Renderer>
fn from( text_input: Scrollable<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>
source§impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Scrollable<'a, Message, Theme, Renderer>
source§fn operate(
&self,
tree: &mut Tree,
layout: Layout<'_>,
renderer: &Renderer,
operation: &mut dyn Operation,
)
fn operate( &self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )
source§fn on_event(
&mut self,
tree: &mut Tree,
event: Event,
layout: Layout<'_>,
cursor: Cursor,
renderer: &Renderer,
clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>,
_viewport: &Rectangle,
) -> Status
fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status
source§fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer,
theme: &Theme,
defaults: &Style,
layout: Layout<'_>,
cursor: Cursor,
viewport: &Rectangle,
)
fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, defaults: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )
Widget
using the associated Renderer
.source§fn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor: Cursor,
_viewport: &Rectangle,
renderer: &Renderer,
) -> Interaction
fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, renderer: &Renderer, ) -> Interaction
source§fn overlay<'b>(
&'b mut self,
tree: &'b mut Tree,
layout: Layout<'_>,
renderer: &Renderer,
translation: Vector,
) -> Option<Element<'b, Message, Theme, Renderer>>
fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>
Widget
, if there is any.source§fn a11y_nodes(
&self,
layout: Layout<'_>,
state: &Tree,
cursor: Cursor,
) -> A11yTree
fn a11y_nodes( &self, layout: Layout<'_>, state: &Tree, cursor: Cursor, ) -> A11yTree
source§fn set_id(&mut self, id: Id)
fn set_id(&mut self, id: Id)
source§fn drag_destinations(
&self,
tree: &Tree,
layout: Layout<'_>,
renderer: &Renderer,
dnd_rectangles: &mut DndDestinationRectangles,
)
fn drag_destinations( &self, tree: &Tree, layout: Layout<'_>, renderer: &Renderer, dnd_rectangles: &mut DndDestinationRectangles, )
Auto Trait Implementations§
impl<'a, Message, Theme, Renderer> Freeze for Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !RefUnwindSafe for Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !Send for Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !Sync for Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme, Renderer> Unpin for Scrollable<'a, Message, Theme, Renderer>
impl<'a, Message, Theme = Theme, Renderer = Renderer> !UnwindSafe for Scrollable<'a, Message, Theme, Renderer>
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more