<!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 `Widget` struct in crate `widgetry`."><metaname="keywords"content="rust, rustlang, rust-lang, Widget"><title>Widget in widgetry - Rust</title><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><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"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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="sidebar"><divclass="sidebar-menu"role="button">☰</div><ahref='../widgetry/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><h2class="location">Struct Widget</h2><divclass="sidebar-elems"><divclass="block items"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><divclass="sidebar-links"><ahref="#structfield.bg">bg</a><ahref="#structfield.bg_batch">bg_batch</a><ahref="#structfield.id">id</a><ahref="#structfield.layout">layout</a><ahref="#structfield.rect">rect</a><ahref="#structfield.widget">widget</a></div><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><divclass="sidebar-links"><ahref="#method.abs">abs</a><ahref="#method.align_bottom">align_bottom</a><ahref="#method.align_left">align_left</a><ahref="#method.align_right">align_right</a><ahref="#method.align_vert_center">align_vert_center</a><ahref="#method.apply_flexbox">apply_flexbox</a><ahref="#method.bg">bg</a><ahref="#method.centered">centered</a><ahref="#method.centered_cross">centered_cross</a><ahref="#method.centered_horiz">centered_horiz</a><ahref="#method.centered_vert">centered_vert</a><ahref="#method.col">col</a><ahref="#method.consume_geometry">consume_geometry</a><ahref="#method.container">container</a><ahref="#method.corner_rounding">corner_rounding</a><ahref="#method.currently_hovering">currently_hovering</a><ahref="#method.custom_col">custom_col</a><ahref="#method.custom_row">custom_row</a><ahref="#method.draw">draw</a><ahref="#method.dropdown">dropdown</a><ahref="#method.evenly_spaced">evenly_spaced</a><ahref="#method.evenly_spaced_col">evenly_spaced_col</a><ahref="#method.evenly_spaced_row">evenly_spaced_row</a><ahref="#method.fill_height">fill_height</a><ahref="#method.fill_width">fill_width</a><ahref="#method.find">find</a><ahref="#method.find_mut">find_mut</a><ahref="#method.flex_wrap">flex_wrap</a><ahref="#method.flex_wrap_no_inner_spacing">flex_wrap_no_inner_spacing</a><ahref="#method.force_width">force_width</a><ahref="#method.force_width_parent_pct">force_width_parent_pct</a><ahref="#method.force_width_window_pct">force_width_window_pct</a><ahref="#method.get_all_click_actions">get_all_click_actions</a><ahref="#method.get_flexbox">get_flexbox</a><ahref="#method.get_width_for_forcing">get_width_for_forcing</a><ahref="#method.horiz_separator">horiz_separator</a><ahref="#method.into_geom">into_geom</a><ahref="#method.is_btn">is_btn</a><ahref="#method.margin">margin</a><ahref="#method.margin_above">margin_above</a><ahref="#method.margin_below">margin_below</a><ahref="#method.margin_horiz">margin_horiz</a><ahref="#method.margin_left">margin_left</a><ahref="#method.margin_right">margin_right</a><ahref="#method.margin_vert">margin_vert</a><ahref="#method.named">named</a><ahref="#method.new">new</a><ahref="#method.nothing">nothing</a><ahref="#method.outline">outline</a><ahref="#method.padding">padding</a><ahref="#method.padding_bottom">padding_bottom</a><ahref="#method.padding_left">padding_left</a><ahref="#method.padding_right">padding_right</a><ahref="#method.padding_top">padding_top</a><ahref="#method.restore">restore</a><ahref="#method.row">row</a><ahref="#method.section">section</a><ahref="#method.tab_body">tab_body</a><ahref="#method.take">take</a><ahref="#method.take_just_draw">take_just_draw</a><ahref="#method.vert_separator">vert_separator</a></div><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><divclass
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.flex_wrap_no_inner_spacing"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#208-215"title="goto source code">[src]</a></div><ahref="#method.flex_wrap_no_inner_spacing"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.flex_wrap_no_inner_spacing"class="fnname">flex_wrap_no_inner_spacing</a>(<br> self, <br> ctx: &<aclass="struct"href="event_ctx/struct.EventCtx.html"title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, <br> width: <aclass="struct"href="../geom/percent/struct.Percent.html"title="struct geom::percent::Percent">Percent</a><br>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Like flex_wrap, but doesn’t horizontally space out widgets on the same row.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.force_width"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#217-220"title="goto source code">[src]</a></div><ahref="#method.force_width"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.force_width"class="fnname">force_width</a>(self, width: <aclass="primitive"href="https://doc.rust-lang.org/1.58.1/std/primitive.f64.html">f64</a>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Only for rows/columns. Used to force table columns to line up.</p>
</div></details><divid="method.corner_rounding"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#247-250"title="goto source code">[src]</a></div><ahref="#method.corner_rounding"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.corner_rounding"class="fnname">corner_rounding</a><R: <aclass="trait"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="enum"href="widgets/enum.CornerRounding.html"title="enum widgetry::widgets::CornerRounding">CornerRounding</a>>>(self, value: R) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.container"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#254-256"title="goto source code">[src]</a></div><ahref="#method.container"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.container"class="fnname">container</a>(self) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Things like padding don’t work on many widgets, so just make a convenient way to wrap in a
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.row"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#434-436"title="goto source code">[src]</a></div><ahref="#method.row"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.row"class="fnname">row</a>(widgets: <aclass="struct"href="https://doc.rust-lang.org/1.58.1/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a>>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Creates a row with the specified widgets. Every member gets a default horizontal margin.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.evenly_spaced_row"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#439-451"title="goto source code">[src]</a></div><ahref="#method.evenly_spaced_row"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.evenly_spaced_row"class="fnname">evenly_spaced_row</a>(spacing: <aclass="primitive"href="https://doc.rust-lang.org/1.58.1/std/primitive.usize.html">usize</a>, widgets: <aclass="struct"href="https://doc.rust-lang.org/1.58.1/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a>>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Creates a row with the specified widgets, with a <code>spacing</code> sized margin between members</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.custom_col"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#454-456"title="goto source code">[src]</a></div><ahref="#method.custom_col"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.custom_col"class="fnname">custom_col</a>(widgets: <aclass="struct"href="https://doc.rust-lang.org/1.58.1/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a>>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Creates a column with the specified widgets. No margins or other layouting is applied.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.evenly_spaced_col"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#459-471"title="goto source code">[src]</a></div><ahref="#method.evenly_spaced_col"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.evenly_spaced_col"class="fnname">evenly_spaced_col</a>(spacing: <aclass="primitive"href="https://doc.rust-lang.org/1.58.1/std/primitive.usize.html">usize</a>, widgets: <aclass="struct"href="https://doc.rust-lang.org/1.58.1/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a>>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Creates a column with the specified widgets, with a <code>spacing</code> sized margin between members</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.col"class="method has-srclink"><divclass="rightside"><aclass="srclink"href="../src/widgetry/widgets/mod.rs.html#474-476"title="goto source code">[src]</a></div><ahref="#method.col"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.col"class="fnname">col</a>(widgets: <aclass="struct"href="https://doc.rust-lang.org/1.58.1/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a>>) -><aclass="struct"href="widgets/struct.Widget.html"title="struct widgetry::widgets::Widget">Widget</a></h4></div></summary><divclass="docblock"><p>Creates a column with the specified widgets. Every member gets a default vertical margin.</p>
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>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-Instrument"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#155"title="goto source code">[src]</a></div><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></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.instrument"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#38"title="goto source code">[src]</a></div><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></div></summary><divclass='docblock'><p>Instruments this type with the provided <code>Span</code>, returning an
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.in_current_span"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://docs.rs/tracing/0.1.26/src/tracing/instrument.rs.html#74"title="goto source code">[src]</a></div><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></div></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><divid="impl-TryFrom%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.58.1/src/core/convert/mod.rs.html#587-596"title="goto source code">[src]</a></div><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.58.1/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.58.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="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.58.1/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.58.1/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_from"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.58.1/src/core/convert/mod.rs.html#593"title="goto source code">[src]</a></div><ahref="#method.try_from"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.58.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"open><summary><divid="impl-TryInto%3CU%3E"class="impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.58.1/src/core/convert/mod.rs.html#573-582"title="goto source code">[src]</a></div><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.58.1/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.58.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></div></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><divid="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.58.1/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></div></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><divid="method.try_into"class="method trait-impl has-srclink"><divclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.58.1/src/core/convert/mod.rs.html#579"title="goto source code">[src]</a></div><ahref="#method.try_into"class="anchor"></a><h4class="code-header">pub fn <ahref="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.58.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/1.58.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></div></summary><divclass='docblock'><p>Performs the conversion.</p>
