229 lines
22 KiB
HTML
229 lines
22 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 `Notification` struct in crate `libnotify`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Notification">
|
||
|
||
<title>libnotify::Notification - 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 Notification</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'>libnotify</a></p><script>window.sidebarCurrent = {name: 'Notification', 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'>libnotify</a>::<wbr><a class="struct" href=''>Notification</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></span></h1>
|
||
<pre class='rust struct'>pub struct Notification(_, _);</pre><div class='docblock'><p><code>Notification</code> represents a passive pop-up notification. It can contain
|
||
summary text, body text, and an icon, as well as hints specifying how
|
||
the notification should be presented. The notification is rendered by
|
||
a notification daemon, and may present the notification in any number
|
||
of ways. As such, there is a clear separation of content and
|
||
presentation, and this API enforces that.</p>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libnotify/notification.rs.html#27-249' 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><'a, 'b, P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'b <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>>(<br> summary: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> body: P, <br> icon: Q<br>) -> <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span></h4>
|
||
<div class='docblock'><p>Creates a new <code>Notification</code>. The summary text is required, but
|
||
all other parameters are optional.</p>
|
||
|
||
<h2 id='summary' class='section-header'><a href='#summary'><code>summary</code></a></h2>
|
||
<p>The required summary text.</p>
|
||
|
||
<h2 id='body' class='section-header'><a href='#body'><code>body</code></a></h2>
|
||
<p>The optional body text.</p>
|
||
|
||
<h2 id='icon' class='section-header'><a href='#icon'><code>icon</code></a></h2>
|
||
<p>The optional icon theme icon name or filename.</p>
|
||
|
||
<h1 id='returns' class='section-header'><a href='#returns'>Returns</a></h1>
|
||
<p>The new <code>Notification</code>.</p>
|
||
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><code>fn <a href='#method.close' class='fnname'>close</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="../glib/error/struct.Error.html" title="struct glib::error::Error">Error</a>></code></span></h4>
|
||
<div class='docblock'><p>Synchronously tells the notification server to hide the notification on the screen.</p>
|
||
|
||
<h1 id='returns-1' class='section-header'><a href='#returns-1'>Returns</a></h1>
|
||
<p><code>Ok(())</code> on success, or <code>Err(err)</code> on error</p>
|
||
</div><h4 id='method.show' class="method"><span id='show.v' class='invisible'><code>fn <a href='#method.show' class='fnname'>show</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="../glib/error/struct.Error.html" title="struct glib::error::Error">Error</a>></code></span></h4>
|
||
<div class='docblock'><p>Tells the notification server to display the notification on the screen.</p>
|
||
|
||
<h1 id='returns-2' class='section-header'><a href='#returns-2'>Returns</a></h1>
|
||
<p><code>Ok(())</code> on success, or <code>Err(err)</code> on error</p>
|
||
</div><h4 id='method.set_hint' class="method"><span id='set_hint.v' class='invisible'><code>fn <a href='#method.set_hint' class='fnname'>set_hint</a>(&self, key: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, value: <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="../glib/variant/struct.Variant.html" title="struct glib::variant::Variant">Variant</a>>)</code></span></h4>
|
||
<div class='docblock'><p>Sets a hint for <code>key</code> with value <code>value</code>. If <code>value</code> is <code>None</code>,
|
||
a previously set hint for <code>key</code> is unset.</p>
|
||
|
||
<p>If <code>value</code> is floating, it is consumed.</p>
|
||
|
||
<h2 id='key' class='section-header'><a href='#key'><code>key</code></a></h2>
|
||
<p>the hint key</p>
|
||
|
||
<h2 id='value' class='section-header'><a href='#value'><code>value</code></a></h2></div><h4 id='method.set_image_from_pixbuf' class="method"><span id='set_image_from_pixbuf.v' class='invisible'><code>fn <a href='#method.set_image_from_pixbuf' class='fnname'>set_image_from_pixbuf</a>(&self, pixbuf: &<a class="struct" href="../gdk_pixbuf/pixbuf/struct.Pixbuf.html" title="struct gdk_pixbuf::pixbuf::Pixbuf">Pixbuf</a>)</code></span></h4>
|
||
<div class='docblock'><p>Sets the image in the notification from a <code>gdk_pixbuf::Pixbuf</code>.</p>
|
||
|
||
<h2 id='pixbuf' class='section-header'><a href='#pixbuf'><code>pixbuf</code></a></h2>
|
||
<p>The image.</p>
|
||
</div><h4 id='method.clear_hints' class="method"><span id='clear_hints.v' class='invisible'><code>fn <a href='#method.clear_hints' class='fnname'>clear_hints</a>(&self)</code></span></h4>
|
||
<div class='docblock'><p>Clears all hints from the notification.</p>
|
||
</div><h4 id='method.set_app_name' class="method"><span id='set_app_name.v' class='invisible'><code>fn <a href='#method.set_app_name' class='fnname'>set_app_name</a><'a, P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>>(&self, app_name: P)</code></span></h4>
|
||
<div class='docblock'><p>Sets the application name for the notification. If this function is
|
||
not called or if <code>app_name</code> is <code>None</code>, the application name will be
|
||
set from the value used in <code>notify_init</code> or overridden with
|
||
<code>notify_set_app_name</code>.</p>
|
||
|
||
<h2 id='app_name' class='section-header'><a href='#app_name'><code>app_name</code></a></h2>
|
||
<p>the localised application name</p>
|
||
</div><h4 id='method.set_category' class="method"><span id='set_category.v' class='invisible'><code>fn <a href='#method.set_category' class='fnname'>set_category</a>(&self, category: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></h4>
|
||
<div class='docblock'><p>Sets the category of this notification. This can be used by the
|
||
notification server to filter or display the data in a certain way.</p>
|
||
|
||
<h2 id='category' class='section-header'><a href='#category'><code>category</code></a></h2>
|
||
<p>The category.</p>
|
||
</div><h4 id='method.set_timeout' class="method"><span id='set_timeout.v' class='invisible'><code>fn <a href='#method.set_timeout' class='fnname'>set_timeout</a>(&self, timeout: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>)</code></span></h4>
|
||
<div class='docblock'><p>Sets the timeout of the notification. To set the default time, pass
|
||
<code>NOTIFY_EXPIRES_DEFAULT</code> as <code>timeout</code>. To set the notification to never
|
||
expire, pass <code>NOTIFY_EXPIRES_NEVER</code>.</p>
|
||
|
||
<p>Note that the timeout may be ignored by the server.</p>
|
||
|
||
<h2 id='timeout' class='section-header'><a href='#timeout'><code>timeout</code></a></h2>
|
||
<p>The timeout in milliseconds.</p>
|
||
</div><h4 id='method.set_urgency' class="method"><span id='set_urgency.v' class='invisible'><code>fn <a href='#method.set_urgency' class='fnname'>set_urgency</a>(&self, urgency: <a class="enum" href="../libnotify/enum.Urgency.html" title="enum libnotify::Urgency">Urgency</a>)</code></span></h4>
|
||
<div class='docblock'><p>Sets the urgency level of this notification.</p>
|
||
|
||
<p>See: <code>Urgency</code></p>
|
||
|
||
<h2 id='urgency' class='section-header'><a href='#urgency'><code>urgency</code></a></h2>
|
||
<p>The urgency level.</p>
|
||
</div><h4 id='method.update' class="method"><span id='update.v' class='invisible'><code>fn <a href='#method.update' class='fnname'>update</a><'a, 'b, P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>, Q: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'b <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>>(<br> &self, <br> summary: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> body: P, <br> icon: Q<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</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></h4>
|
||
<div class='docblock'><p>Updates the notification text and icon. This won't send the update out
|
||
and display it on the screen. For that, you will need to call
|
||
<code>Notification::show</code>.</p>
|
||
|
||
<h2 id='summary-1' class='section-header'><a href='#summary-1'><code>summary</code></a></h2>
|
||
<p>The new required summary text.</p>
|
||
|
||
<h2 id='body-1' class='section-header'><a href='#body-1'><code>body</code></a></h2>
|
||
<p>The optional body text.</p>
|
||
|
||
<h2 id='icon-1' class='section-header'><a href='#icon-1'><code>icon</code></a></h2>
|
||
<p>The optional icon theme icon name or filename.</p>
|
||
|
||
<h1 id='returns-3' class='section-header'><a href='#returns-3'>Returns</a></h1>
|
||
<p><code>Ok(())</code> on success, or <code>Err(str)</code> if an invalid parameter was passed</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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span></h4>
|
||
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
|
||
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><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="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></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/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.hash' class="method"><span id='hash.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a><__H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, __arg_0: &mut __H)</code></span></h4>
|
||
<div class='docblock'><p>Feeds this value into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
|
||
</div><h4 id='method.hash_slice' class="method"><span id='hash_slice.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice' class='fnname'>hash_slice</a><H>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>, state: &mut H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></code><div class='since' title='Stable since Rust version 1.3.0'>1.3.0</div></span></h4>
|
||
<div class='docblock'><p>Feeds a slice of this type into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="../glib/types/trait.StaticType.html" title="trait glib::types::StaticType">StaticType</a> for <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.static_type' class="method"><span id='static_type.v' class='invisible'><code>fn <a href='../glib/types/trait.StaticType.html#tymethod.static_type' class='fnname'>static_type</a>() -> <a class="enum" href="../glib/types/enum.Type.html" title="enum glib::types::Type">Type</a></code></span></h4>
|
||
<div class='docblock'><p>Returns the type identifier of <code>Self</code>.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl<T: <a class="trait" href="../glib/object/trait.IsA.html" title="trait glib::object::IsA">IsA</a><<a class="struct" href="../glib/object/struct.Object.html" title="struct glib::object::Object">Object</a>>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><T> for <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
|
||
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
|
||
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="../glib/object/trait.IsA.html" title="trait glib::object::IsA">IsA</a><<a class="struct" href="../glib/object/struct.Object.html" title="struct glib::object::Object">Object</a>> for <a class="struct" href="../libnotify/struct.Notification.html" title="struct libnotify::Notification">Notification</a></code></span><span class='out-of-band'></span></h3>
|
||
<div class='impl-items'></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 = "libnotify";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |