45 lines
No EOL
35 KiB
HTML
45 lines
No EOL
35 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="The COSMIC widget library"><title>cosmic::widget - 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 widget</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#overview" title="Overview">Overview</a></li></ul><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</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 class="in-crate"><a href="../index.html">In crate cosmic</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></div><h1>Module <span>widget</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/cosmic/widget/mod.rs.html#4-352">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The COSMIC widget library</p>
|
|
<p>This module contains a wide variety of widgets used throughout the COSMIC app ecosystem.</p>
|
|
<h2 id="overview"><a class="doc-anchor" href="#overview">§</a>Overview</h2>
|
|
<p>Add widgets to your application view by calling the modules and functions below.
|
|
Widgets are constructed by chaining their property methods using a functional paradigm.
|
|
Modules may contain additional functions for constructing different variations of a widget.
|
|
Each module will typically have one widget with the same name as the module, which will be re-exported here.</p>
|
|
|
|
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>cosmic::prelude::<span class="kw-2">*</span>;
|
|
<span class="kw">use </span>cosmic::{cosmic_theme, theme, widget};
|
|
|
|
<span class="kw">const </span>REPOSITORY: <span class="kw-2">&</span>str = <span class="string">"https://github.com/pop-os/libcosmic"</span>;
|
|
|
|
<span class="kw">let </span>cosmic_theme::Spacing { space_xxs, .. } = theme::spacing();
|
|
|
|
<span class="kw">let </span>link = widget::button::link(REPOSITORY)
|
|
.on_press(Message::LaunchUrl(REPOSITORY))
|
|
.padding(<span class="number">0</span>);
|
|
|
|
<span class="kw">let </span>content = widget::column::with_capacity(<span class="number">3</span>)
|
|
.push(widget::icon::from_name(<span class="string">"my-app-icon"</span>))
|
|
.push(widget::text::title3(<span class="string">"My App Name"</span>))
|
|
.push(link)
|
|
.align_items(Alignment::Center)
|
|
.spacing(space_xxs);</code></pre></div>
|
|
<p>Widgets may borrow data from your application struct, and should do so to avoid allocating.</p>
|
|
|
|
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>text = widget::text::body(<span class="kw-2">&</span><span class="self">self</span>.cached_text);</code></pre></div>
|
|
<p>Use the <a href="../trait.Apply.html" title="trait cosmic::Apply"><code>cosmic::Apply</code></a> trait to embed widgets into other widgets which accept them.</p>
|
|
|
|
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>button = widget::icon::from_name(<span class="string">"printer-symbolic"</span>)
|
|
.apply(widget::button::icon)
|
|
.on_press(Message::Print);</code></pre></div>
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="aspect_ratio/index.html" title="mod cosmic::widget::aspect_ratio">aspect_<wbr>ratio</a></dt><dd>A container which constraints itself to a specific aspect ratio.</dd><dt><a class="mod" href="autosize/index.html" title="mod cosmic::widget::autosize">autosize</a><wbr><span class="stab portability" title="Available on crate feature `autosize` only"><code>autosize</code></span></dt><dd>Autosize Container, which will resize the window to its contents.</dd><dt><a class="mod" href="button/index.html" title="mod cosmic::widget::button">button</a></dt><dd>Button widgets for COSMIC applications.</dd><dt><a class="mod" href="calendar/index.html" title="mod cosmic::widget::calendar">calendar</a></dt><dd>A widget that displays an interactive calendar.</dd><dt><a class="mod" href="canvas/index.html" title="mod cosmic::widget::canvas">canvas</a></dt><dd>Canvases can be leveraged to draw interactive 2D graphics.</dd><dt><a class="mod" href="card/index.html" title="mod cosmic::widget::card">card</a></dt><dt><a class="mod" href="checkbox/index.html" title="mod cosmic::widget::checkbox">checkbox</a></dt><dd>Checkboxes can be used to let users make binary choices.</dd><dt><a class="mod" href="circular/index.html" title="mod cosmic::widget::circular">circular</a></dt><dd>Show a circular progress indicator.</dd><dt><a class="mod" href="color_picker/index.html" title="mod cosmic::widget::color_picker">color_<wbr>picker</a></dt><dd>Widgets for selecting colors with a color picker.</dd><dt><a class="mod" href="column/index.html" title="mod cosmic::widget::column">column</a></dt><dd>Distribute content vertically.</dd><dt><a class="mod" href="combo_box/index.html" title="mod cosmic::widget::combo_box">combo_<wbr>box</a></dt><dd>Combo boxes display a dropdown list of searchable and selectable options.</dd><dt><a class="mod" href="container/index.html" title="mod cosmic::widget::container">container</a></dt><dd>Containers let you align a widget inside their boundaries.</dd><dt><a class="mod" href="context_drawer/index.html" title="mod cosmic::widget::context_drawer">context_<wbr>drawer</a></dt><dd>An overlayed widget that attaches a toggleable context drawer to the view.</dd><dt><a class="mod" href="context_menu/index.html" title="mod cosmic::widget::context_menu">context_<wbr>menu</a></dt><dd>A context menu is a menu in a graphical user interface that appears upon user interaction, such as a right-click mouse operation.</dd><dt><a class="mod" href="dialog/index.html" title="mod cosmic::widget::dialog">dialog</a></dt><dt><a class="mod" href="divider/index.html" title="mod cosmic::widget::divider">divider</a></dt><dd>An element to distinguish a boundary between two elements.</dd><dt><a class="mod" href="dnd_destination/index.html" title="mod cosmic::widget::dnd_destination">dnd_<wbr>destination</a></dt><dt><a class="mod" href="dnd_source/index.html" title="mod cosmic::widget::dnd_source">dnd_<wbr>source</a></dt><dt><a class="mod" href="dropdown/index.html" title="mod cosmic::widget::dropdown">dropdown</a></dt><dd>Displays a list of options in a popover menu on select.</dd><dt><a class="mod" href="flex_row/index.html" title="mod cosmic::widget::flex_row">flex_<wbr>row</a></dt><dd>Responsively generates rows of widgets based on the dimensions of its children.</dd><dt><a class="mod" href="grid/index.html" title="mod cosmic::widget::grid">grid</a></dt><dd>Arrange widgets with a grid layout.</dd><dt><a class="mod" href="icon/index.html" title="mod cosmic::widget::icon">icon</a></dt><dd>Lazily-generated SVG icon widget for Iced.</dd><dt><a class="mod" href="id_container/index.html" title="mod cosmic::widget::id_container">id_<wbr>container</a></dt><dt><a class="mod" href="image/index.html" title="mod cosmic::widget::image">image</a></dt><dd>Images display raster graphics in different formats (PNG, JPG, etc.).</dd><dt><a class="mod" href="layer_container/index.html" title="mod cosmic::widget::layer_container">layer_<wbr>container</a></dt><dt><a class="mod" href="linear/index.html" title="mod cosmic::widget::linear">linear</a></dt><dd>Show a linear progress indicator.</dd><dt><a class="mod" href="list/index.html" title="mod cosmic::widget::list">list</a></dt><dt><a class="mod" href="list_column/index.html" title="mod cosmic::widget::list_column">list_<wbr>column</a></dt><dt><a class="mod" href="menu/index.html" title="mod cosmic::widget::menu">menu</a></dt><dd>A <a href="menu/struct.MenuBar.html" title="struct cosmic::widget::menu::MenuBar"><code>MenuBar</code></a> widget for displaying [<code>MenuTree</code>]s</dd><dt><a class="mod" href="nav_bar/index.html" title="mod cosmic::widget::nav_bar">nav_bar</a></dt><dd>Navigation side panel for switching between views.</dd><dt><a class="mod" href="nav_bar_toggle/index.html" title="mod cosmic::widget::nav_bar_toggle">nav_<wbr>bar_<wbr>toggle</a></dt><dd>A button for toggling the navigation side panel.</dd><dt><a class="mod" href="pane_grid/index.html" title="mod cosmic::widget::pane_grid">pane_<wbr>grid</a></dt><dd>Pane grids let your users split regions of your application and organize layout dynamically.</dd><dt><a class="mod" href="popover/index.html" title="mod cosmic::widget::popover">popover</a></dt><dd>A container which displays an overlay when a popup widget is attached.</dd><dt><a class="mod" href="progress_bar/index.html" title="mod cosmic::widget::progress_bar">progress_<wbr>bar</a></dt><dt><a class="mod" href="radio/index.html" title="mod cosmic::widget::radio">radio</a></dt><dd>Create choices using radio buttons.</dd><dt><a class="mod" href="rectangle_tracker/index.html" title="mod cosmic::widget::rectangle_tracker">rectangle_<wbr>tracker</a></dt><dt><a class="mod" href="row/index.html" title="mod cosmic::widget::row">row</a></dt><dd>Distribute content horizontally.</dd><dt><a class="mod" href="scrollable/index.html" title="mod cosmic::widget::scrollable">scrollable</a></dt><dt><a class="mod" href="segmented_button/index.html" title="mod cosmic::widget::segmented_button">segmented_<wbr>button</a></dt><dd>A widget providing a conjoined set of linear items that function in conjunction as a single button.</dd><dt><a class="mod" href="segmented_control/index.html" title="mod cosmic::widget::segmented_control">segmented_<wbr>control</a></dt><dd>A selection of multiple choices appearing as a conjoined button.</dd><dt><a class="mod" href="settings/index.html" title="mod cosmic::widget::settings">settings</a></dt><dt><a class="mod" href="slider/index.html" title="mod cosmic::widget::slider">slider</a></dt><dd>Sliders let users set a value by moving an indicator.</dd><dt><a class="mod" href="space/index.html" title="mod cosmic::widget::space">space</a></dt><dd>Add some explicit spacing between elements.</dd><dt><a class="mod" href="spin_button/index.html" title="mod cosmic::widget::spin_button">spin_<wbr>button</a></dt><dd>A control for incremental adjustments of a value.</dd><dt><a class="mod" href="style/index.html" title="mod cosmic::widget::style">style</a></dt><dt><a class="mod" href="svg/index.html" title="mod cosmic::widget::svg">svg</a></dt><dd>Svg widgets display vector graphics in your application.</dd><dt><a class="mod" href="tab_bar/index.html" title="mod cosmic::widget::tab_bar">tab_bar</a></dt><dd>A collection of tabs for developing a tabbed interface.</dd><dt><a class="mod" href="table/index.html" title="mod cosmic::widget::table">table</a></dt><dd>A widget allowing the user to display tables of information with optional sorting by category</dd><dt><a class="mod" href="text/index.html" title="mod cosmic::widget::text">text</a></dt><dt><a class="mod" href="text_editor/index.html" title="mod cosmic::widget::text_editor">text_<wbr>editor</a></dt><dd>Text editors display a multi-line text input for text editing.</dd><dt><a class="mod" href="text_input/index.html" title="mod cosmic::widget::text_input">text_<wbr>input</a></dt><dd>A text input widget from iced widgets plus some added details.</dd><dt><a class="mod" href="toaster/index.html" title="mod cosmic::widget::toaster">toaster</a></dt><dd>A widget that displays toasts.</dd><dt><a class="mod" href="tooltip/index.html" title="mod cosmic::widget::tooltip">tooltip</a></dt><dt><a class="mod" href="vertical_slider/index.html" title="mod cosmic::widget::vertical_slider">vertical_<wbr>slider</a></dt><dd>Sliders let users set a value by moving an indicator.</dd><dt><a class="mod" href="warning/index.html" title="mod cosmic::widget::warning">warning</a></dt><dt><a class="mod" href="wayland/index.html" title="mod cosmic::widget::wayland">wayland</a><wbr><span class="stab portability" title="Available on crate feature `wayland` and Linux and crate feature `winit` only"><code>wayland</code> and Linux and <code>winit</code></span></dt><dt><a class="mod" href="wrapper/index.html" title="mod cosmic::widget::wrapper">wrapper</a></dt></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.column.html" title="macro cosmic::widget::column">column</a></dt><dd>Creates a <a href="struct.Column.html" title="struct cosmic::widget::Column"><code>Column</code></a> with the given children.</dd><dt><a class="macro" href="macro.row.html" title="macro cosmic::widget::row">row</a></dt><dd>Creates a <a href="struct.Row.html" title="struct cosmic::widget::Row"><code>Row</code></a> with the given children.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Button.html" title="struct cosmic::widget::Button">Button</a></dt><dd>A generic button which emits a message when pressed.</dd><dt><a class="struct" href="struct.Calendar.html" title="struct cosmic::widget::Calendar">Calendar</a></dt><dt><a class="struct" href="struct.Canvas.html" title="struct cosmic::widget::Canvas">Canvas</a></dt><dd>A widget capable of drawing 2D graphics.</dd><dt><a class="struct" href="struct.Checkbox.html" title="struct cosmic::widget::Checkbox">Checkbox</a></dt><dd>A box that can be checked.</dd><dt><a class="struct" href="struct.Circular.html" title="struct cosmic::widget::Circular">Circular</a></dt><dt><a class="struct" href="struct.ColorPicker.html" title="struct cosmic::widget::ColorPicker">Color<wbr>Picker</a></dt><dt><a class="struct" href="struct.ColorPickerModel.html" title="struct cosmic::widget::ColorPickerModel">Color<wbr>Picker<wbr>Model</a></dt><dt><a class="struct" href="struct.Column.html" title="struct cosmic::widget::Column">Column</a></dt><dd>A container that distributes its contents vertically.</dd><dt><a class="struct" href="struct.ComboBox.html" title="struct cosmic::widget::ComboBox">Combo<wbr>Box</a></dt><dd>A widget for searching and selecting a single value from a list of options.</dd><dt><a class="struct" href="struct.Container.html" title="struct cosmic::widget::Container">Container</a></dt><dd>A widget that aligns its contents inside of its boundaries.</dd><dt><a class="struct" href="struct.ContextDrawer.html" title="struct cosmic::widget::ContextDrawer">Context<wbr>Drawer</a></dt><dt><a class="struct" href="struct.ContextMenu.html" title="struct cosmic::widget::ContextMenu">Context<wbr>Menu</a></dt><dd>A context menu is a menu in a graphical user interface that appears upon user interaction, such as a right-click mouse operation.</dd><dt><a class="struct" href="struct.Dialog.html" title="struct cosmic::widget::Dialog">Dialog</a></dt><dt><a class="struct" href="struct.DndDestination.html" title="struct cosmic::widget::DndDestination">DndDestination</a></dt><dt><a class="struct" href="struct.DndSource.html" title="struct cosmic::widget::DndSource">DndSource</a></dt><dt><a class="struct" href="struct.Dropdown.html" title="struct cosmic::widget::Dropdown">Dropdown</a></dt><dd>A widget for selecting a single value from a list of selections.</dd><dt><a class="struct" href="struct.FlexRow.html" title="struct cosmic::widget::FlexRow">FlexRow</a></dt><dd>Responsively generates rows and columns of widgets based on its dimensions.</dd><dt><a class="struct" href="struct.Grid.html" title="struct cosmic::widget::Grid">Grid</a></dt><dd>Responsively generates rows and columns of widgets based on its dimmensions.</dd><dt><a class="struct" href="struct.HeaderBar.html" title="struct cosmic::widget::HeaderBar">Header<wbr>Bar</a></dt><dt><a class="struct" href="struct.Icon.html" title="struct cosmic::widget::Icon">Icon</a></dt><dd>An image which may be an SVG or PNG.</dd><dt><a class="struct" href="struct.Id.html" title="struct cosmic::widget::Id">Id</a></dt><dd>The identifier of a generic widget.</dd><dt><a class="struct" href="struct.IdContainer.html" title="struct cosmic::widget::IdContainer">IdContainer</a></dt><dd>An element decorating some content.</dd><dt><a class="struct" href="struct.Image.html" title="struct cosmic::widget::Image">Image</a></dt><dd>A frame that displays an image while keeping aspect ratio.</dd><dt><a class="struct" href="struct.LayerContainer.html" title="struct cosmic::widget::LayerContainer">Layer<wbr>Container</a></dt><dd>An element decorating some content.</dd><dt><a class="struct" href="struct.Lazy.html" title="struct cosmic::widget::Lazy">Lazy</a></dt><dd>A widget that only rebuilds its contents when necessary.</dd><dt><a class="struct" href="struct.Linear.html" title="struct cosmic::widget::Linear">Linear</a></dt><dt><a class="struct" href="struct.ListColumn.html" title="struct cosmic::widget::ListColumn">List<wbr>Column</a></dt><dt><a class="struct" href="struct.MouseArea.html" title="struct cosmic::widget::MouseArea">Mouse<wbr>Area</a></dt><dd>Emit messages on mouse events.</dd><dt><a class="struct" href="struct.NavBarToggle.html" title="struct cosmic::widget::NavBarToggle">NavBar<wbr>Toggle</a></dt><dt><a class="struct" href="struct.PaneGrid.html" title="struct cosmic::widget::PaneGrid">Pane<wbr>Grid</a></dt><dd>A collection of panes distributed using either vertical or horizontal splits
|
|
to completely fill the space available.</dd><dt><a class="struct" href="struct.Popover.html" title="struct cosmic::widget::Popover">Popover</a></dt><dd>A container which displays overlays when a popup widget is assigned.</dd><dt><a class="struct" href="struct.Radio.html" title="struct cosmic::widget::Radio">Radio</a></dt><dd>A circular button representing a choice.</dd><dt><a class="struct" href="struct.RcElementWrapper.html" title="struct cosmic::widget::RcElementWrapper">RcElement<wbr>Wrapper</a></dt><dt><a class="struct" href="struct.RcWrapper.html" title="struct cosmic::widget::RcWrapper">RcWrapper</a></dt><dt><a class="struct" href="struct.RectangleTracker.html" title="struct cosmic::widget::RectangleTracker">Rectangle<wbr>Tracker</a></dt><dt><a class="struct" href="struct.Responsive.html" title="struct cosmic::widget::Responsive">Responsive</a></dt><dd>A widget that is aware of its dimensions.</dd><dt><a class="struct" href="struct.ResponsiveMenuBar.html" title="struct cosmic::widget::ResponsiveMenuBar">Responsive<wbr>Menu<wbr>Bar</a><wbr><span class="stab portability" title="Available on crate feature `surface-message` only"><code>surface-message</code></span></dt><dt><a class="struct" href="struct.Row.html" title="struct cosmic::widget::Row">Row</a></dt><dd>A container that distributes its contents horizontally.</dd><dt><a class="struct" href="struct.Slider.html" title="struct cosmic::widget::Slider">Slider</a></dt><dd>An horizontal bar and a handle that selects a single value from a range of
|
|
values.</dd><dt><a class="struct" href="struct.Space.html" title="struct cosmic::widget::Space">Space</a></dt><dd>An amount of empty space.</dd><dt><a class="struct" href="struct.SpinButton.html" title="struct cosmic::widget::SpinButton">Spin<wbr>Button</a></dt><dt><a class="struct" href="struct.Svg.html" title="struct cosmic::widget::Svg">Svg</a></dt><dd>A vector graphics image.</dd><dt><a class="struct" href="struct.TextEditor.html" title="struct cosmic::widget::TextEditor">Text<wbr>Editor</a></dt><dd>A multi-line text input.</dd><dt><a class="struct" href="struct.TextInput.html" title="struct cosmic::widget::TextInput">Text<wbr>Input</a></dt><dd>A field that can be filled with text.</dd><dt><a class="struct" href="struct.Toast.html" title="struct cosmic::widget::Toast">Toast</a></dt><dd>Represent the data used to display a <a href="struct.Toast.html" title="struct cosmic::widget::Toast"><code>Toast</code></a></dd><dt><a class="struct" href="struct.ToastId.html" title="struct cosmic::widget::ToastId">ToastId</a></dt><dt><a class="struct" href="struct.Toasts.html" title="struct cosmic::widget::Toasts">Toasts</a></dt><dt><a class="struct" href="struct.Toggler.html" title="struct cosmic::widget::Toggler">Toggler</a></dt><dd>A toggler widget.</dd><dt><a class="struct" href="struct.VerticalSlider.html" title="struct cosmic::widget::VerticalSlider">Vertical<wbr>Slider</a></dt><dd>An vertical bar and a handle that selects a single value from a range of
|
|
values.</dd><dt><a class="struct" href="struct.Warning.html" title="struct cosmic::widget::Warning">Warning</a></dt></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.Operation.html" title="trait cosmic::widget::Operation">Operation</a></dt><dd>A piece of logic that can traverse the widget tree of an application in
|
|
order to query or update some widget state.</dd><dt><a class="trait" href="trait.Widget.html" title="trait cosmic::widget::Widget">Widget</a></dt><dd>A component that displays information and allows interaction.</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.calendar.html" title="fn cosmic::widget::calendar">calendar</a></dt><dd>A widget that displays an interactive calendar.</dd><dt><a class="fn" href="fn.canvas.html" title="fn cosmic::widget::canvas">canvas</a></dt><dd>Creates a new <a href="struct.Canvas.html" title="struct cosmic::widget::Canvas"><code>Canvas</code></a>.</dd><dt><a class="fn" href="fn.cards.html" title="fn cosmic::widget::cards">cards</a></dt><dd>get an expandable stack of cards</dd><dt><a class="fn" href="fn.checkbox.html" title="fn cosmic::widget::checkbox">checkbox</a></dt><dd>Creates a new <a href="struct.Checkbox.html" title="struct cosmic::widget::Checkbox"><code>Checkbox</code></a>.</dd><dt><a class="fn" href="fn.column.html" title="fn cosmic::widget::column">column</a></dt><dd>Creates a new <a href="struct.Column.html" title="struct cosmic::widget::Column"><code>Column</code></a> with the given children.</dd><dt><a class="fn" href="fn.combo_box.html" title="fn cosmic::widget::combo_box">combo_<wbr>box</a></dt><dd>Creates a new <a href="struct.ComboBox.html" title="struct cosmic::widget::ComboBox"><code>ComboBox</code></a>.</dd><dt><a class="fn" href="fn.compact_table.html" title="fn cosmic::widget::compact_table">compact_<wbr>table</a></dt><dt><a class="fn" href="fn.container.html" title="fn cosmic::widget::container">container</a></dt><dd>Creates a new <a href="struct.Container.html" title="struct cosmic::widget::Container"><code>Container</code></a> with the provided content.</dd><dt><a class="fn" href="fn.context_drawer.html" title="fn cosmic::widget::context_drawer">context_<wbr>drawer</a></dt><dd>An overlayed widget that attaches a toggleable context drawer to the view.</dd><dt><a class="fn" href="fn.context_menu.html" title="fn cosmic::widget::context_menu">context_<wbr>menu</a></dt><dd>A context menu is a menu in a graphical user interface that appears upon user interaction, such as a right-click mouse operation.</dd><dt><a class="fn" href="fn.determinate_circular.html" title="fn cosmic::widget::determinate_circular">determinate_<wbr>circular</a></dt><dd>A circular progress spinner widget that can be used to indicate the progress of some operation.</dd><dt><a class="fn" href="fn.determinate_linear.html" title="fn cosmic::widget::determinate_linear">determinate_<wbr>linear</a></dt><dd>A linear progress bar widget that can be used to indicate the progress of some operation.</dd><dt><a class="fn" href="fn.dialog.html" title="fn cosmic::widget::dialog">dialog</a></dt><dt><a class="fn" href="fn.dnd_destination.html" title="fn cosmic::widget::dnd_destination">dnd_<wbr>destination</a></dt><dt><a class="fn" href="fn.dnd_source.html" title="fn cosmic::widget::dnd_source">dnd_<wbr>source</a></dt><dt><a class="fn" href="fn.dropdown.html" title="fn cosmic::widget::dropdown">dropdown</a></dt><dd>Displays a list of options in a popover menu on select.</dd><dt><a class="fn" href="fn.editable_input.html" title="fn cosmic::widget::editable_input">editable_<wbr>input</a></dt><dd>A text label which can transform into a text input on activation.</dd><dt><a class="fn" href="fn.flex_row.html" title="fn cosmic::widget::flex_row">flex_<wbr>row</a></dt><dd>Responsively generates rows of widgets based on the dimensions of its children.</dd><dt><a class="fn" href="fn.grid.html" title="fn cosmic::widget::grid">grid</a></dt><dd>Arrange widgets with a grid layout.</dd><dt><a class="fn" href="fn.header_bar.html" title="fn cosmic::widget::header_bar">header_<wbr>bar</a></dt><dt><a class="fn" href="fn.icon.html" title="fn cosmic::widget::icon">icon</a></dt><dd>Create an <a href="struct.Icon.html" title="struct cosmic::widget::Icon"><code>Icon</code></a> from a pre-existing <a href="icon/struct.Handle.html" title="struct cosmic::widget::icon::Handle"><code>Handle</code></a></dd><dt><a class="fn" href="fn.id_container.html" title="fn cosmic::widget::id_container">id_<wbr>container</a></dt><dt><a class="fn" href="fn.image.html" title="fn cosmic::widget::image">image</a></dt><dd>Creates a new <a href="struct.Image.html" title="struct cosmic::widget::Image"><code>Image</code></a>.</dd><dt><a class="fn" href="fn.indeterminate_circular.html" title="fn cosmic::widget::indeterminate_circular">indeterminate_<wbr>circular</a></dt><dd>A spinner / throbber widget that can be used to indicate that some operation is in progress.</dd><dt><a class="fn" href="fn.indeterminate_linear.html" title="fn cosmic::widget::indeterminate_linear">indeterminate_<wbr>linear</a></dt><dd>A linear throbber widget that can be used to indicate that some operation is in progress.</dd><dt><a class="fn" href="fn.inline_input.html" title="fn cosmic::widget::inline_input">inline_<wbr>input</a></dt><dd>Creates a new inline <a href="widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="fn" href="fn.layer_container.html" title="fn cosmic::widget::layer_container">layer_<wbr>container</a></dt><dt><a class="fn" href="fn.lazy.html" title="fn cosmic::widget::lazy">lazy</a></dt><dd>Creates a new <a href="struct.Lazy.html" title="struct cosmic::widget::Lazy"><code>Lazy</code></a> widget with the given data <code>Dependency</code> and a
|
|
closure that can turn this data into a widget tree.</dd><dt><a class="fn" href="fn.list_column.html" title="fn cosmic::widget::list_column">list_<wbr>column</a></dt><dt><a class="fn" href="fn.mouse_area.html" title="fn cosmic::widget::mouse_area">mouse_<wbr>area</a></dt><dd>Creates a new <a href="struct.MouseArea.html" title="struct cosmic::widget::MouseArea"><code>MouseArea</code></a>.</dd><dt><a class="fn" href="fn.nav_bar.html" title="fn cosmic::widget::nav_bar">nav_bar</a></dt><dd>Navigation side panel for switching between views.</dd><dt><a class="fn" href="fn.nav_bar_dnd.html" title="fn cosmic::widget::nav_bar_dnd">nav_<wbr>bar_<wbr>dnd</a></dt><dd>Navigation side panel for switching between views.
|
|
Can receive drag and drop events.</dd><dt><a class="fn" href="fn.nav_bar_toggle.html" title="fn cosmic::widget::nav_bar_toggle">nav_<wbr>bar_<wbr>toggle</a></dt><dt><a class="fn" href="fn.pane_grid.html" title="fn cosmic::widget::pane_grid">pane_<wbr>grid</a></dt><dd>Creates a <a href="struct.PaneGrid.html" title="struct cosmic::widget::PaneGrid"><code>PaneGrid</code></a> with the given <a href="pane_grid/struct.State.html" title="struct cosmic::widget::pane_grid::State"><code>pane_grid::State</code></a> and view function.</dd><dt><a class="fn" href="fn.popover.html" title="fn cosmic::widget::popover">popover</a></dt><dt><a class="fn" href="fn.radio.html" title="fn cosmic::widget::radio">radio</a></dt><dt><a class="fn" href="fn.rectangle_tracking_container.html" title="fn cosmic::widget::rectangle_tracking_container">rectangle_<wbr>tracking_<wbr>container</a></dt><dt><a class="fn" href="fn.responsive.html" title="fn cosmic::widget::responsive">responsive</a></dt><dd>Creates a new <a href="struct.Responsive.html" title="struct cosmic::widget::Responsive"><code>Responsive</code></a> widget with a closure that produces its
|
|
contents.</dd><dt><a class="fn" href="fn.responsive_menu_bar.html" title="fn cosmic::widget::responsive_menu_bar">responsive_<wbr>menu_<wbr>bar</a><wbr><span class="stab portability" title="Available on crate feature `surface-message` only"><code>surface-message</code></span></dt><dt><a class="fn" href="fn.row.html" title="fn cosmic::widget::row">row</a></dt><dd>Creates a new <a href="struct.Row.html" title="struct cosmic::widget::Row"><code>Row</code></a> from an iterator.</dd><dt><a class="fn" href="fn.scrollable.html" title="fn cosmic::widget::scrollable">scrollable</a></dt><dt><a class="fn" href="fn.search_input.html" title="fn cosmic::widget::search_input">search_<wbr>input</a></dt><dd>Creates a new search <a href="widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="fn" href="fn.secure_input.html" title="fn cosmic::widget::secure_input">secure_<wbr>input</a></dt><dd>Creates a new secure <a href="widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="fn" href="fn.slider.html" title="fn cosmic::widget::slider">slider</a></dt><dd>Creates a new <a href="struct.Slider.html" title="struct cosmic::widget::Slider"><code>Slider</code></a>.</dd><dt><a class="fn" href="fn.space.html" title="fn cosmic::widget::space">space</a></dt><dd>Creates some empty <a href="struct.Space.html" title="struct cosmic::widget::Space"><code>Space</code></a> with no size.</dd><dt><a class="fn" href="fn.spin_button.html" title="fn cosmic::widget::spin_button">spin_<wbr>button</a></dt><dd>Horizontal spin button widget.</dd><dt><a class="fn" href="fn.svg.html" title="fn cosmic::widget::svg">svg</a></dt><dd>Creates a new <a href="struct.Svg.html" title="struct cosmic::widget::Svg"><code>Svg</code></a> widget from the given <a href="svg/struct.Handle.html" title="struct cosmic::widget::svg::Handle"><code>Handle</code></a>.</dd><dt><a class="fn" href="fn.table.html" title="fn cosmic::widget::table">table</a></dt><dt><a class="fn" href="fn.text.html" title="fn cosmic::widget::text">text</a></dt><dd>Creates a new <a href="widget::Text"><code>Text</code></a> widget with the provided content.</dd><dt><a class="fn" href="fn.text_editor.html" title="fn cosmic::widget::text_editor">text_<wbr>editor</a></dt><dd>Creates a new <a href="struct.TextEditor.html" title="struct cosmic::widget::TextEditor"><code>TextEditor</code></a>.</dd><dt><a class="fn" href="fn.text_input.html" title="fn cosmic::widget::text_input">text_<wbr>input</a></dt><dd>Creates a new <a href="widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="fn" href="fn.toaster.html" title="fn cosmic::widget::toaster">toaster</a></dt><dd>Create a new Toaster widget.</dd><dt><a class="fn" href="fn.toggler.html" title="fn cosmic::widget::toggler">toggler</a></dt><dt><a class="fn" href="fn.tooltip.html" title="fn cosmic::widget::tooltip">tooltip</a></dt><dt><a class="fn" href="fn.vertical_slider.html" title="fn cosmic::widget::vertical_slider">vertical_<wbr>slider</a></dt><dd>Creates a new <a href="struct.VerticalSlider.html" title="struct cosmic::widget::VerticalSlider"><code>VerticalSlider</code></a>.</dd><dt><a class="fn" href="fn.vertical_spin_button.html" title="fn cosmic::widget::vertical_spin_button">vertical_<wbr>spin_<wbr>button</a></dt><dd>Vertical spin button widget.</dd><dt><a class="fn" href="fn.warning.html" title="fn cosmic::widget::warning">warning</a></dt><dt><a class="fn" href="fn.warning_container.html" title="fn cosmic::widget::warning_container">warning_<wbr>container</a></dt></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.IconButton.html" title="type cosmic::widget::IconButton">Icon<wbr>Button</a></dt><dt><a class="type" href="type.JustifyContent.html" title="type cosmic::widget::JustifyContent">Justify<wbr>Content</a></dt><dd>Sets the distribution of space between and around content items
|
|
For Flexbox it controls alignment in the main axis
|
|
For Grid it controls alignment in the inline axis</dd><dt><a class="type" href="type.JustifyItems.html" title="type cosmic::widget::JustifyItems">Justify<wbr>Items</a></dt><dd>Used to control how child nodes are aligned.
|
|
Does not apply to Flexbox, and will be ignored if specified on a flex container
|
|
For Grid it controls alignment in the inline axis</dd><dt><a class="type" href="type.LinkButton.html" title="type cosmic::widget::LinkButton">Link<wbr>Button</a></dt><dt><a class="type" href="type.Text.html" title="type cosmic::widget::Text">Text</a></dt><dd>A bunch of text.</dd><dt><a class="type" href="type.TextButton.html" title="type cosmic::widget::TextButton">Text<wbr>Button</a></dt><dt><a class="type" href="type.Tooltip.html" title="type cosmic::widget::Tooltip">Tooltip</a></dt></dl></section></div></main></body></html> |