mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
58 lines
17 KiB
HTML
58 lines
17 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 `Event` enum in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, Event"><title>smithay_client_toolkit::keyboard::Event - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc enum"><!--[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><p class='location'>Enum Event</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Enter">Enter</a><a href="#variant.Leave">Leave</a><a href="#variant.Key">Key</a><a href="#variant.RepeatInfo">RepeatInfo</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>keyboard</a></p><script>window.sidebarCurrent = {name: 'Event', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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'>Enum <a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>keyboard</a>::<wbr><a class="enum" href=''>Event</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'>−</span>]</a></span><a class='srclink' href='../../src/smithay_client_toolkit/keyboard/mod.rs.html#403-450' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum Event<'a> {
|
||
Enter {
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
surface: <a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>>,
|
||
modifiers: <a class="struct" href="../../smithay_client_toolkit/keyboard/struct.ModifiersState.html" title="struct smithay_client_toolkit::keyboard::ModifiersState">ModifiersState</a>,
|
||
rawkeys: <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.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>,
|
||
keysyms: <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.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>,
|
||
},
|
||
Leave {
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
surface: <a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>>,
|
||
},
|
||
Key {
|
||
serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
modifiers: <a class="struct" href="../../smithay_client_toolkit/keyboard/struct.ModifiersState.html" title="struct smithay_client_toolkit::keyboard::ModifiersState">ModifiersState</a>,
|
||
rawkey: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
keysym: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
||
state: <a class="enum" href="../../smithay_client_toolkit/keyboard/enum.KeyState.html" title="enum smithay_client_toolkit::keyboard::KeyState">KeyState</a>,
|
||
utf8: <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="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>,
|
||
},
|
||
RepeatInfo {
|
||
rate: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
delay: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
|
||
},
|
||
}</pre></div><div class='docblock'><p>Events received from a mapped keyboard</p>
|
||
</div><h2 id='variants' class='variants small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.Enter" class="variant small-section-header"><a href="#variant.Enter" class="anchor field"></a><span id='Enter.v' class='invisible'><code>Enter</code></span></span><div class='docblock'><p>The keyboard focus has entered a surface</p>
|
||
</div><span class='docblock autohide sub-variant' id='variant.Enter.fields'><h3 class='fields'>Fields of <code>Enter</code></h3>
|
||
|
||
<table><tr><td id='variant.Enter.field.serial'><span id='Enter.v.serial.v' class='invisible'><code>serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>serial number of the event</p>
|
||
</div></td></tr><tr><td id='variant.Enter.field.surface'><span id='Enter.v.surface.v' class='invisible'><code>surface: <a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>></code></span></td><td><div class='docblock'><p>surface that was entered</p>
|
||
</div></td></tr><tr><td id='variant.Enter.field.modifiers'><span id='Enter.v.modifiers.v' class='invisible'><code>modifiers: <a class="struct" href="../../smithay_client_toolkit/keyboard/struct.ModifiersState.html" title="struct smithay_client_toolkit::keyboard::ModifiersState">ModifiersState</a></code></span></td><td><div class='docblock'><p>current state of the modifiers</p>
|
||
</div></td></tr><tr><td id='variant.Enter.field.rawkeys'><span id='Enter.v.rawkeys.v' class='invisible'><code>rawkeys: <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.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><div class='docblock'><p>raw values of the currently pressed keys</p>
|
||
</div></td></tr><tr><td id='variant.Enter.field.keysyms'><span id='Enter.v.keysyms.v' class='invisible'><code>keysyms: <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.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></td><td><div class='docblock'><p>interpreted symbols of the currently pressed keys</p>
|
||
</div></td></tr></table></span><span id="variant.Leave" class="variant small-section-header"><a href="#variant.Leave" class="anchor field"></a><span id='Leave.v' class='invisible'><code>Leave</code></span></span><div class='docblock'><p>The keyboard focus has left a surface</p>
|
||
</div><span class='docblock autohide sub-variant' id='variant.Leave.fields'><h3 class='fields'>Fields of <code>Leave</code></h3>
|
||
|
||
<table><tr><td id='variant.Leave.field.serial'><span id='Leave.v.serial.v' class='invisible'><code>serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>serial number of the event</p>
|
||
</div></td></tr><tr><td id='variant.Leave.field.surface'><span id='Leave.v.surface.v' class='invisible'><code>surface: <a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.Proxy.html" title="struct smithay_client_toolkit::reexports::client::Proxy">Proxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_surface/struct.WlSurface.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_surface::WlSurface">WlSurface</a>></code></span></td><td><div class='docblock'><p>surface that was left</p>
|
||
</div></td></tr></table></span><span id="variant.Key" class="variant small-section-header"><a href="#variant.Key" class="anchor field"></a><span id='Key.v' class='invisible'><code>Key</code></span></span><div class='docblock'><p>A key event occured</p>
|
||
</div><span class='docblock autohide sub-variant' id='variant.Key.fields'><h3 class='fields'>Fields of <code>Key</code></h3>
|
||
|
||
<table><tr><td id='variant.Key.field.serial'><span id='Key.v.serial.v' class='invisible'><code>serial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>serial number of the event</p>
|
||
</div></td></tr><tr><td id='variant.Key.field.time'><span id='Key.v.time.v' class='invisible'><code>time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>time at which the keypress occured</p>
|
||
</div></td></tr><tr><td id='variant.Key.field.modifiers'><span id='Key.v.modifiers.v' class='invisible'><code>modifiers: <a class="struct" href="../../smithay_client_toolkit/keyboard/struct.ModifiersState.html" title="struct smithay_client_toolkit::keyboard::ModifiersState">ModifiersState</a></code></span></td><td><div class='docblock'><p>current state of the modifiers</p>
|
||
</div></td></tr><tr><td id='variant.Key.field.rawkey'><span id='Key.v.rawkey.v' class='invisible'><code>rawkey: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>raw value of the key</p>
|
||
</div></td></tr><tr><td id='variant.Key.field.keysym'><span id='Key.v.keysym.v' class='invisible'><code>keysym: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><div class='docblock'><p>interpreted symbol of the key</p>
|
||
</div></td></tr><tr><td id='variant.Key.field.state'><span id='Key.v.state.v' class='invisible'><code>state: <a class="enum" href="../../smithay_client_toolkit/keyboard/enum.KeyState.html" title="enum smithay_client_toolkit::keyboard::KeyState">KeyState</a></code></span></td><td><div class='docblock'><p>new state of the key</p>
|
||
</div></td></tr><tr><td id='variant.Key.field.utf8'><span id='Key.v.utf8.v' class='invisible'><code>utf8: <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="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span></td><td><div class='docblock'><p>utf8 interpretation of the entered text</p>
|
||
<p>will always be <code>None</code> on key release events</p>
|
||
</div></td></tr></table></span><span id="variant.RepeatInfo" class="variant small-section-header"><a href="#variant.RepeatInfo" class="anchor field"></a><span id='RepeatInfo.v' class='invisible'><code>RepeatInfo</code></span></span><div class='docblock'><p>Repetition information advertizing</p>
|
||
</div><span class='docblock autohide sub-variant' id='variant.RepeatInfo.fields'><h3 class='fields'>Fields of <code>RepeatInfo</code></h3>
|
||
|
||
<table><tr><td id='variant.RepeatInfo.field.rate'><span id='RepeatInfo.v.rate.v' class='invisible'><code>rate: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></td><td><div class='docblock'><p>rate (in milisecond) at which the repetition should occur</p>
|
||
</div></td></tr><tr><td id='variant.RepeatInfo.field.delay'><span id='RepeatInfo.v.delay.v' class='invisible'><code>delay: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></td><td><div class='docblock'><p>delay (in milisecond) between a key press and the start of repetition</p>
|
||
</div></td></tr></table></span><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-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <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="enum" href="../../smithay_client_toolkit/keyboard/enum.Event.html" title="enum smithay_client_toolkit::keyboard::Event">Event</a><'a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <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="enum" href="../../smithay_client_toolkit/keyboard/enum.Event.html" title="enum smithay_client_toolkit::keyboard::Event">Event</a><'a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "smithay_client_toolkit";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |