143 lines
10 KiB
HTML
143 lines
10 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 `TrayIcon` struct in crate `pnmixerlib`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, TrayIcon">
|
|||
|
|
|
|||
|
|
<title>pnmixerlib::ui_tray_icon::TrayIcon - 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 TrayIcon</p><div class="block items"><ul><li><a href="#fields">Fields</a></li><li><a href="#methods">Methods</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a>::<wbr><a href='index.html'>ui_tray_icon</a></p><script>window.sidebarCurrent = {name: 'TrayIcon', 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'>ui_tray_icon</a>::<wbr><a class="struct" href=''>TrayIcon</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/ui_tray_icon.rs.html#29-39' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct TrayIcon {
|
|||
|
|
pub volmeter: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<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="../../pnmixerlib/ui_tray_icon/struct.VolMeter.html" title="struct pnmixerlib::ui_tray_icon::VolMeter">VolMeter</a>>>,
|
|||
|
|
pub audio_pix: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<a class="struct" href="../../pnmixerlib/ui_tray_icon/struct.AudioPix.html" title="struct pnmixerlib::ui_tray_icon::AudioPix">AudioPix</a>>,
|
|||
|
|
pub status_icon: <a class="struct" href="../../gtk/auto/status_icon/struct.StatusIcon.html" title="struct gtk::auto::status_icon::StatusIcon">StatusIcon</a>,
|
|||
|
|
pub icon_size: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Cell.html" title="struct core::cell::Cell">Cell</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>>,
|
|||
|
|
// some fields omitted
|
|||
|
|
}</pre><div class='docblock'><p>The tray icon struct, describing the complete visual state.</p>
|
|||
|
|
</div><h2 id='fields' class='fields'>Fields</h2><span id='structfield.volmeter' class="structfield">
|
|||
|
|
<span id='volmeter.v' class='invisible'>
|
|||
|
|
<code>volmeter: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<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="../../pnmixerlib/ui_tray_icon/struct.VolMeter.html" title="struct pnmixerlib::ui_tray_icon::VolMeter">VolMeter</a>>></code>
|
|||
|
|
</span></span><div class='docblock'><p>The volume meter to draw on the actual Pixbuf, if requested.</p>
|
|||
|
|
</div><span id='structfield.audio_pix' class="structfield">
|
|||
|
|
<span id='audio_pix.v' class='invisible'>
|
|||
|
|
<code>audio_pix: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefCell.html" title="struct core::cell::RefCell">RefCell</a><<a class="struct" href="../../pnmixerlib/ui_tray_icon/struct.AudioPix.html" title="struct pnmixerlib::ui_tray_icon::AudioPix">AudioPix</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>The actual Pixbuf tray icon.</p>
|
|||
|
|
</div><span id='structfield.status_icon' class="structfield">
|
|||
|
|
<span id='status_icon.v' class='invisible'>
|
|||
|
|
<code>status_icon: <a class="struct" href="../../gtk/auto/status_icon/struct.StatusIcon.html" title="struct gtk::auto::status_icon::StatusIcon">StatusIcon</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>The gtk <code>StatusIcon</code> widget, used to register callbacks.</p>
|
|||
|
|
</div><span id='structfield.icon_size' class="structfield">
|
|||
|
|
<span id='icon_size.v' class='invisible'>
|
|||
|
|
<code>icon_size: <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Cell.html" title="struct core::cell::Cell">Cell</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>The current icon size.</p>
|
|||
|
|
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../pnmixerlib/ui_tray_icon/struct.TrayIcon.html" title="struct pnmixerlib::ui_tray_icon::TrayIcon">TrayIcon</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/pnmixerlib/ui_tray_icon.rs.html#42-159' 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: &<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>) -> <a class="type" href="../../pnmixerlib/errors/type.Result.html" title="type pnmixerlib::errors::Result">Result</a><<a class="struct" href="../../pnmixerlib/ui_tray_icon/struct.TrayIcon.html" title="struct pnmixerlib::ui_tray_icon::TrayIcon">TrayIcon</a>></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Constructor. <code>audio_pix</code> is initialized as empty GdkPixbuf, to save
|
|||
|
|
one iteration of png decoding (<code>update_all()</code> is triggered immediately
|
|||
|
|
on startup through <code>tray_icon.connect_size_changed</code> usually,
|
|||
|
|
otherwise we have to trigger it manually).</p>
|
|||
|
|
</div><h4 id='method.update_all' class="method"><span id='update_all.v' class='invisible'><code>fn <a href='#method.update_all' class='fnname'>update_all</a>(<br> &self, <br> prefs: &<a class="struct" href="../../pnmixerlib/prefs/struct.Prefs.html" title="struct pnmixerlib::prefs::Prefs">Prefs</a>, <br> audio: &<a class="struct" href="../../pnmixerlib/audio/struct.Audio.html" title="struct pnmixerlib::audio::Audio">Audio</a>, <br> m_size: <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.i32.html">i32</a>><br>) -> <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>Update the whole tray icon state.</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>
|