mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 03:28:41 +00:00
25 lines
16 KiB
HTML
25 lines
16 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 `AutoThemer` enum in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, AutoThemer"><title>smithay_client_toolkit::pointer::AutoThemer - 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 AutoThemer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Themed">Themed</a><a href="#variant.UnThemed">UnThemed</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.init">init</a><a href="#method.theme_pointer">theme_pointer</a><a href="#method.theme_pointer_with_impl">theme_pointer_with_impl</a><a href="#method.theme_pointer_with_nonsend_impl">theme_pointer_with_nonsend_impl</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'>pointer</a></p><script>window.sidebarCurrent = {name: 'AutoThemer', 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'>pointer</a>::<wbr><a class="enum" href=''>AutoThemer</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/pointer/mod.rs.html#21-26' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum AutoThemer {
|
|||
|
|
Themed(<a class="struct" href="../../smithay_client_toolkit/pointer/struct.ThemeManager.html" title="struct smithay_client_toolkit::pointer::ThemeManager">ThemeManager</a>),
|
|||
|
|
UnThemed,
|
|||
|
|
}</pre></div><div class='docblock'><p>Wrapper to gracefully handle a missing <code>libwayland-cursor</code></p>
|
|||
|
|
<p>This wrapper has the same API as <code>ThemeManager</code>, but will
|
|||
|
|
gracefully handle the case of a missing <code>libwayland-cursor</code>
|
|||
|
|
by doing nothing.</p>
|
|||
|
|
<p>It is a convenience wrapper to handle systems where
|
|||
|
|
<code>libwayland-client.so</code> is available but not <code>libwayland-cursor.so</code>.</p>
|
|||
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.Themed" class="variant small-section-header"><a href="#variant.Themed" class="anchor field"></a><span id='Themed.v' class='invisible'><code>Themed(<a class="struct" href="../../smithay_client_toolkit/pointer/struct.ThemeManager.html" title="struct smithay_client_toolkit::pointer::ThemeManager">ThemeManager</a>)</code></span></span><div class='docblock'><p>The theme could be loaded</p>
|
|||
|
|
</div><span id="variant.UnThemed" class="variant small-section-header"><a href="#variant.UnThemed" class="anchor field"></a><span id='UnThemed.v' class='invisible'><code>UnThemed</code></span></span><div class='docblock'><p><code>libwayland-cursor.so</code> is not available</p>
|
|||
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoThemer.html" title="enum smithay_client_toolkit::pointer::AutoThemer">AutoThemer</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/pointer/mod.rs.html#28-118' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.init' class="method"><span id='init.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.init' class='fnname'>init</a>(<br> name: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, <br> compositor: <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_compositor/struct.WlCompositor.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_compositor::WlCompositor">WlCompositor</a>>, <br> shm: <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_shm/struct.WlShm.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_shm::WlShm">WlShm</a>><br>) -> <a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoThemer.html" title="enum smithay_client_toolkit::pointer::AutoThemer">AutoThemer</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/pointer/mod.rs.html#34-43' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Load a system pointer theme</p>
|
|||
|
|
<p>Will use the default theme of the system if name is <code>None</code>.</p>
|
|||
|
|
<p>Falls back to <code>UnThemed</code> if <code>libwayland-cursor</code> is not available.</p>
|
|||
|
|
</div><h4 id='method.theme_pointer' class="method"><span id='theme_pointer.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.theme_pointer' class='fnname'>theme_pointer</a>(&self, pointer: <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_pointer/struct.WlPointer.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_pointer::WlPointer">WlPointer</a>>) -> <a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoPointer.html" title="enum smithay_client_toolkit::pointer::AutoPointer">AutoPointer</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/pointer/mod.rs.html#46-51' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Wrap a pointer to theme it</p>
|
|||
|
|
</div><h4 id='method.theme_pointer_with_impl' class="method"><span id='theme_pointer_with_impl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.theme_pointer_with_impl' class='fnname'>theme_pointer_with_impl</a><Impl>(<br> &self, <br> pointer: <a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.NewProxy.html" title="struct smithay_client_toolkit::reexports::client::NewProxy">NewProxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_pointer/struct.WlPointer.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_pointer::WlPointer">WlPointer</a>>, <br> implementation: Impl<br>) -> <a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoPointer.html" title="enum smithay_client_toolkit::pointer::AutoPointer">AutoPointer</a> <span class="where fmt-newline">where<br> Impl: <a class="trait" href="../../smithay_client_toolkit/reexports/client/commons/trait.Implementation.html" title="trait smithay_client_toolkit::reexports::client::commons::Implementation">Implementation</a><<a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoPointer.html" title="enum smithay_client_toolkit::pointer::AutoPointer">AutoPointer</a>, <a class="enum" href="../../smithay_client_toolkit/reexports/client/protocol/wl_pointer/enum.Event.html" title="enum smithay_client_toolkit::reexports::client::protocol::wl_pointer::Event">Event</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/pointer/mod.rs.html#58-80' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Initialize a new pointer as a ThemedPointer with an adapter implementation</p>
|
|||
|
|
<p>You need to provide an implementation as if implementing a <code>wl_pointer</code>, but
|
|||
|
|
it will receive as <code>meta</code> argument an <code>AutoPointer</code> wrapping your pointer,
|
|||
|
|
rather than a <code>Proxy<WlPointer></code>.</p>
|
|||
|
|
</div><h4 id='method.theme_pointer_with_nonsend_impl' class="method"><span id='theme_pointer_with_nonsend_impl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub unsafe fn <a href='#method.theme_pointer_with_nonsend_impl' class='fnname'>theme_pointer_with_nonsend_impl</a><Impl>(<br> &self, <br> pointer: <a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.NewProxy.html" title="struct smithay_client_toolkit::reexports::client::NewProxy">NewProxy</a><<a class="struct" href="../../smithay_client_toolkit/reexports/client/protocol/wl_pointer/struct.WlPointer.html" title="struct smithay_client_toolkit::reexports::client::protocol::wl_pointer::WlPointer">WlPointer</a>>, <br> implementation: Impl, <br> token: &<a class="struct" href="../../smithay_client_toolkit/reexports/client/struct.QueueToken.html" title="struct smithay_client_toolkit::reexports::client::QueueToken">QueueToken</a><br>) -> <a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoPointer.html" title="enum smithay_client_toolkit::pointer::AutoPointer">AutoPointer</a> <span class="where fmt-newline">where<br> Impl: <a class="trait" href="../../smithay_client_toolkit/reexports/client/commons/trait.Implementation.html" title="trait smithay_client_toolkit::reexports::client::commons::Implementation">Implementation</a><<a class="enum" href="../../smithay_client_toolkit/pointer/enum.AutoPointer.html" title="enum smithay_client_toolkit::pointer::AutoPointer">AutoPointer</a>, <a class="enum" href="../../smithay_client_toolkit/reexports/client/protocol/wl_pointer/enum.Event.html" title="enum smithay_client_toolkit::reexports::client::protocol::wl_pointer::Event">Event</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/pointer/mod.rs.html#87-117' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Initialize a new pointer as a ThemedPointer with an adapter implementation</p>
|
|||
|
|
<p>Like <code>theme_pointer_with_impl</code> but allows you to have a non-<code>Send</code> implementation.</p>
|
|||
|
|
<p><strong>Unsafe</strong> for the same reasons as <code>NewProxy::implement_nonsend</code>.</p>
|
|||
|
|
</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-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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/pointer/enum.AutoThemer.html" title="enum smithay_client_toolkit::pointer::AutoThemer">AutoThemer</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 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/pointer/enum.AutoThemer.html" title="enum smithay_client_toolkit::pointer::AutoThemer">AutoThemer</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>
|