libcosmic/cosmic/widget/text_input/index.html
2026-04-18 20:11:25 +00:00

9 lines
No EOL
12 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="A text input widget from iced widgets plus some added details."><title>cosmic::widget::text_input - 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 text_<wbr>input</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</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></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<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">widget</a></div><h1>Module <span>text_input</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/text_input/mod.rs.html#5-15">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A text input widget from iced widgets plus some added details.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.Style"><code>pub use crate::theme::<a class="enum" href="../../style/enum.TextInput.html" title="enum cosmic::style::TextInput">TextInput</a> as Style;</code></dt><dt id="reexport.Cursor"><code>pub use super::cursor::<a class="struct" href="cursor/struct.Cursor.html" title="struct cosmic::widget::text_input::cursor::Cursor">Cursor</a>;</code></dt><dt id="reexport.Value"><code>pub use super::value::<a class="struct" href="value/struct.Value.html" title="struct cosmic::widget::text_input::value::Value">Value</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="cursor/index.html" title="mod cosmic::widget::text_input::cursor">cursor</a></dt><dd>Track the cursor of a text input.</dd><dt><a class="mod" href="editor/index.html" title="mod cosmic::widget::text_input::editor">editor</a></dt><dt><a class="mod" href="value/index.html" title="mod cosmic::widget::text_input::value">value</a></dt></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.Appearance.html" title="struct cosmic::widget::text_input::Appearance">Appearance</a></dt><dd>The appearance of a text input.</dd><dt><a class="struct" href="struct.State.html" title="struct cosmic::widget::text_input::State">State</a></dt><dd>The state of a <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="struct" href="struct.TextInput.html" title="struct cosmic::widget::text_input::TextInput">Text<wbr>Input</a></dt><dd>A field that can be filled with text.</dd><dt><a class="struct" href="struct.TextInputString.html" title="struct cosmic::widget::text_input::TextInputString">Text<wbr>Input<wbr>String</a></dt><dd>A string which can be sent to the clipboard or drag-and-dropped.</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.StyleSheet.html" title="trait cosmic::widget::text_input::StyleSheet">Style<wbr>Sheet</a></dt><dd>A set of rules that dictate the style of a text input.</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.draw.html" title="fn cosmic::widget::text_input::draw">draw</a></dt><dd>Draws the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../../iced/daemon/program/graphics/core/text/trait.Renderer.html" title="trait cosmic::iced::daemon::program::graphics::core::text::Renderer"><code>Renderer</code></a>, overriding its
<a href="value/struct.Value.html" title="struct cosmic::widget::text_input::value::Value"><code>Value</code></a> if provided.</dd><dt><a class="fn" href="fn.editable_input.html" title="fn cosmic::widget::text_input::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.focus.html" title="fn cosmic::widget::text_input::focus">focus</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that focuses the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>.</dd><dt><a class="fn" href="fn.inline_input.html" title="fn cosmic::widget::text_input::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.layout.html" title="fn cosmic::widget::text_input::layout">layout</a></dt><dd>Computes the layout of a <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="fn" href="fn.mouse_interaction.html" title="fn cosmic::widget::text_input::mouse_interaction">mouse_<wbr>interaction</a></dt><dd>Computes the current <a href="../../iced/mouse/enum.Interaction.html" title="enum cosmic::iced::mouse::Interaction"><code>mouse::Interaction</code></a> of the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a>.</dd><dt><a class="fn" href="fn.move_cursor_to.html" title="fn cosmic::widget::text_input::move_cursor_to">move_<wbr>cursor_<wbr>to</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that moves the cursor of the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a> to the
provided position.</dd><dt><a class="fn" href="fn.move_cursor_to_end.html" title="fn cosmic::widget::text_input::move_cursor_to_end">move_<wbr>cursor_<wbr>to_<wbr>end</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that moves the cursor of the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a> to the
end.</dd><dt><a class="fn" href="fn.move_cursor_to_front.html" title="fn cosmic::widget::text_input::move_cursor_to_front">move_<wbr>cursor_<wbr>to_<wbr>front</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that moves the cursor of the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a> to the
front.</dd><dt><a class="fn" href="fn.search_input.html" title="fn cosmic::widget::text_input::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::text_input::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.select_all.html" title="fn cosmic::widget::text_input::select_all">select_<wbr>all</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that selects all the content of the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>.</dd><dt><a class="fn" href="fn.select_range.html" title="fn cosmic::widget::text_input::select_range">select_<wbr>range</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that selects a range of the content of the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given
<a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>.</dd><dt><a class="fn" href="fn.select_until_last.html" title="fn cosmic::widget::text_input::select_until_last">select_<wbr>until_<wbr>last</a></dt><dd>Produces a <a href="../../struct.Task.html" title="struct cosmic::Task"><code>Task</code></a> that selects from the front to the last occurrence of the given character
in the <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a> with the given <a href="../struct.Id.html" title="struct cosmic::widget::Id"><code>Id</code></a>, or selects all if not found.</dd><dt><a class="fn" href="fn.text_input.html" title="fn cosmic::widget::text_input::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.update.html" title="fn cosmic::widget::text_input::update">update</a></dt><dd>Processes an <a href="../../iced/enum.Event.html" title="enum cosmic::iced::Event"><code>Event</code></a> and updates the <a href="struct.State.html" title="struct cosmic::widget::text_input::State"><code>State</code></a> of a <a href="../struct.TextInput.html" title="struct cosmic::widget::TextInput"><code>TextInput</code></a>
accordingly.</dd></dl></section></div></main></body></html>