mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-12-28 08:53:26 +03:00
149 lines
68 KiB
HTML
149 lines
68 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="API documentation for the Rust `ButtonBuilder` struct in crate `widgetry`."><meta name="keywords" content="rust, rustlang, rust-lang, ButtonBuilder"><title>widgetry::ButtonBuilder - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../widgetry/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Struct ButtonBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.corner_rounding">corner_rounding</a><a href="#structfield.default_style">default_style</a><a href="#structfield.disable_style">disable_style</a><a href="#structfield.hotkey">hotkey</a><a href="#structfield.hover_style">hover_style</a><a href="#structfield.is_disabled">is_disabled</a><a href="#structfield.is_label_before_image">is_label_before_image</a><a href="#structfield.padding">padding</a><a href="#structfield.stack_axis">stack_axis</a><a href="#structfield.stack_spacing">stack_spacing</a><a href="#structfield.tooltip">tooltip</a></div><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.batch">batch</a><a href="#method.bg_color">bg_color</a><a href="#method.build">build</a><a href="#method.build_def">build_def</a><a href="#method.build_widget">build_widget</a><a href="#method.corner_rounding">corner_rounding</a><a href="#method.custom_batch">custom_batch</a><a href="#method.disabled">disabled</a><a href="#method.font">font</a><a href="#method.font_size">font_size</a><a href="#method.horizontal">horizontal</a><a href="#method.hotkey">hotkey</a><a href="#method.image_batch">image_batch</a><a href="#method.image_bg_color">image_bg_color</a><a href="#method.image_bytes">image_bytes</a><a href="#method.image_color">image_color</a><a href="#method.image_content_mode">image_content_mode</a><a href="#method.image_corner_rounding">image_corner_rounding</a><a href="#method.image_dims">image_dims</a><a href="#method.image_first">image_first</a><a href="#method.image_padding">image_padding</a><a href="#method.image_path">image_path</a><a href="#method.label_color">label_color</a><a href="#method.label_first">label_first</a><a href="#method.label_styled_text">label_styled_text</a><a href="#method.label_text">label_text</a><a href="#method.label_underlined_text">label_underlined_text</a><a href="#method.new">new</a><a href="#method.no_tooltip">no_tooltip</a><a href="#method.outline">outline</a><a href="#method.padding">padding</a><a href="#method.padding_bottom">padding_bottom</a><a href="#method.padding_left">padding_left</a><a href="#method.padding_right">padding_right</a><a href="#method.padding_top">padding_top</a><a href="#method.stack_spacing">stack_spacing</a><a href="#method.style">style</a><a href="#method.style_mut">style_mut</a><a href="#method.tooltip">tooltip</a><a href="#method.vertical">vertical</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-Downcast">Downcast</a><a href="#impl-DowncastSync">DowncastSync</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-Same%3CT%3E">Same<T></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="index.html">widgetry</a></p><script>window.sidebarCurrent = {name: "ButtonBuilder", ty: "struct", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/widgetry/widgets/button.rs.html#132-144" title="goto source code">[src]</a></span><span class="in-band">Struct <a href="index.html">widgetry</a>::<wbr><a class="struct" href="">ButtonBuilder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct ButtonBuilder<'a, 'c> {
|
||
padding: <a class="struct" href="../widgetry/widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a>,
|
||
stack_spacing: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>,
|
||
hotkey: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/event/enum.MultiKey.html" title="enum widgetry::event::MultiKey">MultiKey</a>>,
|
||
tooltip: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../widgetry/text/struct.Text.html" title="struct widgetry::text::Text">Text</a>>,
|
||
stack_axis: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/geom/geom_batch_stack/enum.Axis.html" title="enum widgetry::geom::geom_batch_stack::Axis">Axis</a>>,
|
||
is_label_before_image: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
||
corner_rounding: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>>,
|
||
is_disabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
|
||
default_style: <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c>,
|
||
hover_style: <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c>,
|
||
disable_style: <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c>,
|
||
}</pre></div><h2 id="fields" class="fields small-section-header">
|
||
Fields<a href="#fields" class="anchor"></a></h2><span id="structfield.padding" class="structfield small-section-header"><a href="#structfield.padding" class="anchor field"></a><code>padding: <a class="struct" href="../widgetry/widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a></code></span><span id="structfield.stack_spacing" class="structfield small-section-header"><a href="#structfield.stack_spacing" class="anchor field"></a><code>stack_spacing: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></span><span id="structfield.hotkey" class="structfield small-section-header"><a href="#structfield.hotkey" class="anchor field"></a><code>hotkey: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/event/enum.MultiKey.html" title="enum widgetry::event::MultiKey">MultiKey</a>></code></span><span id="structfield.tooltip" class="structfield small-section-header"><a href="#structfield.tooltip" class="anchor field"></a><code>tooltip: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../widgetry/text/struct.Text.html" title="struct widgetry::text::Text">Text</a>></code></span><span id="structfield.stack_axis" class="structfield small-section-header"><a href="#structfield.stack_axis" class="anchor field"></a><code>stack_axis: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/geom/geom_batch_stack/enum.Axis.html" title="enum widgetry::geom::geom_batch_stack::Axis">Axis</a>></code></span><span id="structfield.is_label_before_image" class="structfield small-section-header"><a href="#structfield.is_label_before_image" class="anchor field"></a><code>is_label_before_image: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span id="structfield.corner_rounding" class="structfield small-section-header"><a href="#structfield.corner_rounding" class="anchor field"></a><code>corner_rounding: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../widgetry/widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>></code></span><span id="structfield.is_disabled" class="structfield small-section-header"><a href="#structfield.is_disabled" class="anchor field"></a><code>is_disabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span id="structfield.default_style" class="structfield small-section-header"><a href="#structfield.default_style" class="anchor field"></a><code>default_style: <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c></code></span><span id="structfield.hover_style" class="structfield small-section-header"><a href="#structfield.hover_style" class="anchor field"></a><code>hover_style: <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c></code></span><span id="structfield.disable_style" class="structfield small-section-header"><a href="#structfield.disable_style" class="anchor field"></a><code>disable_style: <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c></code></span><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<'b, 'a: 'b, 'c> <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/widgetry/widgets/button.rs.html#156-685" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>() -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#157-168" title="goto source code">[src]</a></h4><h4 id="method.padding" class="method"><code>pub fn <a href="#method.padding" class="fnname">padding</a><EI: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../widgetry/widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a>>>(self, padding: EI) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#180-183" title="goto source code">[src]</a></h4><div class="docblock"><p>Extra spacing around a button's items (label and/or image).</p>
|
||
<p>If not specified, a default will be applied.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="comment">// Custom padding for each inset</span>
|
||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">ButtonBuilder</span>::<span class="ident">new</span>().<span class="ident">padding</span>(<span class="ident">EdgeInsets</span>{ <span class="ident">top</span>: <span class="number">1.0</span>, <span class="ident">bottom</span>: <span class="number">2.0</span>, <span class="ident">left</span>: <span class="number">12.0</span>, <span class="ident">right</span>: <span class="number">14.0</span> });
|
||
<span class="comment">// uniform padding</span>
|
||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">ButtonBuilder</span>::<span class="ident">new</span>().<span class="ident">padding</span>(<span class="number">6</span>);</pre></div>
|
||
</div><h4 id="method.padding_top" class="method"><code>pub fn <a href="#method.padding_top" class="fnname">padding_top</a>(self, padding: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#186-189" title="goto source code">[src]</a></h4><div class="docblock"><p>Extra spacing around a button's items (label and/or image).</p>
|
||
</div><h4 id="method.padding_left" class="method"><code>pub fn <a href="#method.padding_left" class="fnname">padding_left</a>(self, padding: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#192-195" title="goto source code">[src]</a></h4><div class="docblock"><p>Extra spacing around a button's items (label and/or image).</p>
|
||
</div><h4 id="method.padding_bottom" class="method"><code>pub fn <a href="#method.padding_bottom" class="fnname">padding_bottom</a>(self, padding: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#198-201" title="goto source code">[src]</a></h4><div class="docblock"><p>Extra spacing around a button's items (label and/or image).</p>
|
||
</div><h4 id="method.padding_right" class="method"><code>pub fn <a href="#method.padding_right" class="fnname">padding_right</a>(self, padding: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#204-207" title="goto source code">[src]</a></h4><div class="docblock"><p>Extra spacing around a button's items (label and/or image).</p>
|
||
</div><h4 id="method.label_text" class="method"><code>pub fn <a href="#method.label_text" class="fnname">label_text</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, text: I) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#212-217" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the text of the button's label.</p>
|
||
<p>If <code>label_text</code> is not set, the button will not have a label.</p>
|
||
</div><h4 id="method.label_underlined_text" class="method"><code>pub fn <a href="#method.label_underlined_text" class="fnname">label_underlined_text</a>(self, text: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#222-228" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the text of the button's label. The text will be decorated with an underline.</p>
|
||
<p>See <code>label_styled_text</code> if you need something more customizable text styling.</p>
|
||
</div><h4 id="method.label_styled_text" class="method"><code>pub fn <a href="#method.label_styled_text" class="fnname">label_styled_text</a>(<br> self, <br> styled_text: <a class="struct" href="../widgetry/text/struct.Text.html" title="struct widgetry::text::Text">Text</a>, <br> for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a><br>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#232-242" title="goto source code">[src]</a></h4><div class="docblock"><p>Assign a pre-styled <code>Text</code> instance if your button need something more than uniformly
|
||
colored text.</p>
|
||
</div><h4 id="method.label_color" class="method"><code>pub fn <a href="#method.label_color" class="fnname">label_color</a>(self, color: <a class="struct" href="../widgetry/color/struct.Color.html" title="struct widgetry::color::Color">Color</a>, for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#247-253" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the color of the button's label.</p>
|
||
<p>If not specified, a default font color will be used.</p>
|
||
</div><h4 id="method.font" class="method"><code>pub fn <a href="#method.font" class="fnname">font</a>(self, font: <a class="enum" href="../widgetry/text/enum.Font.html" title="enum widgetry::text::Font">Font</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#258-263" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the font used by the button's label.</p>
|
||
<p>If not specified, a default font will be used.</p>
|
||
</div><h4 id="method.font_size" class="method"><code>pub fn <a href="#method.font_size" class="fnname">font_size</a>(self, font_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#268-273" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the size of the font of the button's label.</p>
|
||
<p>If not specified, a default font size will be used.</p>
|
||
</div><h4 id="method.image_path" class="method"><code>pub fn <a href="#method.image_path" class="fnname">image_path</a>(self, path: &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#278-285" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the image for the button. If not set, the button will have no image.</p>
|
||
<p>This will replace any image previously set.</p>
|
||
</div><h4 id="method.image_bytes" class="method"><code>pub fn <a href="#method.image_bytes" class="fnname">image_bytes</a>(self, labeled_bytes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#295-302" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the image for the button. If not set, the button will have no image.</p>
|
||
<p>This will replace any image previously set.</p>
|
||
<ul>
|
||
<li><code>labeled_bytes</code>: is a (<code>label</code>, <code>bytes</code>) tuple you can generate with
|
||
<a href="../widgetry/macro.include_labeled_bytes.html" title="include_labeled_bytes!"><code>include_labeled_bytes!</code></a></li>
|
||
<li><code>label</code>: a label to describe the bytes for debugging purposes</li>
|
||
<li><code>bytes</code>: UTF-8 encoded bytes of the SVG</li>
|
||
</ul>
|
||
</div><h4 id="method.image_batch" class="method"><code>pub fn <a href="#method.image_batch" class="fnname">image_batch</a>(self, batch: <a class="struct" href="../widgetry/geom/struct.GeomBatch.html" title="struct widgetry::geom::GeomBatch">GeomBatch</a>, bounds: <a class="struct" href="../geom/bounds/struct.Bounds.html" title="struct geom::bounds::Bounds">Bounds</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#310-315" title="goto source code">[src]</a></h4><div class="docblock"><p>Set the image for the button. If not set, the button will have no image.</p>
|
||
<p>This will replace any image previously set.</p>
|
||
<p>This method is useful when doing more complex transforms. For example, to re-write more than
|
||
one color for your button image, do so externally and pass in the resultant GeomBatch here.</p>
|
||
</div><h4 id="method.image_color" class="method"><code>pub fn <a href="#method.image_color" class="fnname">image_color</a><C: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../widgetry/geom/enum.RewriteColor.html" title="enum widgetry::geom::RewriteColor">RewriteColor</a>>>(<br> self, <br> color: C, <br> for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a><br>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#323-329" title="goto source code">[src]</a></h4><div class="docblock"><p>Rewrite the color of the button's image.</p>
|
||
<p>This has no effect if the button does not have an image.</p>
|
||
<p>If the style hasn't been set for the current ControlState, the style for
|
||
<code>ControlState::Default</code> will be used.</p>
|
||
</div><h4 id="method.image_bg_color" class="method"><code>pub fn <a href="#method.image_bg_color" class="fnname">image_bg_color</a>(self, color: <a class="struct" href="../widgetry/color/struct.Color.html" title="struct widgetry::color::Color">Color</a>, for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#337-343" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a background color for the image, other than the buttons background.</p>
|
||
<p>This has no effect if the button does not have an image.</p>
|
||
<p>If the style hasn't been set for the current ControlState, the style for
|
||
<code>ControlState::Default</code> will be used.</p>
|
||
</div><h4 id="method.image_dims" class="method"><code>pub fn <a href="#method.image_dims" class="fnname">image_dims</a><D: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../widgetry/screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a>>>(self, dims: D) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#350-355" title="goto source code">[src]</a></h4><div class="docblock"><p>Scale the bounds containing the image. If <code>image_dims</code> are not specified, the images
|
||
intrinsic size will be used.</p>
|
||
<p>See <a href="../widgetry/widgets/button/struct.ButtonBuilder.html#method.image_content_mode" title="ButtonBuilder::image_content_mode"><code>ButtonBuilder::image_content_mode</code></a> to control how the image scales to fit
|
||
its custom bounds.</p>
|
||
</div><h4 id="method.image_content_mode" class="method"><code>pub fn <a href="#method.image_content_mode" class="fnname">image_content_mode</a>(self, content_mode: <a class="enum" href="../widgetry/enum.ContentMode.html" title="enum widgetry::ContentMode">ContentMode</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#364-369" title="goto source code">[src]</a></h4><div class="docblock"><p>If a custom <code>image_dims</code> was set, control how the image should be scaled to its new bounds</p>
|
||
<p>If <code>image_dims</code> were not specified, the image will not be scaled, so content_mode has no
|
||
affect.</p>
|
||
<p>The default, <a href="../widgetry/enum.ContentMode.html#variant.ScaleAspectFit" title="ContentMode::ScaleAspectFit"><code>ContentMode::ScaleAspectFit</code></a> will only grow as much as it can while
|
||
maintaining its aspect ratio and not exceeding its bounds.</p>
|
||
</div><h4 id="method.image_corner_rounding" class="method"><code>pub fn <a href="#method.image_corner_rounding" class="fnname">image_corner_rounding</a><R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../widgetry/widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>>>(self, value: R) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#372-377" title="goto source code">[src]</a></h4><div class="docblock"><p>Set independent rounding for each of the button's image's corners</p>
|
||
</div><h4 id="method.image_padding" class="method"><code>pub fn <a href="#method.image_padding" class="fnname">image_padding</a><EI: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../widgetry/widgets/struct.EdgeInsets.html" title="struct widgetry::widgets::EdgeInsets">EdgeInsets</a>>>(self, value: EI) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#380-385" title="goto source code">[src]</a></h4><div class="docblock"><p>Set padding for the image</p>
|
||
</div><h4 id="method.bg_color" class="method"><code>pub fn <a href="#method.bg_color" class="fnname">bg_color</a>(self, color: <a class="struct" href="../widgetry/color/struct.Color.html" title="struct widgetry::color::Color">Color</a>, for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#391-394" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a background color for the button based on the button's <a href="../widgetry/enum.ControlState.html" title="ControlState"><code>ControlState</code></a>.</p>
|
||
<p>If the style hasn't been set for the current ControlState, the style for
|
||
<code>ControlState::Default</code> will be used.</p>
|
||
</div><h4 id="method.outline" class="method"><code>pub fn <a href="#method.outline" class="fnname">outline</a>(self, outline: <a class="type" href="../widgetry/style/type.OutlineStyle.html" title="type widgetry::style::OutlineStyle">OutlineStyle</a>, for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#400-403" title="goto source code">[src]</a></h4><div class="docblock"><p>Set an outline for the button based on the button's <a href="../widgetry/enum.ControlState.html" title="ControlState"><code>ControlState</code></a>.</p>
|
||
<p>If the style hasn't been set for the current ControlState, the style for
|
||
<code>ControlState::Default</code> will be used.</p>
|
||
</div><h4 id="method.custom_batch" class="method"><code>pub fn <a href="#method.custom_batch" class="fnname">custom_batch</a>(self, batch: <a class="struct" href="../widgetry/geom/struct.GeomBatch.html" title="struct widgetry::geom::GeomBatch">GeomBatch</a>, for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#409-412" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a pre-rendered <a href="../widgetry/geom/struct.GeomBatch.html" title="GeomBatch">GeomBatch</a> to use for the button instead of individual fields.</p>
|
||
<p>This is useful for applying one-off button designs that can't be accommodated by the
|
||
the existing ButtonBuilder methods.</p>
|
||
</div><h4 id="method.hotkey" class="method"><code>pub fn <a href="#method.hotkey" class="fnname">hotkey</a><MK: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../widgetry/event/enum.MultiKey.html" title="enum widgetry::event::MultiKey">MultiKey</a>>>(self, key: MK) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#415-418" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a hotkey for the button</p>
|
||
</div><h4 id="method.tooltip" class="method"><code>pub fn <a href="#method.tooltip" class="fnname">tooltip</a>(self, tooltip: <a class="struct" href="../widgetry/text/struct.Text.html" title="struct widgetry::text::Text">Text</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#423-426" title="goto source code">[src]</a></h4><div class="docblock"><p>Set a non-default tooltip <a href="../widgetry/text/struct.Text.html" title="Text"><code>Text</code></a> to appear when hovering over the button.</p>
|
||
<p>If a <code>tooltip</code> is not specified, a default tooltip will be applied.</p>
|
||
</div><h4 id="method.no_tooltip" class="method"><code>pub fn <a href="#method.no_tooltip" class="fnname">no_tooltip</a>(self) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#430-434" title="goto source code">[src]</a></h4><div class="docblock"><p>If a <code>tooltip</code> is not specified, a default tooltip will be applied. Use <code>no_tooltip</code> when
|
||
you do not want even the default tooltip to appear.</p>
|
||
</div><h4 id="method.vertical" class="method"><code>pub fn <a href="#method.vertical" class="fnname">vertical</a>(self) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#439-442" title="goto source code">[src]</a></h4><div class="docblock"><p>The button's items will be rendered in a vertical column</p>
|
||
<p>If the button doesn't have both an image and label, this has no effect.</p>
|
||
</div><h4 id="method.horizontal" class="method"><code>pub fn <a href="#method.horizontal" class="fnname">horizontal</a>(self) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#447-450" title="goto source code">[src]</a></h4><div class="docblock"><p>The button's items will be rendered in a horizontal row</p>
|
||
<p>If the button doesn't have both an image and label, this has no effect.</p>
|
||
</div><h4 id="method.disabled" class="method"><code>pub fn <a href="#method.disabled" class="fnname">disabled</a>(self, is_disabled: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#453-456" title="goto source code">[src]</a></h4><div class="docblock"><p>The button cannot be clicked and will be styled as <a href="../widgetry/enum.ControlState.html#variant.Disabled" title="ControlState::Disabled"><code>ControlState::Disabled</code></a></p>
|
||
</div><h4 id="method.label_first" class="method"><code>pub fn <a href="#method.label_first" class="fnname">label_first</a>(self) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#461-464" title="goto source code">[src]</a></h4><div class="docblock"><p>Display the button's label before the button's image.</p>
|
||
<p>If the button doesn't have both an image and label, this has no effect.</p>
|
||
</div><h4 id="method.image_first" class="method"><code>pub fn <a href="#method.image_first" class="fnname">image_first</a>(self) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#469-472" title="goto source code">[src]</a></h4><div class="docblock"><p>Display the button's image before the button's label.</p>
|
||
<p>If the button doesn't have both an image and label, this has no effect.</p>
|
||
</div><h4 id="method.stack_spacing" class="method"><code>pub fn <a href="#method.stack_spacing" class="fnname">stack_spacing</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#476-479" title="goto source code">[src]</a></h4><div class="docblock"><p>Spacing between the image and text of a button.
|
||
Has no effect if the button is text-only or image-only.</p>
|
||
</div><h4 id="method.corner_rounding" class="method"><code>pub fn <a href="#method.corner_rounding" class="fnname">corner_rounding</a><R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../widgetry/widgets/enum.CornerRounding.html" title="enum widgetry::widgets::CornerRounding">CornerRounding</a>>>(self, value: R) -> Self</code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#482-485" title="goto source code">[src]</a></h4><div class="docblock"><p>Set independent rounding for each of the button's corners</p>
|
||
</div><h4 id="method.build" class="method"><code>pub fn <a href="#method.build" class="fnname">build</a>(&self, ctx: &<a class="struct" href="../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, action: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../widgetry/widgets/button/struct.Button.html" title="struct widgetry::widgets::button::Button">Button</a></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#509-530" title="goto source code">[src]</a></h4><div class="docblock"><p>Build a button.</p>
|
||
<p><code>action</code>: The event that will be fired when clicked</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
||
<span class="kw">fn</span> <span class="ident">build_some_buttons</span>(<span class="ident">ctx</span>: <span class="kw-2">&</span><span class="ident">EventCtx</span>) {
|
||
<span class="kw">let</span> <span class="ident">one_off_builder</span> <span class="op">=</span> <span class="ident">ButtonBuilder</span>::<span class="ident">new</span>().<span class="ident">label_text</span>(<span class="string">"foo"</span>).<span class="ident">build</span>(<span class="ident">ctx</span>, <span class="string">"foo"</span>);
|
||
|
||
<span class="comment">// If you'd like to build a series of similar buttons, `clone` the builder first.</span>
|
||
<span class="kw">let</span> <span class="ident">red_builder</span> <span class="op">=</span> <span class="ident">ButtonBuilder</span>::<span class="ident">new</span>()
|
||
.<span class="ident">bg_color</span>(<span class="ident">Color</span>::<span class="ident">RED</span>, <span class="ident">ControlState</span>::<span class="ident">Default</span>)
|
||
.<span class="ident">bg_color</span>(<span class="ident">Color</span>::<span class="ident">RED</span>.<span class="ident">alpha</span>(<span class="number">0.3</span>), <span class="ident">ControlState</span>::<span class="ident">Disabled</span>)
|
||
.<span class="ident">outline</span>((<span class="number">2.0</span>, <span class="ident">Color</span>::<span class="ident">WHITE</span>), <span class="ident">ControlState</span>::<span class="ident">Default</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">red_button_1</span> <span class="op">=</span> <span class="ident">red_builder</span>.<span class="ident">clone</span>().<span class="ident">label_text</span>(<span class="string">"First red button"</span>).<span class="ident">build</span>(<span class="ident">ctx</span>, <span class="string">"first"</span>);
|
||
<span class="kw">let</span> <span class="ident">red_button_2</span> <span class="op">=</span> <span class="ident">red_builder</span>.<span class="ident">clone</span>().<span class="ident">label_text</span>(<span class="string">"Second red button"</span>).<span class="ident">build</span>(<span class="ident">ctx</span>, <span class="string">"second"</span>);
|
||
<span class="kw">let</span> <span class="ident">red_button_3</span> <span class="op">=</span> <span class="ident">red_builder</span>.<span class="ident">label_text</span>(<span class="string">"Last red button"</span>).<span class="ident">build</span>(<span class="ident">ctx</span>, <span class="string">"third"</span>);
|
||
}</pre></div>
|
||
</div><h4 id="method.build_widget" class="method"><code>pub fn <a href="#method.build_widget" class="fnname">build_widget</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>(<br> &self, <br> ctx: &<a class="struct" href="../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, <br> action: I<br>) -> <a class="struct" href="../widgetry/widgets/struct.Widget.html" title="struct widgetry::widgets::Widget">Widget</a></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#535-538" title="goto source code">[src]</a></h4><div class="docblock"><p>Shorthand method to build a Button wrapped in a Widget</p>
|
||
<p><code>action</code>: The event that will be fired when clicked</p>
|
||
</div><h4 id="method.build_def" class="method"><code>pub fn <a href="#method.build_def" class="fnname">build_def</a>(&self, ctx: &<a class="struct" href="../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>) -> <a class="struct" href="../widgetry/widgets/struct.Widget.html" title="struct widgetry::widgets::Widget">Widget</a></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#541-550" title="goto source code">[src]</a></h4><div class="docblock"><p>Shorthand method to build a default widget whose <code>action</code> is derived from the label's text.</p>
|
||
</div><h4 id="method.style_mut" class="method"><code>fn <a href="#method.style_mut" class="fnname">style_mut</a>(<br> &'b mut self, <br> state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a><br>) -> &'b mut <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#554-560" title="goto source code">[src]</a></h4><h4 id="method.style" class="method"><code>fn <a href="#method.style" class="fnname">style</a>(&'b self, state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> &'b <a class="struct" href="../widgetry/widgets/button/struct.ButtonStateStyle.html" title="struct widgetry::widgets::button::ButtonStateStyle">ButtonStateStyle</a><'a, 'c></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#562-568" title="goto source code">[src]</a></h4><h4 id="method.batch" class="method"><code>fn <a href="#method.batch" class="fnname">batch</a>(&self, ctx: &<a class="struct" href="../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a><'_>, for_state: <a class="enum" href="../widgetry/enum.ControlState.html" title="enum widgetry::ControlState">ControlState</a>) -> <a class="struct" href="../widgetry/geom/struct.GeomBatch.html" title="struct widgetry::geom::GeomBatch">GeomBatch</a></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#570-684" title="goto source code">[src]</a></h4></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/widgetry/widgets/button.rs.html#131" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#131" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id="method.clone_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#128-130" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/widgetry/widgets/button.rs.html#131" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#131" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id="impl-Default" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/widgetry/widgets/button.rs.html#131" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.default" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a class="srclink" href="../src/widgetry/widgets/button.rs.html#131" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><h3 id="impl-RefUnwindSafe" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-RefUnwindSafe" class="anchor"></a><a class="srclink" href="../src/widgetry/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Send" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-Send" class="anchor"></a><a class="srclink" href="../src/widgetry/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Sync" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-Sync" class="anchor"></a><a class="srclink" href="../src/widgetry/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-Unpin" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c> <span class="where fmt-newline">where<br> 'a: 'c, </span></code><a href="#impl-Unpin" class="anchor"></a><a class="srclink" href="../src/widgetry/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-UnwindSafe" class="impl"><code class="in-band">impl<'a, 'c> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../widgetry/widgets/button/struct.ButtonBuilder.html" title="struct widgetry::widgets::button::ButtonBuilder">ButtonBuilder</a><'a, 'c></code><a href="#impl-UnwindSafe" class="anchor"></a><a class="srclink" href="../src/widgetry/lib.rs.html#1" title="goto source code">[src]</a></h3><div class="impl-items"></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><h3 id="impl-Any" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.type_id" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id="impl-Borrow%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210-214" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211-213" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id="impl-BorrowMut%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217-221" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.borrow_mut" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-Downcast" class="impl"><code class="in-band">impl<T> Downcast for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>, </span></code><a href="#impl-Downcast" class="anchor"></a></h3><div class="impl-items"><h4 id="method.into_any" class="method hidden"><code>pub fn <a href="#method.into_any" class="fnname">into_any</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>></code></h4><div class='docblock hidden'><p>Convert <code>Box<dyn Trait></code> (where <code>Trait: Downcast</code>) to <code>Box<dyn Any></code>. <code>Box<dyn Any></code> can
|
||
then be further <code>downcast</code> into <code>Box<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="#tymethod.into_any">Read more</a></p>
|
||
</div><h4 id="method.into_any_rc" class="method hidden"><code>pub fn <a href="#method.into_any_rc" class="fnname">into_any_rc</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static></code></h4><div class='docblock hidden'><p>Convert <code>Rc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Rc<Any></code>. <code>Rc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Rc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="#tymethod.into_any_rc">Read more</a></p>
|
||
</div><h4 id="method.as_any" class="method hidden"><code>pub fn <a href="#method.as_any" class="fnname">as_any</a>(&self) -> &(dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</code></h4><div class='docblock hidden'><p>Convert <code>&Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&Any</code>'s vtable from <code>&Trait</code>'s. <a href="#tymethod.as_any">Read more</a></p>
|
||
</div><h4 id="method.as_any_mut" class="method hidden"><code>pub fn <a href="#method.as_any_mut" class="fnname">as_any_mut</a>(&mut self) -> &mut (dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static)</code></h4><div class='docblock hidden'><p>Convert <code>&mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&Any</code>. This is needed since Rust cannot
|
||
generate <code>&mut Any</code>'s vtable from <code>&mut Trait</code>'s. <a href="#tymethod.as_any_mut">Read more</a></p>
|
||
</div></div><h3 id="impl-DowncastSync" class="impl"><code class="in-band">impl<T> DowncastSync for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a>, </span></code><a href="#impl-DowncastSync" class="anchor"></a></h3><div class="impl-items"><h4 id="method.into_any_arc" class="method hidden"><code>pub fn <a href="#method.into_any_arc" class="fnname">into_any_arc</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><dyn <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>></code></h4><div class='docblock hidden'><p>Convert <code>Arc<Trait></code> (where <code>Trait: Downcast</code>) to <code>Arc<Any></code>. <code>Arc<Any></code> can then be
|
||
further <code>downcast</code> into <code>Arc<ConcreteType></code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="#tymethod.into_any_arc">Read more</a></p>
|
||
</div></div><h3 id="impl-From%3CT%3E" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href="#impl-From%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#552-556" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#553-555" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Into%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href="#impl-Into%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#541-548" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#545-547" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-Same%3CT%3E" class="impl"><code class="in-band">impl<T> Same<T> for T</code><a href="#impl-Same%3CT%3E" class="anchor"></a></h3><div class="impl-items"><h4 id="associatedtype.Output" class="type"><code>type <a href="#associatedtype.Output" class="type">Output</a> = T</code></h4><div class='docblock'><p>Should always be <code>Self</code></p>
|
||
</div></div><h3 id="impl-ToOwned" class="impl"><code class="in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href="#impl-ToOwned" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#80-92" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Owned" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div><h4 id="method.to_owned" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div><h4 id="method.clone_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91" title="goto source code">[src]</a></h4><div class="item-info hidden"><div class="stab unstable"><details><summary><span class="emoji">🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></div><h3 id="impl-TryFrom%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href="#impl-TryFrom%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#589-598" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_from" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#595-597" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id="impl-TryInto%3CU%3E" class="impl"><code class="in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href="#impl-TryInto%3CU%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#575-584" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error-1" class="type"><code>type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id="method.try_into" class="method hidden"><code>pub fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#581-583" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "widgetry";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |