a-b-street/abstreet
1
1
Fork 0
mirror of https://github.com/a-b-street/abstreet.git synced 2024-12-20 21:01:33 +03:00
Code Issues Projects Releases Wiki Activity
53defc25e9
abstreet/rustdoc/widgetry/trait.SimpleState.html

22 lines
14 KiB
HTML
Raw Normal View History

deploy: 312a721e6389037c980df0de3c1478b15c6e5535
2020-12-31 22:29:16 +03:00
<!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 `SimpleState` trait in crate `widgetry`."><meta name="keywords" content="rust, rustlang, rust-lang, SimpleState"><title>widgetry::SimpleState - 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">
deploy: d917008f2ed732a57c1633dd4e17b7482613fe45
2020-12-17 23:57:50 +03:00
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
deploy: 4c2bc894385b4854a79966f9807476ae88d943bf
2021-03-25 19:13:32 +03:00
<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 SimpleState</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.on_click">on_click</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.draw">draw</a><a href="#method.draw_baselayer">draw_baselayer</a><a href="#method.panel_changed">panel_changed</a><a href="#method.on_mouseover">on_mouseover</a><a href="#method.other_event">other_event</a></div><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">widgetry</a></p><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"><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="in-band">Trait <a href="index.html">widgetry</a>::<wbr><a class="trait" href="">SimpleState</a></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#212-243" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait SimpleState&lt;A&gt; {
deploy: 6e7a91ada14cd6ba03db67629b9bf5b402e8053f
2021-02-11 21:43:41 +03:00
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="../widgetry/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/nightly/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/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;panel: &amp;<a class="struct" href="../widgetry/widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="../widgetry/app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;;
deploy: d917008f2ed732a57c1633dd4e17b7482613fe45
2020-12-17 23:57:50 +03:00
deploy: 522b902453cf9b9f18e1a949d4f7e897c7851c31
2021-03-11 22:51:29 +03:00
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="../widgetry/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/nightly/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut <a class="struct" href="../widgetry/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/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../widgetry/app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;&gt; { ... }
deploy: 6e7a91ada14cd6ba03db67629b9bf5b402e8053f
2021-02-11 21:43:41 +03:00
<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="../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/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="../widgetry/event_ctx/struct.EventCtx.html" title="struct widgetry::event_ctx::EventCtx">EventCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>A) -&gt; <a class="enum" href="../widgetry/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="../widgetry/drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/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="../widgetry/app_state/enum.DrawBaselayer.html" title="enum widgetry::app_state::DrawBaselayer">DrawBaselayer</a> { ... }
deploy: 312a721e6389037c980df0de3c1478b15c6e5535
2020-12-31 22:29:16 +03:00
}</pre></div><div class="docblock"><p>Many states fit a pattern of managing a single panel, handling mouseover events, and other
deploy: d917008f2ed732a57c1633dd4e17b7482613fe45
2020-12-17 23:57:50 +03:00
interactions on the map. Implementing this instead of <code>State</code> reduces some boilerplate.</p>
deploy: 6e7a91ada14cd6ba03db67629b9bf5b402e8053f
2021-02-11 21:43:41 +03:00
</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.on_click" class="method"><code>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="../widgetry/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/nightly/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;action: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;panel: &amp;<a class="struct" href="../widgetry/widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -&gt; <a class="enum" href="../widgetry/app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;</code><a class="srclink" href="../src/widgetry/app_state.rs.html#215-221" title="goto source code">[src]</a></h3><div class="docblock"><p>Called when something on the panel has been clicked. Since the action is just a string,
deploy: d917008f2ed732a57c1633dd4e17b7482613fe45
2020-12-17 23:57:50 +03:00
the fallback case can just use <code>unreachable!()</code>.</p>
deploy: 522b902453cf9b9f18e1a949d4f7e897c7851c31
2021-03-11 22:51:29 +03:00
</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.panel_changed" class="method"><code>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="../widgetry/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/nightly/std/primitive.reference.html">&amp;mut </a>A, <br>&nbsp;&nbsp;&nbsp;&nbsp;_: &amp;mut <a class="struct" href="../widgetry/widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a><br>) -&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="enum" href="../widgetry/app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;&gt;</code><a class="srclink" href="../src/widgetry/app_state.rs.html#224-231" title="goto source code">[src]</a></h3><div class="docblock"><p>Called when something on the panel has changed. If a transition is returned, stop handling
deploy: d917008f2ed732a57c1633dd4e17b7482613fe45
2020-12-17 23:57:50 +03:00
the event and immediately apply the transition.</p>
deploy: 522b902453cf9b9f18e1a949d4f7e897c7851c31
2021-03-11 22:51:29 +03:00
</div><h3 id="method.on_mouseover" class="method"><code>fn <a href="#method.on_mouseover" class="fnname">on_mouseover</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;, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>A)</code><a class="srclink" href="../src/widgetry/app_state.rs.html#233" title="goto source code">[src]</a></h3><div class="docblock"><p>Called when the mouse has moved.</p>
</div><h3 id="method.other_event" class="method"><code>fn <a href="#method.other_event" class="fnname">other_event</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;, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>A) -&gt; <a class="enum" href="../widgetry/app_state/enum.Transition.html" title="enum widgetry::app_state::Transition">Transition</a>&lt;A&gt;</code><a class="srclink" href="../src/widgetry/app_state.rs.html#236-238" title="goto source code">[src]</a></h3><div class="docblock"><p>If a panel <code>on_click</code> event didn't occur and <code>panel_changed</code> didn't return transition, then
deploy: d917008f2ed732a57c1633dd4e17b7482613fe45
2020-12-17 23:57:50 +03:00
call this to handle all other events.</p>
deploy: 4c2bc894385b4854a79966f9807476ae88d943bf
2021-03-25 19:13:32 +03:00
</div><h3 id="method.draw" class="method"><code>fn <a href="#method.draw" class="fnname">draw</a>(&amp;self, _: &amp;mut <a class="struct" href="../widgetry/drawing/struct.GfxCtx.html" title="struct widgetry::drawing::GfxCtx">GfxCtx</a>&lt;'_&gt;, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>A)</code><a class="srclink" href="../src/widgetry/app_state.rs.html#239" title="goto source code">[src]</a></h3><h3 id="method.draw_baselayer" class="method"><code>fn <a href="#method.draw_baselayer" class="fnname">draw_baselayer</a>(&amp;self) -&gt; <a class="enum" href="../widgetry/app_state/enum.DrawBaselayer.html" title="enum widgetry::app_state::DrawBaselayer">DrawBaselayer</a></code><a class="srclink" href="../src/widgetry/app_state.rs.html#240-242" title="goto source code">[src]</a></h3></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&lt;A:&nbsp;'static&gt; dyn <a class="trait" href="../widgetry/app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a>&lt;A&gt;</code><a href="#impl" class="anchor"></a><a class="srclink" href="../src/widgetry/app_state.rs.html#245-249" 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>(panel: <a class="struct" href="../widgetry/widgets/panel/struct.Panel.html" title="struct widgetry::widgets::panel::Panel">Panel</a>, inner: <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/app_state/trait.SimpleState.html" title="trait widgetry::app_state::SimpleState">SimpleState</a>&lt;A&gt;&gt;) -&gt; <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/app_state/trait.State.html" title="trait widgetry::app_state::State">State</a>&lt;A&gt;&gt;</code><a class="srclink" href="../src/widgetry/app_state.rs.html#246-248" title="goto source code">[src]</a></h4></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/widgetry/trait.SimpleState.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="widgetry"></div>
<script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue Copy Permalink