pub struct CarouselView<Msg = Callback> { /* private fields */ }Expand description
A controlled carousel.
Implementations§
Source§impl<Msg: Clone + 'static> CarouselView<Msg>
impl<Msg: Clone + 'static> CarouselView<Msg>
Trait Implementations§
Source§impl<Msg: Clone> Widget<Msg> for CarouselView<Msg>
impl<Msg: Clone> Widget<Msg> for CarouselView<Msg>
Source§fn paint(
&self,
_bounds: Rect,
_status: Status,
_theme: &Theme,
_scene: &mut Scene,
)
fn paint( &self, _bounds: Rect, _status: Status, _theme: &Theme, _scene: &mut Scene, )
Paints the widget’s own decoration, according to its status (hover / focus /
cursor / selection) and the current theme.
Source§fn opaque(&self) -> bool
fn opaque(&self) -> bool
Whether a press that lands on this widget and on nothing inside it stops
here. Read more
Source§fn key(&self) -> Option<u64>
fn key(&self) -> Option<u64>
Stable identity key (independent of the position among siblings).
None = positional identity. See crate::Keyed.Source§fn debug_name(&self) -> &'static str
fn debug_name(&self) -> &'static str
Short name of the widget — for the inspector and diagnostic dumps.
Defaults to the name of the concrete type, without module path or
generics (each implementation gets its own monomorphised copy of this
default body). Transparent wrappers (
Box, crate::Keyed…) delegate
to their content.Source§fn semantics(&self) -> Option<SemanticsProperties>
fn semantics(&self) -> Option<SemanticsProperties>
The widget’s accessibility annotation (role, label, value, state),
exposed to assistive technologies through the AccessKit tree.
None =
no semantics of its own (a layout container — its children, though,
may have some). See frus_core::SemanticsProperties.Source§fn describes(&self) -> Option<Description>
fn describes(&self) -> Option<Description>
What this widget says about its child’s subtree, when it knows something the
child cannot know about itself — the
crate::Semantics wrapper, and nothing else
so far. Read moreSource§fn on_edit(&self, _edit: &mut Edit, _key: &Key) -> Option<Msg>
fn on_edit(&self, _edit: &mut Edit, _key: &Key) -> Option<Msg>
Applies a key to the focused widget: mutates the edit state
(cursor/selection) and returns a message if the value changes.
Source§fn positional_click(
&self,
_local_x: f32,
_local_y: f32,
_width: f32,
_height: f32,
) -> Option<Msg>
fn positional_click( &self, _local_x: f32, _local_y: f32, _width: f32, _height: f32, ) -> Option<Msg>
Positional click: a message emitted according to where the click landed (local
coordinates from the widget’s top-left corner, within the
width × height box), taking
priority over on_click. For clickable sub-regions — e.g. the
suffix icon of a crate::TextField (clear / reveal) or a chart point
(milestone 221). None (the default) = no sub-region; the shell falls back to on_click.Source§fn cursor_icon(
&self,
_local_x: f32,
_local_y: f32,
_width: f32,
_height: f32,
) -> Option<Cursor>
fn cursor_icon( &self, _local_x: f32, _local_y: f32, _width: f32, _height: f32, ) -> Option<Cursor>
Shape of the system cursor wanted at the local position
(local_x, local_y) inside
the widget’s width × height box (milestone 205): Some(Cursor::Pointer) over a clickable
sub-region (a suffix icon…), None (the default) = no opinion, the shell keeps the default
cursor. Does not affect clicking; this is purely the pointer’s appearance on hover.Source§fn cursor_at(
&self,
_local_x: f32,
_local_y: f32,
_width: f32,
_scroll_cursor: usize,
) -> Option<usize>
fn cursor_at( &self, _local_x: f32, _local_y: f32, _width: f32, _scroll_cursor: usize, ) -> Option<usize>
Cursor index matching a local position (px from the widget’s top-left
corner) — for placing the caret on click.
local_y picks the line in a
multi-line field (ignored on a single line). Read moreSource§fn text_metrics(
&self,
_width: f32,
_cursor: usize,
) -> Option<(f32, f32, f32, f32)>
fn text_metrics( &self, _width: f32, _cursor: usize, ) -> Option<(f32, f32, f32, f32)>
SingleChildScrollView metrics of a multi-line field, for a widget width and a cursor:
(content height, visible box height, caret top, caret height), in content
space (px). The shell uses them to register the scrollable region and to keep
the caret in view. None otherwise.Source§fn text_viewport(&self, _rect: Rect) -> Option<Rect>
fn text_viewport(&self, _rect: Rect) -> Option<Rect>
Frame (input box) of a multi-line field within its
rect — the area where
the text scrolls, below the label. Used to place the scrollbar and the
scrollable region exactly on the box. None otherwise.Source§fn caret_vertical(
&self,
_width: f32,
_cursor: usize,
_down: bool,
_page: bool,
_goal_x: Option<f32>,
) -> Option<(usize, f32)>
fn caret_vertical( &self, _width: f32, _cursor: usize, _down: bool, _page: bool, _goal_x: Option<f32>, ) -> Option<(usize, f32)>
Moves the caret vertically in a multi-line field and returns
(new index, visual column used). Read moreSource§fn selected_text(&self, _edit: &Edit) -> Option<String>
fn selected_text(&self, _edit: &Edit) -> Option<String>
The currently selected text (for copy/cut).
Source§fn text_value(&self) -> Option<&str>
fn text_value(&self) -> Option<&str>
The field’s whole value, if this widget is a text field — to give the
IME its input context (suggestions).
None otherwise.Source§fn replace_value(&self, _value: String) -> Option<Msg>
fn replace_value(&self, _value: String) -> Option<Msg>
The message that puts
value in this field: the one typing would have produced,
for a value the framework restores rather than the user typing it. Read moreSource§fn word_at(&self, _index: usize) -> Option<(usize, usize)>
fn word_at(&self, _index: usize) -> Option<(usize, usize)>
Range
(start, end) of the word around the given index (for double-click).Source§fn selection_handles(
&self,
_width: f32,
_edit: &Edit,
_scroll_y: f32,
) -> Option<[SelectionHandle; 2]>
fn selection_handles( &self, _width: f32, _edit: &Edit, _scroll_y: f32, ) -> Option<[SelectionHandle; 2]>
The two handles of the selection in
edit, start then end, for a field width
wide whose content is scrolled down by scroll_y — where they are painted, and
so where a finger takes them. None when there is no selection, or this is not
a text field.Source§fn shortcut_bindings(&self) -> &[(KeyStroke, Intent)]
fn shortcut_bindings(&self) -> &[(KeyStroke, Intent)]
Keystrokes this subtree binds to intents — see
crate::Shortcuts.Source§fn shortcut_callbacks(&self) -> &[(KeyStroke, Msg)]
fn shortcut_callbacks(&self) -> &[(KeyStroke, Msg)]
Keystrokes this subtree binds straight to messages — see
crate::CallbackShortcuts.Source§fn action_bindings(&self) -> &[(Intent, Msg)]
fn action_bindings(&self) -> &[(Intent, Msg)]
Intents this subtree answers — see
crate::Actions.Source§fn action_listeners(&self) -> &[(Intent, Msg)]
fn action_listeners(&self) -> &[(Intent, Msg)]
Intents this subtree watches without answering — see
crate::ActionListener.Source§fn on_keystroke(&self) -> Option<Rc<dyn Fn(KeyStroke) -> Option<Msg>>>
fn on_keystroke(&self) -> Option<Rc<dyn Fn(KeyStroke) -> Option<Msg>>>
Every keystroke reaching this subtree, handed to a closure — see
crate::KeyboardListener. None (the default) is not a listener.Source§fn descendants_focusable(&self) -> bool
fn descendants_focusable(&self) -> bool
If
false, nothing inside this subtree can take focus — the reference’s
ExcludeFocus. A dimmed panel behind a sheet is still drawn and still measured;
it simply stops being somewhere Tab can land.Source§fn focus_skip_traversal(&self) -> bool
fn focus_skip_traversal(&self) -> bool
If
true, this subtree’s focus stops are skipped by Tab while remaining
focusable by a click — the reference’s ExcludeFocusTraversal. The two are
separate questions: a toolbar button may be reachable with the pointer and still
not belong in the keyboard’s order.Source§fn focus_order(&self) -> Option<f32>
fn focus_order(&self) -> Option<f32>
A traversal order for this subtree’s focus stops, smallest first — the
reference’s
NumericFocusOrder. None leaves them in tree order, which is where
everything sits until someone says otherwise.Source§fn focus_group(&self) -> bool
fn focus_group(&self) -> bool
If
true, this subtree is a traversal group: an order set inside it is
resolved among its own members and nowhere else, so a reordered dialog does not
reshuffle the page behind it.Source§fn autofill_hints(&self) -> &[AutofillHint]
fn autofill_hints(&self) -> &[AutofillHint]
What this field is for, so the platform can fill it in — see
AutofillHint. Empty (the default) is a field that takes
no part in autofill at all. Read moreSource§fn autofill_group(&self) -> bool
fn autofill_group(&self) -> bool
If
true, this subtree’s fields are one form — the reference’s
AutofillGroup. A service shown a password with no username beside it has
nothing to save the pair under.Source§fn draws_own_focus(&self) -> bool
fn draws_own_focus(&self) -> bool
If
true, the widget draws its focus indicator itself (the driver then
does not stroke the generic ring). E.g. TextField.Source§fn draggable(&self) -> bool
fn draggable(&self) -> bool
If
true, the widget responds to pointer dragging (sliders, handles).Source§fn on_drag(&self, _fraction: f32) -> Option<Msg>
fn on_drag(&self, _fraction: f32) -> Option<Msg>
Message produced while dragging,
fraction being the relative horizontal
position (0.0..=1.0) within the widget’s bounds.Source§fn on_drag_start(&self, _fraction: f32) -> Option<Msg>
fn on_drag_start(&self, _fraction: f32) -> Option<Msg>
Source§fn on_drag_end(&self, _fraction: f32) -> Option<Msg>
fn on_drag_end(&self, _fraction: f32) -> Option<Msg>
Message produced when a value drag ends — on the release, with the
fraction the pointer finished on. Read more
Source§fn on_drag_delta(&self, _dx: f32) -> Option<Msg>
fn on_drag_delta(&self, _dx: f32) -> Option<Msg>
Message produced by a horizontal drag expressed as a delta:
dx is the
movement (logical px) since the last event. For handles that accumulate
(column resizing), unlike on_drag (an absolute fraction,
e.g. a slider). The shell tries it before on_drag; a widget implements
only one of the two.Source§fn hero_tag(&self) -> Option<u64>
fn hero_tag(&self) -> Option<u64>
If this widget is a shared element, its tag. Two heroes with the same tag on
the two sides of a route transition are one thing in two places.
See
crate::Hero.Source§fn drag_payload(&self) -> Option<u64>
fn drag_payload(&self) -> Option<u64>
If this widget can be picked up and dropped elsewhere, what it carries.
See
crate::Draggable.Source§fn drag_needs_long_press(&self) -> bool
fn drag_needs_long_press(&self) -> bool
Does this item lift on a long press rather than on the first movement?
The answer inside a scrollable, where a plain drag belongs to the scroll. Read more
Source§fn drag_ghost_opacity(&self) -> f32
fn drag_ghost_opacity(&self) -> f32
How solid the item left behind looks while a copy of it is being dragged.
Source§fn on_dropped(&self, _accepted: bool) -> Option<Msg>
fn on_dropped(&self, _accepted: bool) -> Option<Msg>
Message sent when a drag of this item ends,
true if a target took it.Source§fn drop_zone(&self) -> bool
fn drop_zone(&self) -> bool
Is this widget a drop target? See
crate::DragTarget.Source§fn accepts_drag(&self, _payload: u64) -> bool
fn accepts_drag(&self, _payload: u64) -> bool
Would this target take
payload? Only asked of a drop target.Source§fn on_drop(&self, _payload: u64) -> Option<Msg>
fn on_drop(&self, _payload: u64) -> Option<Msg>
Message sent when an accepted item is dropped on this target.
Source§fn reorder_index(&self) -> Option<usize>
fn reorder_index(&self) -> Option<usize>
If this widget is a reorderable header, its column index. The shell uses
it to identify the source column (on press) and the target column
(under the pointer on release) of a reordering drag.
Source§fn on_reorder(&self, _to: usize) -> Option<Msg>
fn on_reorder(&self, _to: usize) -> Option<Msg>
Message emitted when this header (the source) is dropped on column
to.
The widget knows its own index and the on_reorder(from, to) callback.Source§fn reorder_axis(&self) -> ReorderAxis
fn reorder_axis(&self) -> ReorderAxis
Movement axis of this reorderable (default
ReorderAxis::Horizontal): the shell
orients the drag preview (ghost + insertion indicator) accordingly. Kanban cards
return ReorderAxis::Vertical.Source§fn reorder_inserts(&self) -> bool
fn reorder_inserts(&self) -> bool
Is a horizontal reorderable dropped between its neighbours, like a list’s row,
rather than into the place of the one under the pointer, like a table’s column?
false by default, which is the table. Read moreSource§fn reorder_draggable(&self) -> bool
fn reorder_draggable(&self) -> bool
Can this reorderable be picked up as a drag source?
true by default for every
reorderable. A target-only slot — the drop zone at the end of a Kanban column —
returns false: a card can be dropped there, not lifted from it (otherwise the
drag would raise an empty ghost that moves nothing).Source§fn reorder_droppable(&self) -> bool
fn reorder_droppable(&self) -> bool
Can this reorderable be dropped onto?
true by default, and the mirror image of
reorder_draggable: a source-only grip — a list row’s
drag handle — returns false. Read moreSource§fn reorder_announcement(&self, _to: usize) -> Option<String>
fn reorder_announcement(&self, _to: usize) -> Option<String>
What to say to a screen reader once this reorderable has been moved to
to — the
spoken counterpart of the ghost, for someone who cannot see it land. Read moreSource§fn announce(&self) -> Option<String>
fn announce(&self) -> Option<String>
Text to announce to the screen reader when this widget is activated (mouse
click or Enter/Space) — a live region reads it out loud. Describes the effect the
activation produced (“Sorted by Name ascending”, “All rows selected”), for the
blind user who cannot perceive the visual change.
None = nothing to announce
(the default).Source§fn stack(&self) -> bool
fn stack(&self) -> bool
If
true, the widget is a stack: its children are superimposed layers
(the same box), rendered in order (the last one on top).Source§fn continuous(&self) -> bool
fn continuous(&self) -> bool
If
true, the widget animates continuously (driven by time, not by a
target): the framework keeps redrawing. E.g. CircularProgressIndicator.Source§fn repaint_boundary(&self) -> bool
fn repaint_boundary(&self) -> bool
If
true, this widget is a repaint boundary: its subtree is cached
(primitives + interaction maps) and reused as is as long as its geometry
and the interaction state of its descendants do not change — a widget
animating elsewhere no longer forces it to repaint.
See crate::Container::repaint_boundary and paintcache.rs.Source§fn scroll_content(&self) -> Option<&dyn Widget<Msg>>
fn scroll_content(&self) -> Option<&dyn Widget<Msg>>
If the widget is a scrollable container, returns its content.
Source§fn virtual_list(&self, _viewport: Size) -> Option<VirtualList<'_, Msg>>
fn virtual_list(&self, _viewport: Size) -> Option<VirtualList<'_, Msg>>
If the widget is a virtualised list, returns its description (item count,
height, factory). Only the visible items are built.
Source§fn page_view(&self) -> Option<PagedView<'_, Msg>>
fn page_view(&self) -> Option<PagedView<'_, Msg>>
If the widget is a paged view, returns its description (page count,
axis, factory). Like a virtualised list, only the visible pages are built.
Source§fn on_page_changed(&self, _page: usize) -> Option<Msg>
fn on_page_changed(&self, _page: usize) -> Option<Msg>
Message sent by a paged view when the page on screen changes.
Source§fn on_scroll(&self, _position: ScrollPosition) -> Option<Msg>
fn on_scroll(&self, _position: ScrollPosition) -> Option<Msg>
Message sent by a scroll region when its offset changes — the reading half
of
crate::ScrollPosition. Read moreSource§fn scroll_grain(&self) -> f32
fn scroll_grain(&self) -> f32
How far this region must move before it says so again, in pixels;
0 — the
default — reports every change. Read moreSource§fn intrinsic(&self) -> Option<(IntrinsicAxis, Option<f32>)>
fn intrinsic(&self) -> Option<(IntrinsicAxis, Option<f32>)>
If the widget takes one axis from its content’s preferred size, returns
that axis and the step its measurement is rounded up to. See
crate::Intrinsic.Source§fn overflow_box(&self) -> Option<Overflow>
fn overflow_box(&self) -> Option<Overflow>
If the widget lays its child out to constraints of its own, which the
child may exceed, returns them. See
crate::OverflowBox.Source§fn constraints_transform(&self) -> Option<ConstraintsTransform>
fn constraints_transform(&self) -> Option<ConstraintsTransform>
The box this widget gives its child as a function of the box it was offered,
with the child laid out in it separately and the box then sized to what came
back.
None — the default — means the child shares this node’s layout, as
everything ordinary does. See crate::ConstraintsTransformBox.Source§fn layout_builder(&self) -> Option<&dyn Fn(Size) -> Box<dyn Widget<Msg>>>
fn layout_builder(&self) -> Option<&dyn Fn(Size) -> Box<dyn Widget<Msg>>>
If the widget builds its content from its actual box, returns the
size → widget factory. The content is built on the fly: no retained state
and no overlay (like a virtualised list item).Source§fn scroll_overlay(&self) -> Option<&OverlayBuilder<Msg>>
fn scroll_overlay(&self) -> Option<&OverlayBuilder<Msg>>
If the widget draws something over its scroll region, returns the
offset → overlay factory. See crate::ScrollOverlay. Read moreSource§fn scroll_axis(&self) -> Axis
fn scroll_axis(&self) -> Axis
SingleChildScrollView axis (or axes), for a scrollable container.
Source§fn scroll_physics(&self) -> Option<ScrollPhysics>
fn scroll_physics(&self) -> Option<ScrollPhysics>
The edge and fling behaviour of a scrollable container, when this widget
wants one in particular.
None — the usual answer — leaves the choice to
the application, which defaults to what the platform does.Source§fn scrollbars(&self) -> Option<Scrollbars>
fn scrollbars(&self) -> Option<Scrollbars>
Whether this area draws a scrollbar, when it wants its own answer rather than
the application’s.
None — the default — follows the application, which follows
the platform. See crate::Scrollbars.Source§fn thumb_visibility(&self) -> Option<bool>
fn thumb_visibility(&self) -> Option<bool>
Keep this area’s scrollbar on screen, instead of letting it fade away when
the area stops moving (
scrollbar.dart:214). Read moreSource§fn ime(&self) -> Ime
fn ime(&self) -> Ime
What the software keyboard should be, when this widget is the focused
editable one. Read more
Source§fn overlay(&self) -> Option<(&dyn Widget<Msg>, Placement)>
fn overlay(&self) -> Option<(&dyn Widget<Msg>, Placement)>
If the widget is a portal, returns its floating content and its placement.
Source§fn overlay_dismiss(&self) -> Option<Msg>
fn overlay_dismiss(&self) -> Option<Msg>
Message emitted when the scrim of a modal is clicked (dismissal), if any.
Source§fn overlay_scrim(&self, _theme: &Theme) -> Option<Color>
fn overlay_scrim(&self, _theme: &Theme) -> Option<Color>
The colour of the scrim behind this widget’s modal overlay, when it wants one
in particular.
None — the usual answer — leaves it to the scheme’s scrim
role at the framework’s own opacity. Read moreSource§fn overlay_traps_focus(&self) -> bool
fn overlay_traps_focus(&self) -> bool
If
true, this widget’s anchored overlay (a menu…) traps focus: Tab and the
arrow keys cycle within its focusables while it is open (the keyboard pattern of menus).
Modal (scrimmed) overlays already trap by default; a tooltip or an autocomplete list
(focus stays on the field) do not. Default: false.Source§fn anim_target(&self) -> Option<f32>
fn anim_target(&self) -> Option<f32>
Target of the widget’s own animated value (e.g.
1.0 for a switch that is on,
0.0 for off). The runtime drives the retained value towards this target and
hands it back through Status::value. None = no animated value.Source§fn anim_transform(&self) -> Option<TransformValues>
fn anim_transform(&self) -> Option<TransformValues>
Target transform of an animated one (
Transform::animated): the runtime
tweens the scales and the turn through anim_duration/anim_curve and hands the
interpolated value back through Runtime::anim_transform, which the paint walk
reads in place of the static transform_scale/transform_rotate. None = the
transform does not move. Read moreSource§fn anim_duration(&self) -> f32
fn anim_duration(&self) -> f32
Duration (seconds) of the animated value’s transition (
anim_target).
Default: the framework’s standard duration.Source§fn anim_curve(&self) -> Curve
fn anim_curve(&self) -> Curve
Easing curve of the animated value’s transition (
anim_target).
Default: linear.Source§fn opacity_group(&self) -> Option<f32>
fn opacity_group(&self) -> Option<f32>
If the widget is an opacity group, returns the (target) opacity
[0,1]
applied to its whole subtree as one: the paint walk wraps its primitives
in a composited layer at that opacity — no double-blending where they
overlap. None = not a group. Combined with anim_target, the opacity
animates (a group fade).Source§fn anim_color(&self) -> Option<Color>
fn anim_color(&self) -> Option<Color>
Target background colour of an animated background
(
Container::animated_color): the runtime tweens it (through
anim_duration/anim_curve) and hands the interpolated value back in
Status::anim_color. None = no animated colour.Source§fn anim_size(&self) -> Option<Size>
fn anim_size(&self) -> Option<Size>
Target size of an animated size (
Container::animated_size): the runtime
tweens it (through anim_duration/anim_curve) and the interpolated size is
injected at layout (see effective_style). None = fixed size.Source§fn anim_radius(&self) -> Option<BorderRadius>
fn anim_radius(&self) -> Option<BorderRadius>
Target corner radius of an animated radius (
Container::animated_radius):
the runtime tweens it and hands the interpolated value back in
Status::anim_radius. None = fixed radius.Source§fn anim_padding(&self) -> Option<Insets>
fn anim_padding(&self) -> Option<Insets>
Target padding of an animated padding (
Container::animated_padding):
the runtime tweens it and the interpolated padding is injected at layout
(see effective_style). None = fixed padding.Source§fn anim_offset(&self) -> Option<(f32, f32)>
fn anim_offset(&self) -> Option<(f32, f32)>
The pair of fractions this node’s offset rule is made of, animated: an
alignment’s two fractions, or a slide’s.
None — the default — leaves the rule
reading the widget’s own numbers. Read moreSource§fn anim_pins(&self) -> Option<Positioning>
fn anim_pins(&self) -> Option<Positioning>
Target pins of an animated stack layer (
crate::AnimatedPositioned): the
runtime tweens them and the interpolated pins are read where the stack lays its
layers out. None — the default — leaves Widget::positioned alone. Read moreSource§fn anim_fractions(&self) -> Option<(Option<f32>, Option<f32>)>
fn anim_fractions(&self) -> Option<(Option<f32>, Option<f32>)>
Target fractions of an animated share of the parent
(
FractionallySizedBox::animated), as (width factor, height factor): the
runtime tweens them and the interpolated pair is injected at layout (see
effective_style), like the size and the padding. None = fixed factors. Read moreSource§fn anim_text_style(&self) -> Option<TextStyle>
fn anim_text_style(&self) -> Option<TextStyle>
Target text style an animated subtree is heading for
(
AnimatedDefaultTextStyle). None = the subtree inherits whatever it inherits. Read moreSource§fn alignment_geometry(&self) -> Option<AlignmentGeometry>
fn alignment_geometry(&self) -> Option<AlignmentGeometry>
Alignment of the single child within the box: the walk offsets the child
through the free space according to the alignment’s fractions, resolved
against the reading direction (physical or directional — see
frus_core::AlignmentGeometry). Being continuous, a Tween<Alignment>
read in view() slides the child. None = default flex placement.Source§fn transform_translate(&self) -> Option<(f32, f32)>
fn transform_translate(&self) -> Option<(f32, f32)>
Paint offset
(dx, dy) applied to the widget’s whole subtree: the render
and the hit-test are offset without touching layout (siblings do not move,
the child may overflow its box). Continuous → a Tween read in view() slides
the subtree. None = no offset. See crate::Transform.Source§fn translate_fraction(&self) -> Option<(f32, f32)>
fn translate_fraction(&self) -> Option<(f32, f32)>
Paint offset as a fraction of the child’s own size
(fx, fy): (0.5, 0.0)
slides the subtree half its own width to the right. Added to
Widget::transform_translate, and offsetting the render and the hit-test the
same way, without touching layout. None = no offset. Read moreSource§fn transform_scale(&self) -> Option<(f32, f32, Alignment)>
fn transform_scale(&self) -> Option<(f32, f32, Alignment)>
Paint scaling
(sx, sy, pivot) of the whole subtree: the render and the
hit-test are scaled — per axis — around the pivot (a
frus_core::Alignment within the box), without touching layout. Stays
axis-aligned (a scaled rect is still a rect). None = no scaling.
See crate::Transform.Source§fn transform_rotate(&self) -> Option<(f32, Alignment)>
fn transform_rotate(&self) -> Option<(f32, Alignment)>
Paint rotation
(angle, pivot) of the whole subtree: the subtree is
painted rotated by angle radians (clockwise) around the pivot (a
frus_core::Alignment within the box), without touching layout. The
render goes through a rotated composited layer; the hit-test counter-rotates
the point. None = no rotation. See crate::Transform.Source§fn clip_shape(&self) -> Option<ClipShape>
fn clip_shape(&self) -> Option<ClipShape>
Shape clip of the whole subtree: the paint walk wraps its primitives in a
composited layer whose
frus_core::ClipShape (rounded corners, ellipse)
modulates the alpha — whatever falls outside the shape is erased, edges
antialiased. None = no shape clip. See crate::ClipRRect,
crate::ClipOval.Source§fn style_themed(&self, _theme: &Theme) -> Style
fn style_themed(&self, _theme: &Theme) -> Style
The widget’s style once the theme has had its say — the layout half of the
caller ?? theme ?? framework chain. Read moreSource§fn theme_override(&self, _inherited: &Theme) -> Option<Box<Theme>>
fn theme_override(&self, _inherited: &Theme) -> Option<Box<Theme>>
The theme this widget imposes on itself and its subtree, given the one it
inherits.
None — the default — means “whatever came down from above”, which is
what every widget but crate::Themed answers. Read moreSource§fn media_override(&self, _inherited: MediaQuery) -> Option<MediaQuery>
fn media_override(&self, _inherited: MediaQuery) -> Option<MediaQuery>
The surface this widget imposes on itself and its subtree, given the one it
inherits.
None — the default — means “whatever came down from above”, which is
what every widget but MediaScope answers. Read moreSource§fn scaffold_override(&self) -> Option<ScaffoldInfo>
fn scaffold_override(&self) -> Option<ScaffoldInfo>
Source§fn build_themed(&self, _theme: &Theme)
fn build_themed(&self, _theme: &Theme)
Builds this widget’s subtree from the ambient theme, for the widgets that
defer that decision — see
ThemeBuilder. Does nothing by
default, which is what all but a handful of widgets want. Read moreSource§fn build_in(&self, _id: WidgetId, _runtime: &Runtime, theme: &Theme)
fn build_in(&self, _id: WidgetId, _runtime: &Runtime, theme: &Theme)
Self::build_themed, for the few widgets that also need who they are and
what the frame remembers to compose their subtree. An
AnimatedSwitcher keeps what it is letting go of in the
runtime, under its own identity, and that is reachable nowhere else before its
children are read. Read moreSource§fn expand(&self, _id: WidgetId, _runtime: &Runtime, _theme: &Theme)
fn expand(&self, _id: WidgetId, _runtime: &Runtime, _theme: &Theme)
Builds what this node stands for, before anything else is asked of it. Read more
Source§fn switches(&self) -> bool
fn switches(&self) -> bool
Whether this node is an
AnimatedSwitcher. An identity
is a position, so a switcher and the widget that comes to stand where it stood have
the same one: this is how the runtime tells the switcher still being there from its
having gone, and forgets what it kept for it.Source§fn system_ui_style(&self) -> Option<SystemUiOverlayStyle>
fn system_ui_style(&self) -> Option<SystemUiOverlayStyle>
What the system bars over this widget should look like — see
AnnotatedRegion. None for every widget but that one; a
transparent wrapper forwards it, or a keyed region would say nothing.Source§fn ink(&self, _theme: &Theme) -> Option<InkStyle>
fn ink(&self, _theme: &Theme) -> Option<InkStyle>
If the widget takes ink — the splash a tap leaves on a material surface —
the shape and colour to splash in.
None = no ink, which is the default: a
widget has to ask. Read moreSource§fn foreground(&self, _theme: &Theme) -> Option<BoxDecoration>
fn foreground(&self, _theme: &Theme) -> Option<BoxDecoration>
A decoration painted over this widget’s children rather than behind them:
the reference’s
foregroundDecoration. Read moreSource§fn layer_filter(&self, _cx: FilterContext) -> Option<LayerFilter>
fn layer_filter(&self, _cx: FilterContext) -> Option<LayerFilter>
The pixel effects this widget applies to its whole subtree: a blur, a
colour transform, a mask, or a filter over what is painted underneath. The
paint walk drains the subtree into a composited layer and hands the filter to
the renderer, exactly as it does for an opacity group or a shape clip. Read more
Source§fn backdrop_group(&self) -> bool
fn backdrop_group(&self) -> bool
true when this widget is a backdrop group: the backdrops below it that
ask to be shared are filtered once between them. See crate::BackdropGroup.Source§fn text_baseline(&self, _theme: &Theme) -> Option<f32>
fn text_baseline(&self, _theme: &Theme) -> Option<f32>
The widget’s own text baseline: the distance from the top of its box down
to the line its letters sit on.
None — the default — means this widget has no
text of its own, and whatever is inside it answers instead. Read moreSource§fn ignores_baseline(&self) -> bool
fn ignores_baseline(&self) -> bool
true when this subtree should be left out of a parent’s baseline
alignment: it has a baseline, and the parent is to pretend it does not. An icon
beside a label, where the label is what the row should line up on. See
crate::IgnoreBaseline.Source§fn fill_axes(&self, _theme: &Theme) -> FillAxes
fn fill_axes(&self, _theme: &Theme) -> FillAxes
The axes this widget asks to fill: on each, it takes the room the parent
leaves it rather than shrink-wrapping its children.
FillAxes::NONE means
shrink-wrap on both. Read moreSource§fn main_axis_floor(&self, _theme: &Theme) -> Option<f32>
fn main_axis_floor(&self, _theme: &Theme) -> Option<f32>
The width below which this widget must not be squeezed when its parent runs
horizontally — a line of text that would rather run past the end of a row than
be folded into a column of single words.
None means squeeze freely. Read moreSource§fn tile_shape(&self) -> Option<f32>
fn tile_shape(&self) -> Option<f32>
If this container gives all of its children the shape of a tile, the
width / height ratio to impose on each of them. None = each child keeps
its own shape. Read moreSource§fn positioned(&self) -> Option<Positioning>
fn positioned(&self) -> Option<Positioning>
If this is a layer pinned against its
crate::Stack’s edges
(crate::Positioned), what it pins. None = an ordinary layer, sized and
placed by the stack’s own fit and alignment. Read moreSource§fn stack_loose(&self) -> bool
fn stack_loose(&self) -> bool
Whether this stack sizes its unpinned layers loosely — asking each what it
would like to be — rather than handing each of them the whole box.
See
crate::StackFit. Meaningless unless Widget::stack is true.Source§fn stack_visible(&self) -> Option<usize>
fn stack_visible(&self) -> Option<usize>
Which layer of this stack is shown: the one at that index paints and takes
input, and every other one is laid out and then silenced — not drawn, not
clickable, not read out.
None, the default, shows all of them. Read moreSource§fn keep_visible(&self, _size: Size, _theme: &Theme) -> Option<KeepVisible>
fn keep_visible(&self, _size: Size, _theme: &Theme) -> Option<KeepVisible>
The box this widget asks the scroll region around it to keep in view, in its
own coordinates, with a key naming which box it is. Read more
Source§fn scroll_reverse(&self) -> bool
fn scroll_reverse(&self) -> bool
Whether this scrollable runs from the far end (
crate::SingleChildScrollView::reverse):
the content is anchored to the end of the viewport and offsets are counted from
there. Meaningless unless Widget::scroll_content is Some.Source§fn scroll_padding(&self) -> Insets
fn scroll_padding(&self) -> Insets
The insets a scrollable area puts around its content, inside the viewport. Read more
Source§fn baseline_target(&self) -> Option<f32>
fn baseline_target(&self) -> Option<f32>
If the widget positions its child by the child’s baseline (
crate::Baseline),
the distance from the top of this box at which that baseline should land.
None = not a baseline box.Source§fn clip_path(&self) -> Option<&Path>
fn clip_path(&self) -> Option<&Path>
If the widget clips its child to an arbitrary path (
ClipPath), returns the
path in local coordinates (origin at the box’s top-left corner). The walk
offsets it to the screen and wraps it in a layer whose mask (the path) erases
the outside. Takes priority over Widget::clip_shape. None = no path clip.
See crate::ClipPath.Source§fn dismissible(&self) -> Option<DismissSpec>
fn dismissible(&self) -> Option<DismissSpec>
If the widget is a dismissible item (
crate::Dismissible), its
configuration for this frame. The shell gives a mostly-sideways drag on it to
the dismissal and a mostly-up-and-down one to the enclosing scrollable. None =
not dismissible.Source§fn on_dismissed(&self, _direction: DismissDirection) -> Option<Msg>
fn on_dismissed(&self, _direction: DismissDirection) -> Option<Msg>
The message a dismissed item dispatches, once it has flown out and its gap
has closed.
None = the swipe is shown but removes nothing.Source§fn sheet(&self) -> Option<&SheetSpec>
fn sheet(&self) -> Option<&SheetSpec>
If the widget is the moving panel of a
crate::DraggableScrollableSheet, its
configuration for this frame. The layout makes it as tall as the retained height,
and the shell shares a finger on it between the sheet and the scroll areas inside.
None = not a sheet.Source§fn on_sheet_dismissed(&self) -> Option<Msg>
fn on_sheet_dismissed(&self) -> Option<Msg>
The message a sheet dispatches once it has been lowered to nothing.
None = it
cannot be dismissed, or says nothing when it is.Source§fn refresh(&self) -> Option<RefreshSpec>
fn refresh(&self) -> Option<RefreshSpec>
If the widget is a refresh area (
crate::RefreshIndicator), its configuration for
this frame. Any scrollable inside it routes the movement its physics refuses at
the top edge into the pull, instead of into the overscroll glow. None = not a
refresh area.Source§fn on_refresh(&self) -> Option<Msg>
fn on_refresh(&self) -> Option<Msg>
The message a refresh area dispatches when an armed pull is released.
None =
the pull is shown but asks for nothing, which is what an area still waiting for
its on_refresh looks like.Source§fn barrier(&self) -> Option<ModalBarrier>
fn barrier(&self) -> Option<ModalBarrier>
What the widget withholds from the frame on behalf of its whole subtree:
input targets, primitives, accessibility nodes. The walk visits the subtree
normally and then discards whatever it added to the selected registries, so a
target registered deep inside is caught just as surely as one at the top.
None = nothing withheld (the default). See crate::ModalBarrier,
crate::IgnorePointer, crate::AbsorbPointer, crate::Visibility,
crate::ExcludeSemantics.Source§fn interactive(&self) -> Option<(f32, f32)>
fn interactive(&self) -> Option<(f32, f32)>
If the widget is an interactive viewport (
InteractiveViewer), returns its
scale bounds (min, max). The paint walk renders its child in a transformed
layer (retained scale + translation, clipped to the viewport); the shell routes
drag → pan and wheel/pinch → zoom. None = not an interactive viewport.
See crate::InteractiveViewer.Source§fn fitted(&self) -> Option<BoxFit>
fn fitted(&self) -> Option<BoxFit>
If the widget fits its child to its box (
FittedBox), returns the
frus_core::BoxFit: the walk measures the child at its natural size, scales
it according to the fit and centres it (composited layer, hit-test through
M⁻¹). None = not a fitter. See crate::FittedBox.Source§fn rotated_quarter_turns(&self) -> Option<i32>
fn rotated_quarter_turns(&self) -> Option<i32>
If the widget rotates its child by quarter turns (
RotatedBox), returns
the number of quarters. Unlike Transform, this affects layout: the box
swaps its dimensions for an odd number. None = not a RotatedBox.
See crate::RotatedBox.If the widget is a screen navigator, returns
(progress, push?). Its children
([screen] or [outgoing, incoming]) are rendered full-window with a sliding
transition.How many of a navigator’s first children are kept but not shown: the pages under
the one on show. They are built, so what their components hold survives, and they are
not laid out, drawn or given input.
0, the default, is a navigator that shows every
page it holds.Source§fn on_long_press(&self) -> Option<Msg>
fn on_long_press(&self) -> Option<Msg>
Message emitted by a long press (a press held ~500 ms without movement).
The long press pre-empts the click: the release that follows does not emit
on_click.Source§fn on_key(&self, _key: &Key) -> KeyResponse<Msg>
fn on_key(&self, _key: &Key) -> KeyResponse<Msg>
Key received while bubbling leaf→root: the focused widget gets it first,
then each ancestor as long as the response is
Ignored. (E.g. an OverlayPortal
consumes Escape to close itself.)Source§fn measure(&self, _theme: &Theme) -> Option<MeasureFn<'_>>
fn measure(&self, _theme: &Theme) -> Option<MeasureFn<'_>>
Measure under constraints: for a widget whose size depends on the space
offered (a paragraph that wraps…), returns the closure wired into taffy.
None = size fixed by style(). Contract: must be Some if and only if
Widget::measure_key is. Read moreSource§fn measure_key(&self, _theme: &Theme) -> Option<u64>
fn measure_key(&self, _theme: &Theme) -> Option<u64>
Fingerprint of the content
Widget::measure depends on (text, style…),
mixed into the relayout fingerprint: without it, two different contents with
the same style would be conflated by the cache and would keep a stale
geometry. Contract: Some if and only if measure() is. Read moreAuto Trait Implementations§
impl<Msg = Callback> !RefUnwindSafe for CarouselView<Msg>
impl<Msg = Callback> !Send for CarouselView<Msg>
impl<Msg = Callback> !Sync for CarouselView<Msg>
impl<Msg = Callback> !UnwindSafe for CarouselView<Msg>
impl<Msg> Freeze for CarouselView<Msg>
impl<Msg> Unpin for CarouselView<Msg>
impl<Msg> UnsafeUnpin for CarouselView<Msg>
Blanket Implementations§
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
Mutably borrows from an owned value. Read more