21 lines
No EOL
11 KiB
HTML
21 lines
No EOL
11 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Scrollables let users navigate an endless amount of content with a scrollbar."><title>cosmic::iced::widget::scrollable - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../static.files/storage-68b7e25d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module scrollable</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>iced::<wbr>widget</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">cosmic</a>::<wbr><a href="../../index.html">iced</a>::<wbr><a href="../index.html">widget</a></div><h1>Module <span>scrollable</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Scrollables let users navigate an endless amount of content with a scrollbar.</p>
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>iced::widget::{column, scrollable, space};
|
|
|
|
<span class="kw">enum </span>Message {
|
|
<span class="comment">// ...
|
|
</span>}
|
|
|
|
<span class="kw">fn </span>view(state: <span class="kw-2">&</span>State) -> Element<<span class="lifetime">'_</span>, Message> {
|
|
scrollable(<span class="macro">column!</span>[
|
|
<span class="string">"Scroll me!"</span>,
|
|
space().height(<span class="number">3000</span>),
|
|
<span class="string">"You did it!"</span>,
|
|
]).into()
|
|
}</code></pre></div>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.AbsoluteOffset.html" title="struct cosmic::iced::widget::scrollable::AbsoluteOffset">Absolute<wbr>Offset</a></dt><dd>The amount of absolute offset in each direction of a <a href="../../daemon/program/graphics/core/widget/operation/trait.Scrollable.html" title="trait cosmic::iced::daemon::program::graphics::core::widget::operation::Scrollable"><code>Scrollable</code></a>.</dd><dt><a class="struct" href="struct.AutoScroll.html" title="struct cosmic::iced::widget::scrollable::AutoScroll">Auto<wbr>Scroll</a></dt><dd>The appearance of the autoscroll overlay of a scrollable.</dd><dt><a class="struct" href="struct.Rail.html" title="struct cosmic::iced::widget::scrollable::Rail">Rail</a></dt><dd>The appearance of the scrollbar of a scrollable.</dd><dt><a class="struct" href="struct.RelativeOffset.html" title="struct cosmic::iced::widget::scrollable::RelativeOffset">Relative<wbr>Offset</a></dt><dd>The amount of relative offset in each direction of a <a href="../../daemon/program/graphics/core/widget/operation/trait.Scrollable.html" title="trait cosmic::iced::daemon::program::graphics::core::widget::operation::Scrollable"><code>Scrollable</code></a>.</dd><dt><a class="struct" href="struct.Scrollable.html" title="struct cosmic::iced::widget::scrollable::Scrollable">Scrollable</a></dt><dd>A widget that can vertically display an infinite amount of content with a
|
|
scrollbar.</dd><dt><a class="struct" href="struct.Scrollbar.html" title="struct cosmic::iced::widget::scrollable::Scrollbar">Scrollbar</a></dt><dd>A scrollbar within a <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd><dt><a class="struct" href="struct.Scroller.html" title="struct cosmic::iced::widget::scrollable::Scroller">Scroller</a></dt><dd>The appearance of the scroller of a scrollable.</dd><dt><a class="struct" href="struct.Style.html" title="struct cosmic::iced::widget::scrollable::Style">Style</a></dt><dd>The appearance of a scrollable.</dd><dt><a class="struct" href="struct.Viewport.html" title="struct cosmic::iced::widget::scrollable::Viewport">Viewport</a></dt><dd>The current <a href="struct.Viewport.html" title="struct cosmic::iced::widget::scrollable::Viewport"><code>Viewport</code></a> of the <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Anchor.html" title="enum cosmic::iced::widget::scrollable::Anchor">Anchor</a></dt><dd>The anchor of the scroller of the <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a> relative to its <a href="struct.Viewport.html" title="struct cosmic::iced::widget::scrollable::Viewport"><code>Viewport</code></a>
|
|
on a given axis.</dd><dt><a class="enum" href="enum.Direction.html" title="enum cosmic::iced::widget::scrollable::Direction">Direction</a></dt><dd>The direction of <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd><dt><a class="enum" href="enum.Status.html" title="enum cosmic::iced::widget::scrollable::Status">Status</a></dt><dd>The possible status of a <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Catalog.html" title="trait cosmic::iced::widget::scrollable::Catalog">Catalog</a></dt><dd>The theme catalog of a <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.default.html" title="fn cosmic::iced::widget::scrollable::default">default</a></dt><dd>The default style of a <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd><dt><a class="fn" href="fn.scroll_by.html" title="fn cosmic::iced::widget::scrollable::scroll_by">scroll_<wbr>by</a></dt><dd>Produces a <a href="../../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that scrolls the <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a> with the given <a href="../../../widget/struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>
|
|
by the provided <a href="struct.AbsoluteOffset.html" title="struct cosmic::iced::widget::scrollable::AbsoluteOffset"><code>AbsoluteOffset</code></a>.</dd><dt><a class="fn" href="fn.scroll_to.html" title="fn cosmic::iced::widget::scrollable::scroll_to">scroll_<wbr>to</a></dt><dd>Produces a <a href="../../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that scrolls the <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a> with the given <a href="../../../widget/struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>
|
|
to the provided <a href="struct.AbsoluteOffset.html" title="struct cosmic::iced::widget::scrollable::AbsoluteOffset"><code>AbsoluteOffset</code></a>.</dd><dt><a class="fn" href="fn.snap_to.html" title="fn cosmic::iced::widget::scrollable::snap_to">snap_to</a></dt><dd>Produces a <a href="../../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that snaps the <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a> with the given <a href="../../../widget/struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>
|
|
to the provided <a href="struct.RelativeOffset.html" title="struct cosmic::iced::widget::scrollable::RelativeOffset"><code>RelativeOffset</code></a>.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.StyleFn.html" title="type cosmic::iced::widget::scrollable::StyleFn">StyleFn</a></dt><dd>A styling function for a <a href="../struct.Scrollable.html" title="struct cosmic::iced::widget::Scrollable"><code>Scrollable</code></a>.</dd></dl></section></div></main></body></html> |