<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `TextBox` struct in crate `widgetry`."><metaname="keywords"content="rust, rustlang, rust-lang, TextBox"><title>TextBox in widgetry::widgets::text_box - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../../../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../../../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../../../storage.js"></script><scriptsrc="../../../crates.js"></script><scriptdefersrc="../../../main.js"></script>
<noscript><linkrel="stylesheet"href="../../../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../../../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../../../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../../../favicon.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../../../widgetry/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../../../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">TextBox</a></h2><divclass="sidebar-elems"><section><divclass="block"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><ul><li><ahref="#structfield.autofocus">autofocus</a></li><li><ahref="#structfield.cursor_x">cursor_x</a></li><li><ahref="#structfield.dims">dims</a></li><li><ahref="#structfield.has_focus">has_focus</a></li><li><ahref="#structfield.hovering">hovering</a></li><li><ahref="#structfield.label">label</a></li><li><ahref="#structfield.line">line</a></li><li><ahref="#structfield.padding">padding</a></li><li><ahref="#structfield.top_left">top_left</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><ul><li><ahref="#method.calculate_text">calculate_text</a></li><li><ahref="#method.default_widget">default_widget</a></li><li><ahref="#method.get_line">get_line</a></li><li><ahref="#method.new">new</a></li><li><ahref="#method.widget">widget</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#trait-implementations">Trait Implementations</a></h3><ul><li><ahref="#impl-WidgetImpl">WidgetImpl</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a></li><li><ahref="#impl-Send">Send</a></li><li><ahref="#impl-Sync">Sync</a></li><li><ahref="#impl-Unpin">Unpin</a></li><li><ahref="#impl-UnwindSafe">UnwindSafe</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><ul><li><ahref="#impl-Any">Any</a></li><li><ahref="#impl-Borrow%3CT%3E">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a></li><li><ahref="#impl-Downcast">Downcast</a></li><li><ahref="#impl-DowncastSync">DowncastSync</a></li><li><ahref="#impl-From%3CT%3E">From<T></a></li><li><ahref="#impl-Instrument">Instrument</a></li><li><ahref="#impl-Into%3CU%3E">Into<U></a></li><li><ahref="#impl-Same%3CT%3E">Same<T></a></li><li><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></li></ul></div></section><h2class="location"><ahref="index.html">In widgetry::widgets::text_box</a></h2><divid="sidebar-vars"data-name="TextBox"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../../../widgetry/index.html"><imgclass="rust-logo"src="../../../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../../../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
<h1class="fqn"><spanclass="in-band">Struct <ahref="../../index.html">widgetry</a>::<wbr><ahref="../index.html">widgets</a>::<wbr><ahref="index.html">text_box</a>::<wbr><aclass="struct"href="#">TextBox</a><buttonid="copy-path"onclick="copy_path(this)"title="Copy item path to clipboard"><imgsrc="../../../clipboard.svg"width="19"height="18"alt="Copy item path"></button></span></h1><spanclass="out-of-band"><aclass="srclink"href="../../../src/widgetry/widgets/text_box.rs.html#11-22">source</a> · <aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass="inner">−</span>]</a></span></div><divclass="docblock item-decl"><preclass="rust struct"><code>pub struct TextBox {
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.set_pos"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../../../src/widgetry/widgets/text_box.rs.html#103-105">source</a></span><ahref="#method.set_pos"class="anchor"></a><h4class="code-header">fn <ahref="../trait.WidgetImpl.html#tymethod.set_pos"class="fnname">set_pos</a>(&mut self, top_left: <aclass="struct"href="../../screen_geom/struct.ScreenPt.html"title="struct widgetry::screen_geom::ScreenPt">ScreenPt</a>)</h4></section></summary><divclass='docblock'><p>Your widget’s top left corner should be here. Handle mouse events and draw appropriately.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.event"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../../../src/widgetry/widgets/text_box.rs.html#107-156">source</a></span><ahref="#method.event"class="anchor"></a><h4class="code-header">fn <ahref="../trait.WidgetImpl.html#tymethod.event"class="fnname">event</a>(&mut self, ctx: &mut <aclass="struct"href="../../event_ctx/struct.EventCtx.html"title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, output: &mut <aclass="struct"href="../struct.WidgetOutput.html"title="struct widgetry::widgets::WidgetOutput">WidgetOutput</a>)</h4></section></summary><divclass='docblock'><p>Your chance to react to an event. Any side effects outside of this widget are communicated
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.draw"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../../../src/widgetry/widgets/text_box.rs.html#158-179">source</a></span><ahref="#method.draw"class="anchor"></a><h4class="code-header">fn <ahref="../trait.WidgetImpl.html#tymethod.draw"class="fnname">draw</a>(&self, g: &mut <aclass="struct"href="../../drawing/struct.GfxCtx.html"title="struct widgetry::drawing::GfxCtx">GfxCtx</a><'_>)</h4></section></summary><divclass='docblock'><p>Draw the widget. Be sure to draw relative to the top-left specified by <code>set_pos</code>.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.can_restore"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../../../src/widgetry/widgets/mod.rs.html#61-63">source</a></span><ahref="#method.can_restore"class="anchor"></a><h4class="code-header">fn <ahref="../trait.WidgetImpl.html#method.can_restore"class="fnname">can_restore</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.60.0/std/primitive.bool.html">bool</a></h4></section></summary><divclass='docblock'><p>If a new Panel is being created to replace an older one, all widgets have the chance to
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.restore"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../../../src/widgetry/widgets/mod.rs.html#66-68">source</a></span><ahref="#method.restore"class="anchor"></a><h4class="code-header">fn <ahref="../trait.WidgetImpl.html#method.restore"class="fnname">restore</a>(&mut self, _: &mut <aclass="struct"href="../../event_ctx/struct.EventCtx.html"title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, _prev: &dyn <aclass="trait"href="../trait.WidgetImpl.html"title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>)</h4></section></summary><divclass='docblock'><p>Restore state from the previous version of this widget, with the same ID. Implementors must
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any">Read more</a></p>
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_rc">Read more</a></p>
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <ahref="#tymethod.into_any_arc">Read more</a></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-From%3CT%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#553-558">source</a></span><ahref="#impl-From%3CT%3E"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#555">source</a></span><ahref="#method.from"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.From.html#tymethod.from"class="fnname">from</a>(t: T) -> T</h4></section></summary><divclass="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Instrument"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#155">source</a></span><ahref="#impl-Instrument"class="anchor"></a><h3class="code-header in-band">impl<T><aclass="trait"href="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html"title="trait tracing::instrument::Instrument">Instrument</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.instrument"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#38">source</a></span><ahref="#method.instrument"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.instrument"class="fnname">instrument</a>(self, span: <aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/span/struct.Span.html"title="struct tracing::span::Span">Span</a>) -><aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the provided <code>Span</code>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.in_current_span"class="method trait-impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#74">source</a></span><ahref="#method.in_current_span"class="anchor"></a><h4class="code-header">fn <ahref="https://docs.rs/tracing/0.1.26/tracing/instrument/trait.Instrument.html#method.in_current_span"class="fnname">in_current_span</a>(self) -><aclass="struct"href="https://docs.rs/tracing/0.1.26/tracing/instrument/struct.Instrumented.html"title="struct tracing::instrument::Instrumented">Instrumented</a><Self></h4></section></summary><divclass='docblock'><p>Instruments this type with the <ahref="../struct.Span.html#method.current">current</a><code>Span</code>, returning an
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Into%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#537-548">source</a></span><ahref="#impl-Into%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.into"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#545">source</a></span><ahref="#method.into"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.Into.html#tymethod.into"class="fnname">into</a>(self) -> U</h4></section></summary><divclass="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.From.html"title="From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-Same%3CT%3E"class="impl has-srclink"><ahref="#impl-Same%3CT%3E"class="anchor"></a><h3class="code-header in-band">impl<T> Same<T> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Output"class="type trait-impl has-srclink"><ahref="#associatedtype.Output"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Output"class="associatedtype">Output</a> = T</h4></section></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-TryFrom%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#594-603">source</a></span><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="type trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.60.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#600">source</a></span><ahref="#method.try_from"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.60.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl-TryInto%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#579-588">source</a></span><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="type trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.60.0/src/core/convert/mod.rs.html#585">source</a></span><ahref="#method.try_into"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.60.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.60.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'><p>Performs the conversion.</p>
