hasufell
/
pnmixer-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
pnmixer-rust/pnmixerlib/hotkeys/struct.Hotkeys.html

132 lines
8.4 KiB
HTML
Raw Normal View History

Include all modules
2017-07-16 21:45:21 +00: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 `Hotkeys` struct in crate `pnmixerlib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Hotkeys">
<title>pnmixerlib::hotkeys::Hotkeys - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Struct Hotkeys</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>hotkeys</a></p><script>window.sidebarCurrent = {name: 'Hotkeys', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>hotkeys</a>::<wbr><a class="struct" href=''>Hotkeys</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/pnmixerlib/hotkeys.rs.html#26-35' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Hotkeys { /* fields omitted */ }</pre><div class='docblock'><p>The possible Hotkeys for manipulating the volume.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../pnmixerlib/hotkeys/struct.Hotkeys.html" title="struct pnmixerlib::hotkeys::Hotkeys">Hotkeys</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/hotkeys.rs.html#37-192' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(prefs: &amp;<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>, audio: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a>&lt;<a class="struct" href="../../pnmixerlib/audio/struct.Audio.html" title="struct pnmixerlib::audio::Audio">Audio</a>&gt;) -&gt; <a class="enum" href="../../w_result/enum.WResult.html" title="enum w_result::WResult">WResult</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;<a class="struct" href="../../pnmixerlib/hotkeys/struct.Hotkeys.html" title="struct pnmixerlib::hotkeys::Hotkeys">Hotkeys</a>&gt;, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>, <a class="struct" href="../../pnmixerlib/errors/struct.Error.html" title="struct pnmixerlib::errors::Error">Error</a>&gt;</code></span></h4>
<div class='docblock'><p>Creates the hotkeys subsystem and binds the hotkeys.</p>
</div><h4 id='method.reload' class="method"><span id='reload.v' class='invisible'><code>fn <a href='#method.reload' class='fnname'>reload</a>(&amp;mut self, prefs: &amp;<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>) -&gt; <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>&gt;</code></span></h4>
<div class='docblock'><p>Reload the Hotkeys from the preferences.
If hotkeys are disabled, just sets all members to <code>None</code>.
This has to be called each time the preferences are modified.</p>
<h1 id='returns' class='section-header'><a href='#returns'>Returns</a></h1>
<p><code>Ok(())</code> on success, otherwise <code>Err(str)</code> if some of the hotkeys
could not be grabbed, where <code>str</code> is a String that can be
presented via e.g. <code>run_error_dialog()</code>.</p>
</div><h4 id='method.bind' class="method"><span id='bind.v' class='invisible'><code>fn <a href='#method.bind' class='fnname'>bind</a>(&amp;self)</code></span></h4>
<div class='docblock'><p>Bind hotkeys manually. Should be paired with an <code>unbind()</code> call.</p>
</div><h4 id='method.unbind' class="method"><span id='unbind.v' class='invisible'><code>fn <a href='#method.unbind' class='fnname'>unbind</a>(&amp;self)</code></span></h4>
<div class='docblock'><p>Unbind hotkeys manually. Should be paired with a <code>bind()</code> call.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../pnmixerlib/hotkeys/struct.Hotkeys.html" title="struct pnmixerlib::hotkeys::Hotkeys">Hotkeys</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/hotkeys.rs.html#194-206' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&amp;mut self)</code></span></h4>
<div class='docblock'><p>A method called when the value goes out of scope. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "pnmixerlib";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>