156 lines
12 KiB
HTML
156 lines
12 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 `Hotkey` struct in crate `pnmixerlib`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Hotkey">
|
|||
|
|
|
|||
|
|
<title>pnmixerlib::hotkey::Hotkey - 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 Hotkey</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><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'>hotkey</a></p><script>window.sidebarCurrent = {name: 'Hotkey', 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'>hotkey</a>::<wbr><a class="struct" href=''>Hotkey</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/pnmixerlib/hotkey.rs.html#32-44' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Hotkey {
|
|||
|
|
pub code: <a class="type" href="../../gdk/type.key.html" title="type gdk::key">key</a>,
|
|||
|
|
pub mod_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|||
|
|
pub sym: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>,
|
|||
|
|
pub gtk_accel: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
|||
|
|
}</pre><div class='docblock'><p>A hotkey, described by the underlying gdk/X11 representation.</p>
|
|||
|
|
</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.code' class="structfield">
|
|||
|
|
<span id='code.v' class='invisible'>
|
|||
|
|
<code>code: <a class="type" href="../../gdk/type.key.html" title="type gdk::key">key</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>The hardware keycode.</p>
|
|||
|
|
</div><span id='structfield.mod_bits' class="structfield">
|
|||
|
|
<span id='mod_bits.v' class='invisible'>
|
|||
|
|
<code>mod_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>The modifier keys and mouse button that have been pressed
|
|||
|
|
in addition to the main key (e.g. Numlock/Capslock).
|
|||
|
|
This is the raw bit representation and can be converted to
|
|||
|
|
<code>gtk::ModifierType</code> via <code>self.mods()</code>.</p>
|
|||
|
|
</div><span id='structfield.sym' class="structfield">
|
|||
|
|
<span id='sym.v' class='invisible'>
|
|||
|
|
<code>sym: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>X key symbol.</p>
|
|||
|
|
</div><span id='structfield.gtk_accel' class="structfield">
|
|||
|
|
<span id='gtk_accel.v' class='invisible'>
|
|||
|
|
<code>gtk_accel: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>Gtk Accelerator string.</p>
|
|||
|
|
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../pnmixerlib/hotkey/struct.Hotkey.html" title="struct pnmixerlib::hotkey::Hotkey">Hotkey</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/hotkey.rs.html#46-146' 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>(code: <a class="type" href="../../gdk/type.key.html" title="type gdk::key">key</a>, mods: <a class="struct" href="../../gdk/auto/flags/struct.ModifierType.html" title="struct gdk::auto::flags::ModifierType">ModifierType</a>) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="struct" href="../../pnmixerlib/hotkey/struct.Hotkey.html" title="struct pnmixerlib::hotkey::Hotkey">Hotkey</a>></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Creates a new hotkey and grabs it.</p>
|
|||
|
|
</div><h4 id='method.new_from_accel' class="method"><span id='new_from_accel.v' class='invisible'><code>fn <a href='#method.new_from_accel' class='fnname'>new_from_accel</a>(accel: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="struct" href="../../pnmixerlib/hotkey/struct.Hotkey.html" title="struct pnmixerlib::hotkey::Hotkey">Hotkey</a>></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Creates a new hotkey from an accelerator string and grabs it.</p>
|
|||
|
|
</div><h4 id='method.grab' class="method"><span id='grab.v' class='invisible'><code>fn <a href='#method.grab' class='fnname'>grab</a>(&self) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Grab a key manually. Should be paired with a ungrab() call.</p>
|
|||
|
|
</div><h4 id='method.ungrab' class="method"><span id='ungrab.v' class='invisible'><code>fn <a href='#method.ungrab' class='fnname'>ungrab</a>(&self)</code></span></h4>
|
|||
|
|
<div class='docblock'><p>Ungrab a key manually. Should be paired with a grab() call.</p>
|
|||
|
|
</div><h4 id='method.matches' class="method"><span id='matches.v' class='invisible'><code>fn <a href='#method.matches' class='fnname'>matches</a>(&self, code: <a class="type" href="../../gdk/type.key.html" title="type gdk::key">key</a>, mods: <a class="struct" href="../../gdk/auto/flags/struct.ModifierType.html" title="struct gdk::auto::flags::ModifierType">ModifierType</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Checks if the keycode we got (minus modifiers like
|
|||
|
|
numlock/capslock) matches the hotkey.
|
|||
|
|
Thus numlock + o will match o.</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../pnmixerlib/hotkey/struct.Hotkey.html" title="struct pnmixerlib::hotkey::Hotkey">Hotkey</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/hotkey.rs.html#30' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter.</p>
|
|||
|
|
</div></div><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/hotkey/struct.Hotkey.html" title="struct pnmixerlib::hotkey::Hotkey">Hotkey</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/hotkey.rs.html#148-153' 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>(&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>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</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>
|