abstreet/rustdoc/widgetry/widgets/trait.WidgetImpl.html

33 lines
59 KiB
HTML
Raw Normal View History

<!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 `WidgetImpl` trait in crate `widgetry`."><meta name="keywords" content="rust, rustlang, rust-lang, WidgetImpl"><title>widgetry::widgets::WidgetImpl - 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 trait"><!--[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">&#9776;</div><a href='../../widgetry/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Trait WidgetImpl</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.draw">draw</a><a href="#tymethod.event">event</a><a href="#tymethod.get_dims">get_dims</a><a href="#tymethod.set_pos">set_pos</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.can_restore">can_restore</a><a href="#method.restore">restore</a></div><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.downcast">downcast</a><a href="#method.downcast_mut">downcast_mut</a><a href="#method.downcast_rc">downcast_rc</a><a href="#method.downcast_ref">downcast_ref</a><a href="#method.is">is</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../index.html">widgetry</a>::<wbr><a href="index.html">widgets</a></p><script>window.sidebarCurrent = {name: "WidgetImpl", ty: "trait", 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">&#x2212;</span>]</a></span><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#41-62" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="../index.html">widgetry</a>::<wbr><a href="index.html">widgets</a>::<wbr><a class="trait" href="">WidgetImpl</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait WidgetImpl: Downcast {
fn <a href="#tymethod.get_dims" class="fnname">get_dims</a>(&amp;self) -&gt; <a class="struct" href="../../widgetry/screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a>;
<div class="item-spacer"></div> fn <a href="#tymethod.set_pos" class="fnname">set_pos</a>(&amp;mut self, top_left: <a class="struct" href="../../widgetry/screen_geom/struct.ScreenPt.html" title="struct widgetry::screen_geom::ScreenPt">ScreenPt</a>);
<div class="item-spacer"></div> fn <a href="#tymethod.event" class="fnname">event</a>(&amp;mut self, ctx: &amp;mut <a class="struct" href="../../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, output: &amp;mut <a class="struct" href="../../widgetry/widgets/struct.WidgetOutput.html" title="struct widgetry::widgets::WidgetOutput">WidgetOutput</a>);
<div class="item-spacer"></div> fn <a href="#tymethod.draw" class="fnname">draw</a>(&amp;self, g: &amp;mut <a class="struct" href="../../widgetry/drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;);
fn <a href="#method.can_restore" class="fnname">can_restore</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
<div class="item-spacer"></div> fn <a href="#method.restore" class="fnname">restore</a>(&amp;mut self, _: &amp;mut <a class="struct" href="../../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _prev: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;) { ... }
}</pre></div><div class="docblock"><p>Create a new widget by implementing this trait. You can instantiate your widget by calling
<code>Widget::new(Box::new(instance of your new widget))</code>, which gives you the usual style options.</p>
</div><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><h3 id="tymethod.get_dims" class="method"><code>fn <a href="#tymethod.get_dims" class="fnname">get_dims</a>(&amp;self) -&gt; <a class="struct" href="../../widgetry/screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a></code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#44" title="goto source code">[src]</a></h3><div class="docblock"><p>What width and height does the widget occupy? If this changes, be sure to set
<code>redo_layout</code> to true in <code>event</code>.</p>
</div><h3 id="tymethod.set_pos" class="method"><code>fn <a href="#tymethod.set_pos" class="fnname">set_pos</a>(&amp;mut self, top_left: <a class="struct" href="../../widgetry/screen_geom/struct.ScreenPt.html" title="struct widgetry::screen_geom::ScreenPt">ScreenPt</a>)</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#46" title="goto source code">[src]</a></h3><div class="docblock"><p>Your widget's top left corner should be here. Handle mouse events and draw appropriately.</p>
</div><h3 id="tymethod.event" class="method"><code>fn <a href="#tymethod.event" class="fnname">event</a>(&amp;mut self, ctx: &amp;mut <a class="struct" href="../../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, output: &amp;mut <a class="struct" href="../../widgetry/widgets/struct.WidgetOutput.html" title="struct widgetry::widgets::WidgetOutput">WidgetOutput</a>)</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#49" title="goto source code">[src]</a></h3><div class="docblock"><p>Your chance to react to an event. Any side effects outside of this widget are communicated
through the output.</p>
</div><h3 id="tymethod.draw" class="method"><code>fn <a href="#tymethod.draw" class="fnname">draw</a>(&amp;self, g: &amp;mut <a class="struct" href="../../widgetry/drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;)</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#51" title="goto source code">[src]</a></h3><div class="docblock"><p>Draw the widget. Be sure to draw relative to the top-left specified by <code>set_pos</code>.</p>
</div></div><span class="loading-content">Loading content...</span><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><h3 id="method.can_restore" class="method"><code>fn <a href="#method.can_restore" class="fnname">can_restore</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#54-56" title="goto source code">[src]</a></h3><div class="docblock"><p>If a new Panel is being created to replace an older one, all widgets have the chance to
preserve state from the previous version.</p>
</div><h3 id="method.restore" class="method"><code>fn <a href="#method.restore" class="fnname">restore</a>(&amp;mut self, _: &amp;mut <a class="struct" href="../../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _prev: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;)</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#59-61" title="goto source code">[src]</a></h3><div class="docblock"><p>Restore state from the previous version of this widget, with the same ID. Implementors must
downcast.</p>
</div></div><span class="loading-content">Loading content...</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 dyn <a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#92" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.is" class="method"><code>pub fn <a href="#method.is" class="fnname">is</a>&lt;__T:&nbsp;<a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#92" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns true if the trait object wraps an object of type <code>__T</code>.</p>
</div><h4 id="method.downcast" class="method"><code>pub fn <a href="#method.downcast" class="fnname">downcast</a>&lt;__T:&nbsp;<a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;__T&gt;, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;Self&gt;&gt;</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#92" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a boxed object from a boxed trait object if the underlying object is of type
<code>__T</code>. Returns the original boxed trait if it isn't.</p>
</div><h4 id="method.downcast_rc" class="method"><code>pub fn <a href="#method.downcast_rc" class="fnname">downcast_rc</a>&lt;__T:&nbsp;<a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;(self: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;__T&gt;, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;Self&gt;&gt;</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#92" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns an <code>Rc</code>-ed object from an <code>Rc</code>-ed trait object if the underlying object is of
type <code>__T</code>. Returns the original <code>Rc</code>-ed trait if it isn't.</p>
</div><h4 id="method.downcast_ref" class="method"><code>pub fn <a href="#method.downcast_ref" class="fnname">downcast_ref</a>&lt;__T:&nbsp;<a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>__T&gt;</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#92" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a reference to the object within the trait object if it is of type <code>__T</code>, or
<code>None</code> if it isn't.</p>
</div><h4 id="method.downcast_mut" class="method"><code>pub fn <a href="#method.downcast_mut" class="fnname">downcast_mut</a>&lt;__T:&nbsp;<a class="trait" href="../../widgetry/widgets/trait.WidgetImpl.html" title="trait widgetry::widgets::WidgetImpl">WidgetImpl</a>&gt;(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>__T&gt;</code><a class="srclink" href="../../src/widgetry/widgets/mod.rs.html#92" title="goto source code">[src]</a></h4><div class="docblock"><p>Returns a mutable reference to the object within the trait object if it is of type
<code>__T</code>, or <code>None</code> if it isn't.</p>
</div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><h3 id="impl-WidgetImpl" class="impl"><code class="in-band">impl WidgetImpl for <a class="struct" href="../../widgetry/widgets/button/struct.Button.html" title="struct widgetry::widgets::button::Button">Button</a></code><a href="#impl-WidgetImpl" class="anchor"></a><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#75-129" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_dims" class="method hidden"><code>fn <a href="#method.get_dims" class="fnname">get_dims</a>(&amp;self) -&gt; <a class="struct" href="../../widgetry/screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a></code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#76-78" title="goto source code">[src]</a></h4><h4 id="method.set_pos" class="method hidden"><code>fn <a href="#method.set_pos" class="fnname">set_pos</a>(&amp;mut self, top_left: <a class="struct" href="../../widgetry/screen_geom/struct.ScreenPt.html" title="struct widgetry::screen_geom::ScreenPt">ScreenPt</a>)</code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#80-82" title="goto source code">[src]</a></h4><h4 id="method.event" class="method hidden"><code>fn <a href="#method.event" class="fnname">event</a>(&amp;mut self, ctx: &amp;mut <a class="struct" href="../../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, output: &amp;mut <a class="struct" href="../../widgetry/widgets/struct.WidgetOutput.html" title="struct widgetry::widgets::WidgetOutput">WidgetOutput</a>)</code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#84-115" title="goto source code">[src]</a></h4><h4 id="method.draw" class="method hidden"><code>fn <a href="#method.draw" class="fnname">draw</a>(&amp;self, g: &amp;mut <a class="struct" href="../../widgetry/drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;)</code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#117-128" title="goto source code">[src]</a></h4></div><h3 id="impl-WidgetImpl-1" class="impl"><code class="in-band">impl WidgetImpl for <a class="struct" href="../../widgetry/widgets/button/struct.MultiButton.html" title="struct widgetry::widgets::button::MultiButton">MultiButton</a></code><a href="#impl-WidgetImpl-1" class="anchor"></a><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#795-839" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.get_dims-1" class="method hidden"><code>fn <a href="#method.get_dims-1" class="fnname">get_dims</a>(&amp;self) -&gt; <a class="struct" href="../../widgetry/screen_geom/struct.ScreenDims.html" title="struct widgetry::screen_geom::ScreenDims">ScreenDims</a></code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#796-798" title="goto source code">[src]</a></h4><h4 id="method.set_pos-1" class="method hidden"><code>fn <a href="#method.set_pos-1" class="fnname">set_pos</a>(&amp;mut self, top_left: <a class="struct" href="../../widgetry/screen_geom/struct.ScreenPt.html" title="struct widgetry::screen_geom::ScreenPt">ScreenPt</a>)</code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#800-802" title="goto source code">[src]</a></h4><h4 id="method.event-1" class="method hidden"><code>fn <a href="#method.event-1" class="fnname">event</a>(&amp;mut self, ctx: &amp;mut <a class="struct" href="../../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, output: &amp;mut <a class="struct" href="../../widgetry/widgets/struct.WidgetOutput.html" title="struct widgetry::widgets::WidgetOutput">WidgetOutput</a>)</code><a class="srclink" href="../../src/widgetry/widgets/button.rs.html#804-828" title="goto source code">[src]</a></h4><h4 id="method.draw-1" class="method hidden"><code>fn <a href="#me