abstreet/rustdoc/widgetry/trait.SimpleState.html
2021-07-29 16:51:19 +00:00

22 lines
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Many states fit a pattern of managing a single panel, handling mouseover events, and other interactions on the map. Implementing this instead of `State` reduces some boilerplate."><meta name="keywords" content="rust, rustlang, rust-lang, SimpleState"><title>SimpleState in widgetry - 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><script src="../crates.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 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../widgetry/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait SimpleState</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.on_click">on_click</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.draw">draw</a><a href="#method.draw_baselayer">draw_baselayer</a><a href="#method.on_click_custom">on_click_custom</a><a href="#method.on_mouseover">on_mouseover</a><a href="#method.other_event">other_event</a><a href="#method.panel_changed">panel_changed</a></div><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><div class="sidebar-links"><a href="#method.new_state">new_state</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="index.html">widgetry</a></h2><div id="sidebar-vars" data-name="SimpleState" data-ty="trait" data-relpath=""></div><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" title="themes"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">widgetry</a>::<wbr><a class="trait" href="#">SimpleState</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><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/app_state.rs.html#218-259" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait SimpleState&lt;A&gt; {
fn <a href="#tymethod.on_click" class="fnname">on_click</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;app: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;action: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;panel: &amp;<a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;;
fn <a href="#method.on_click_custom" class="fnname">on_click_custom</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_ctx: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_app: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_action: <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="../abstutil/clone/trait.CloneableAny.html" title="trait abstutil::clone::CloneableAny">CloneableAny</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_panel: &amp;<a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt; { ... }
<div class="item-spacer"></div> fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;&gt; { ... }
<div class="item-spacer"></div> fn <a href="#method.on_mouseover" class="fnname">on_mouseover</a>(&amp;mut self, _: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A) { ... }
<div class="item-spacer"></div> fn <a href="#method.other_event" class="fnname">other_event</a>(&amp;mut self, _: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A) -&gt; <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt; { ... }
<div class="item-spacer"></div> fn <a href="#method.draw" class="fnname">draw</a>(&amp;self, _: &amp;mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;</a>A) { ... }
<div class="item-spacer"></div> fn <a href="#method.draw_baselayer" class="fnname">draw_baselayer</a>(&amp;self) -&gt; <a class="enum" href="app_state/enum.DrawBaselayer.html" title="enum widgetry::app_state::DrawBaselayer">DrawBaselayer</a> { ... }
}</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Many states fit a pattern of managing a single panel, handling mouseover events, and other
interactions on the map. Implementing this instead of <code>State</code> reduces some boilerplate.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.on_click" class="method has-srclink"><h4 class="code-header">fn <a href="#tymethod.on_click" class="fnname">on_click</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;ctx: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;app: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;action: &amp;<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;panel: &amp;<a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -&gt; <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;</h4><a class="srclink" href="../src/widgetry/app_state.rs.html#221-227" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Called when something on the panel has been clicked. Since the action is just a string,
the fallback case can just use <code>unreachable!()</code>.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.on_click_custom" class="method has-srclink"><h4 class="code-header">fn <a href="#method.on_click_custom" class="fnname">on_click_custom</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;_ctx: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;_app: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;_action: <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="../abstutil/clone/trait.CloneableAny.html" title="trait abstutil::clone::CloneableAny">CloneableAny</a>&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;_panel: &amp;<a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -&gt; <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;</h4><a class="srclink" href="../src/widgetry/app_state.rs.html#229-237" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Called when something on the panel has been clicked.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.panel_changed" class="method has-srclink"><h4 class="code-header">fn <a href="#method.panel_changed" class="fnname">panel_changed</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;&gt;</h4><a class="srclink" href="../src/widgetry/app_state.rs.html#240-247" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Called when something on the panel has changed. If a transition is returned, stop handling
the event and immediately apply the transition.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.on_mouseover" class="method has-srclink"><h4 class="code-header">fn <a href="#method.on_mouseover" class="fnname">on_mouseover</a>(&amp;mut self, _: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A)</h4><a class="srclink" href="../src/widgetry/app_state.rs.html#249" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Called when the mouse has moved.</p>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.other_event" class="method has-srclink"><h4 class="code-header">fn <a href="#method.other_event" class="fnname">other_event</a>(&amp;mut self, _: &amp;mut <a class="struct" href="event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;mut </a>A) -&gt; <a class="enum" href="app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;</h4><a class="srclink" href="../src/widgetry/app_state.rs.html#252-254" title="goto source code">[src]</a></div></summary><div class="docblock"><p>If a panel <code>on_click</code> event didnt occur and <code>panel_changed</code> didnt return transition, then
call this to handle all other events.</p>
</div></details><div id="method.draw" class="method has-srclink"><h4 class="code-header">fn <a href="#method.draw" class="fnname">draw</a>(&amp;self, _: &amp;mut <a class="struct" href="drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&amp;</a>A)</h4><a class="srclink" href="../src/widgetry/app_state.rs.html#255" title="goto source code">[src]</a></div><div id="method.draw_baselayer" class="method has-srclink"><h4 class="code-header">fn <a href="#method.draw_baselayer" class="fnname">draw_baselayer</a>(&amp;self) -&gt; <a class="enum" href="app_state/enum.DrawBaselayer.html" title="enum widgetry::app_state::DrawBaselayer">DrawBaselayer</a></h4><a class="srclink" href="../src/widgetry/app_state.rs.html#256-258" title="goto source code">[src]</a></div></div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><h3 class="code-header in-band">impl&lt;A:&nbsp;'static&gt; dyn <a class="trait" href="app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a>&lt;A&gt;</h3><a href="#impl" class="anchor"></a><a class="srclink" href="../src/widgetry/app_state.rs.html#261-265" title="goto source code">[src]</a></div></summary><div class="impl-items"><div id="method.new_state" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.new_state" class="fnname">new_state</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;panel: <a class="struct" href="widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;inner: <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a>&lt;A&gt;&gt;<br>) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.54.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;dyn <a class="trait" href="app_state/trait.State.html" title="trait widgetry::app_state::State">State</a>&lt;A&gt;&gt;</h4><a href="#method.new_state" class="anchor"></a><a class="srclink" href="../src/widgetry/app_state.rs.html#262-264" title="goto source code">[src]</a></div></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/widgetry/trait.SimpleState.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="widgetry" data-search-index-js="../search-index.js" data-search-js="../search.js"></div><script src="../main.js"></script></body></html>