|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/libnotify/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>NotifyNotification</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="Libnotify Reference Manual">
<link rel="up" href="ch01.html" title="Libnotify">
<link rel="prev" href="libnotify-notify.html" title="notify">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Libnotify">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libnotify-notify.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libnotify Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" class="shortcut">Description</a>
 | 
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#properties" class="shortcut">Properties</a>
 | 
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="NotifyNotification"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="top_of_page"></a>NotifyNotification</span></h2>
<p>NotifyNotification — A passive pop-up notification.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define <a href="NotifyNotification.html#NOTIFY-EXPIRES-DEFAULT:CAPS">NOTIFY_EXPIRES_DEFAULT</a>
#define <a href="NotifyNotification.html#NOTIFY-EXPIRES-NEVER:CAPS">NOTIFY_EXPIRES_NEVER</a>
<a href="NotifyNotification.html#NotifyNotification-struct">NotifyNotification</a>;
enum <a href="NotifyNotification.html#NotifyUrgency">NotifyUrgency</a>;
void (<a href="NotifyNotification.html#NotifyActionCallback">*NotifyActionCallback</a>) (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a>*,
gchar*,
gpointer);
#define <a href="NotifyNotification.html#NOTIFY-ACTION-CALLBACK:CAPS">NOTIFY_ACTION_CALLBACK</a> (func)
<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a>* <a href="NotifyNotification.html#notify-notification-new">notify_notification_new</a> (const gchar *summary,
const gchar *body,
const gchar *icon,
GtkWidget *attach);
<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a>* <a href="NotifyNotification.html#notify-notification-new-with-status-icon">notify_notification_new_with_status_icon</a>
(const gchar *summary,
const gchar *body,
const gchar *icon,
GtkStatusIcon *status_icon);
gboolean <a href="NotifyNotification.html#notify-notification-update">notify_notification_update</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *summary,
const gchar *body,
const gchar *icon);
void <a href="NotifyNotification.html#notify-notification-attach-to-widget">notify_notification_attach_to_widget</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GtkWidget *attach);
void <a href="NotifyNotification.html#notify-notification-attach-to-status-icon">notify_notification_attach_to_status_icon</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GtkStatusIcon *status_icon);
void <a href="NotifyNotification.html#notify-notification-set-geometry-hints">notify_notification_set_geometry_hints</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GdkScreen *screen,
gint x,
gint y);
gboolean <a href="NotifyNotification.html#notify-notification-show">notify_notification_show</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GError **error);
void <a href="NotifyNotification.html#notify-notification-set-timeout">notify_notification_set_timeout</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
gint timeout);
void <a href="NotifyNotification.html#notify-notification-set-category">notify_notification_set_category</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const char *category);
void <a href="NotifyNotification.html#notify-notification-set-urgency">notify_notification_set_urgency</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
<a href="NotifyNotification.html#NotifyUrgency">NotifyUrgency</a> urgency);
void <a href="NotifyNotification.html#notify-notification-set-icon-from-pixbuf">notify_notification_set_icon_from_pixbuf</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GdkPixbuf *icon);
void <a href="NotifyNotification.html#notify-notification-set-hint-int32">notify_notification_set_hint_int32</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
gint value);
void <a href="NotifyNotification.html#notify-notification-set-hint-double">notify_notification_set_hint_double</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
gdouble value);
void <a href="NotifyNotification.html#notify-notification-set-hint-string">notify_notification_set_hint_string</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
const gchar *value);
void <a href="NotifyNotification.html#notify-notification-set-hint-byte">notify_notification_set_hint_byte</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
guchar value);
void <a href="NotifyNotification.html#notify-notification-set-hint-byte-array">notify_notification_set_hint_byte_array</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
const guchar *value,
gsize len);
void <a href="NotifyNotification.html#notify-notification-clear-hints">notify_notification_clear_hints</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification);
void <a href="NotifyNotification.html#notify-notification-add-action">notify_notification_add_action</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const char *action,
const char *label,
<a href="NotifyNotification.html#NotifyActionCallback">NotifyActionCallback</a> callback,
gpointer user_data,
GFreeFunc free_func);
void <a href="NotifyNotification.html#notify-notification-clear-actions">notify_notification_clear_actions</a>
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification);
gboolean <a href="NotifyNotification.html#notify-notification-close">notify_notification_close</a> (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GError **error);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----NotifyNotification
</pre>
</div>
<div class="refsect1" lang="en">
<a name="properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="NotifyNotification.html#NotifyNotification--attach-widget">attach-widget</a>" GtkWidget : Read / Write / Construct
"<a href="NotifyNotification.html#NotifyNotification--body">body</a>" gchararray : Read / Write / Construct
"<a href="NotifyNotification.html#NotifyNotification--icon-name">icon-name</a>" gchararray : Read / Write / Construct
"<a href="NotifyNotification.html#NotifyNotification--summary">summary</a>" gchararray : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="signal_proto"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="NotifyNotification.html#NotifyNotification-closed">closed</a>" void user_function (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
gpointer user_data) : Run first
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<p>
<a href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> 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>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2562748"></a><h3>
<a name="NOTIFY-EXPIRES-DEFAULT:CAPS"></a>NOTIFY_EXPIRES_DEFAULT</h3>
<a class="indexterm" name="id2562758"></a><pre class="programlisting">#define NOTIFY_EXPIRES_DEFAULT -1
</pre>
<p>
The default expiration time on a notification.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562774"></a><h3>
<a name="NOTIFY-EXPIRES-NEVER:CAPS"></a>NOTIFY_EXPIRES_NEVER</h3>
<a class="indexterm" name="id2562784"></a><pre class="programlisting">#define NOTIFY_EXPIRES_NEVER 0
</pre>
<p>
The notification never expires. It stays open until closed by the calling API
or the user.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2539254"></a><h3>
<a name="NotifyNotification-struct"></a>NotifyNotification</h3>
<a class="indexterm" name="id2533641"></a><pre class="programlisting">typedef struct _NotifyNotification NotifyNotification;</pre>
<p>
This is an opaque structure representing a notification. This should
not be used directly. Use the accessor functions below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562802"></a><h3>
<a name="NotifyUrgency"></a>enum NotifyUrgency</h3>
<a class="indexterm" name="id2562813"></a><pre class="programlisting">typedef enum
{
NOTIFY_URGENCY_LOW,
NOTIFY_URGENCY_NORMAL,
NOTIFY_URGENCY_CRITICAL,
} NotifyUrgency;
</pre>
<p>
The urgency level of the notification.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="NOTIFY-URGENCY-LOW:CAPS"></a><code class="literal">NOTIFY_URGENCY_LOW</code></span></td>
<td>
Low urgency. Used for unimportant notifications.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="NOTIFY-URGENCY-NORMAL:CAPS"></a><code class="literal">NOTIFY_URGENCY_NORMAL</code></span></td>
<td>
Normal urgency. Used for most standard notifications.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="NOTIFY-URGENCY-CRITICAL:CAPS"></a><code class="literal">NOTIFY_URGENCY_CRITICAL</code></span></td>
<td>
Critical urgency. Used for very important notifications.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562895"></a><h3>
<a name="NotifyActionCallback"></a>NotifyActionCallback ()</h3>
<a class="indexterm" name="id2562905"></a><pre class="programlisting">void (*NotifyActionCallback) (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a>*,
gchar*,
gpointer);</pre>
<p>
An action callback function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>Param2</code></em> :</span></td>
<td>The action ID.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>Param3</code></em> :</span></td>
<td>User data.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2562983"></a><h3>
<a name="NOTIFY-ACTION-CALLBACK:CAPS"></a>NOTIFY_ACTION_CALLBACK()</h3>
<a class="indexterm" name="id2562994"></a><pre class="programlisting">#define NOTIFY_ACTION_CALLBACK(func) ((NotifyActionCallback)(func))
</pre>
<p>
A convenience macro for casting a function to a <a href="NotifyNotification.html#NotifyActionCallback"><span class="type">NotifyActionCallback</span></a>. This
is much like <code class="function">G_CALLBACK()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>func</code></em> :</span></td>
<td>The function to cast.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563041"></a><h3>
<a name="notify-notification-new"></a>notify_notification_new ()</h3>
<a class="indexterm" name="id2563051"></a><pre class="programlisting"><a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a>* notify_notification_new (const gchar *summary,
const gchar *body,
const gchar *icon,
GtkWidget *attach);</pre>
<p>
Creates a new <a href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>. The summary text is required, but
all other parameters are optional.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
<td> The required summary text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>body</code></em> :</span></td>
<td> The optional body text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon</code></em> :</span></td>
<td> The optional icon theme icon name or filename.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>attach</code></em> :</span></td>
<td> The optional widget to attach to.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The new <a href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563178"></a><h3>
<a name="notify-notification-new-with-status-icon"></a>notify_notification_new_with_status_icon ()</h3>
<a class="indexterm" name="id2563192"></a><pre class="programlisting"><a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a>* notify_notification_new_with_status_icon
(const gchar *summary,
const gchar *body,
const gchar *icon,
GtkStatusIcon *status_icon);</pre>
<p>
Creates a new <a href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> and attaches to a <span class="type">GtkStatusIcon</span>.
The summary text and <em class="parameter"><code>status_icon</code></em> is required, but all other parameters
are optional.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
<td> The required summary text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>body</code></em> :</span></td>
<td> The optional body text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon</code></em> :</span></td>
<td> The optional icon theme icon name or filename.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>status_icon</code></em> :</span></td>
<td> The required <span class="type">GtkStatusIcon</span>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The new <a href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 0.4.1
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563341"></a><h3>
<a name="notify-notification-update"></a>notify_notification_update ()</h3>
<a class="indexterm" name="id2563352"></a><pre class="programlisting">gboolean notify_notification_update (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *summary,
const gchar *body,
const gchar *icon);</pre>
<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
<a href="NotifyNotification.html#notify-notification-show"><code class="function">notify_notification_show()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification to update.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>summary</code></em> :</span></td>
<td> The new required summary text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>body</code></em> :</span></td>
<td> The optional body text.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon</code></em> :</span></td>
<td> The optional icon theme icon name or filename.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">TRUE</code>, unless an invalid parameter was passed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563485"></a><h3>
<a name="notify-notification-attach-to-widget"></a>notify_notification_attach_to_widget ()</h3>
<a class="indexterm" name="id2563498"></a><pre class="programlisting">void notify_notification_attach_to_widget
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GtkWidget *attach);</pre>
<p>
Attaches the notification to a widget. This will set hints on the
notification requesting that the notification point to the widget's
location. If <em class="parameter"><code>attach</code></em> is <code class="literal">NULL</code>, the widget will be unset.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>attach</code></em> :</span></td>
<td> The widget to attach to, or <code class="literal">NULL</code>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563587"></a><h3>
<a name="notify-notification-attach-to-status-icon"></a>notify_notification_attach_to_status_icon ()</h3>
<a class="indexterm" name="id2563603"></a><pre class="programlisting">void notify_notification_attach_to_status_icon
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GtkStatusIcon *status_icon);</pre>
<p>
Attaches the notification to a <span class="type">GtkStatusIcon</span>. This will set hints on the
notification requesting that the notification point to the status icon's
location. If <em class="parameter"><code>status_icon</code></em> is <code class="literal">NULL</code>, the status icon will be unset.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>status_icon</code></em> :</span></td>
<td> The <span class="type">GtkStatusIcon</span> to attach to, or <code class="literal">NULL</code>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 0.4.1
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563708"></a><h3>
<a name="notify-notification-set-geometry-hints"></a>notify_notification_set_geometry_hints ()</h3>
<a class="indexterm" name="id2563723"></a><pre class="programlisting">void notify_notification_set_geometry_hints
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GdkScreen *screen,
gint x,
gint y);</pre>
<p>
Sets the geometry hints on the notification. This sets the screen
the notification should appear on and the X, Y coordinates it should
point to, if the particular notification supports X, Y hints.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> The <span class="type">GdkScreen</span> the notification should appear on.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>x</code></em> :</span></td>
<td> The X coordinate to point to.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y</code></em> :</span></td>
<td> The Y coordinate to point to.
</td>
</tr>
</tbody>
</table></div>
<p>Since 0.4.1
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563841"></a><h3>
<a name="notify-notification-show"></a>notify_notification_show ()</h3>
<a class="indexterm" name="id2563852"></a><pre class="programlisting">gboolean notify_notification_show (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GError **error);</pre>
<p>
Tells the notification server to display the notification on the screen.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> The returned error information.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">TRUE</code> if successful. On error, this will return <code class="literal">FALSE</code> and set
<em class="parameter"><code>error</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2563949"></a><h3>
<a name="notify-notification-set-timeout"></a>notify_notification_set_timeout ()</h3>
<a class="indexterm" name="id2563961"></a><pre class="programlisting">void notify_notification_set_timeout (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
gint timeout);</pre>
<p>
Sets the timeout of the notification. To set the default time, pass
<a href="NotifyNotification.html#NOTIFY-EXPIRES-DEFAULT:CAPS"><code class="literal">NOTIFY_EXPIRES_DEFAULT</code></a> as <em class="parameter"><code>timeout</code></em>. To set the notification to never
expire, pass <a href="NotifyNotification.html#NOTIFY-EXPIRES-NEVER:CAPS"><code class="literal">NOTIFY_EXPIRES_NEVER</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>timeout</code></em> :</span></td>
<td> The timeout in milliseconds.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564049"></a><h3>
<a name="notify-notification-set-category"></a>notify_notification_set_category ()</h3>
<a class="indexterm" name="id2564062"></a><pre class="programlisting">void notify_notification_set_category
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const char *category);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> The category.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564128"></a><h3>
<a name="notify-notification-set-urgency"></a>notify_notification_set_urgency ()</h3>
<a class="indexterm" name="id2564141"></a><pre class="programlisting">void notify_notification_set_urgency (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
<a href="NotifyNotification.html#NotifyUrgency">NotifyUrgency</a> urgency);</pre>
<p>
Sets the urgency level of this notification.
</p>
<p>
See: <a href="NotifyNotification.html#NotifyUrgency"><span class="type">NotifyUrgency</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>urgency</code></em> :</span></td>
<td> The urgency level.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564214"></a><h3>
<a name="notify-notification-set-icon-from-pixbuf"></a>notify_notification_set_icon_from_pixbuf ()</h3>
<a class="indexterm" name="id2564226"></a><pre class="programlisting">void notify_notification_set_icon_from_pixbuf
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GdkPixbuf *icon);</pre>
<p>
Sets the icon in the notification from a <span class="type">GdkPixbuf</span>.
</p>
<p>
This will only work when libnotify is compiled against D-BUS 0.60 or
higher.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon</code></em> :</span></td>
<td> The icon.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564303"></a><h3>
<a name="notify-notification-set-hint-int32"></a>notify_notification_set_hint_int32 ()</h3>
<a class="indexterm" name="id2564316"></a><pre class="programlisting">void notify_notification_set_hint_int32
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
gint value);</pre>
<p>
Sets a hint with a 32-bit integer value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td> The hint.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td> The hint's value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564399"></a><h3>
<a name="notify-notification-set-hint-double"></a>notify_notification_set_hint_double ()</h3>
<a class="indexterm" name="id2564412"></a><pre class="programlisting">void notify_notification_set_hint_double
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
gdouble value);</pre>
<p>
Sets a hint with a double value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td> The hint.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td> The hint's value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564496"></a><h3>
<a name="notify-notification-set-hint-string"></a>notify_notification_set_hint_string ()</h3>
<a class="indexterm" name="id2564509"></a><pre class="programlisting">void notify_notification_set_hint_string
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
const gchar *value);</pre>
<p>
Sets a hint with a string value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td> The hint.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td> The hint's value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564592"></a><h3>
<a name="notify-notification-set-hint-byte"></a>notify_notification_set_hint_byte ()</h3>
<a class="indexterm" name="id2564605"></a><pre class="programlisting">void notify_notification_set_hint_byte
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
guchar value);</pre>
<p>
Sets a hint with a byte value.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td> The hint.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td> The hint's value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564688"></a><h3>
<a name="notify-notification-set-hint-byte-array"></a>notify_notification_set_hint_byte_array ()</h3>
<a class="indexterm" name="id2564701"></a><pre class="programlisting">void notify_notification_set_hint_byte_array
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const gchar *key,
const guchar *value,
gsize len);</pre>
<p>
Sets a hint with a byte array value. The length of <em class="parameter"><code>value</code></em> must be passed
as <em class="parameter"><code>len</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td> The hint.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td> The hint's value.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>len</code></em> :</span></td>
<td> The length of the byte array.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564816"></a><h3>
<a name="notify-notification-clear-hints"></a>notify_notification_clear_hints ()</h3>
<a class="indexterm" name="id2564828"></a><pre class="programlisting">void notify_notification_clear_hints (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification);</pre>
<p>
Clears all hints from the notification.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564873"></a><h3>
<a name="notify-notification-add-action"></a>notify_notification_add_action ()</h3>
<a class="indexterm" name="id2564886"></a><pre class="programlisting">void notify_notification_add_action (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
const char *action,
const char *label,
<a href="NotifyNotification.html#NotifyActionCallback">NotifyActionCallback</a> callback,
gpointer user_data,
GFreeFunc free_func);</pre>
<p>
Adds an action to a notification. When the action is invoked, the
specified callback function will be called, along with the value passed
to <em class="parameter"><code>user_data</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>action</code></em> :</span></td>
<td> The action ID.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> The human-readable action label.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>callback</code></em> :</span></td>
<td> The action's callback function.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td> Optional custom data to pass to <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>free_func</code></em> :</span></td>
<td> An optional function to free <em class="parameter"><code>user_data</code></em> when the notification
is destroyed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565047"></a><h3>
<a name="notify-notification-clear-actions"></a>notify_notification_clear_actions ()</h3>
<a class="indexterm" name="id2565060"></a><pre class="programlisting">void notify_notification_clear_actions
(<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification);</pre>
<p>
Clears all actions from the notification.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565105"></a><h3>
<a name="notify-notification-close"></a>notify_notification_close ()</h3>
<a class="indexterm" name="id2565116"></a><pre class="programlisting">gboolean notify_notification_close (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
GError **error);</pre>
<p>
Tells the notification server to hide the notification on the screen.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The notification.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> The returned error information.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">TRUE</code> if successful. On error, this will return <code class="literal">FALSE</code> and set
<em class="parameter"><code>error</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="property_details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2565224"></a><h3>
<a name="NotifyNotification--attach-widget"></a>The "<code class="literal">attach-widget</code>" property</h3>
<a class="indexterm" name="id2565238"></a><pre class="programlisting"> "attach-widget" GtkWidget : Read / Write / Construct</pre>
<p>The widget to attach the notification to.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565259"></a><h3>
<a name="NotifyNotification--body"></a>The "<code class="literal">body</code>" property</h3>
<a class="indexterm" name="id2565271"></a><pre class="programlisting"> "body" gchararray : Read / Write / Construct</pre>
<p>The message body text.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565294"></a><h3>
<a name="NotifyNotification--icon-name"></a>The "<code class="literal">icon-name</code>" property</h3>
<a class="indexterm" name="id2565308"></a><pre class="programlisting"> "icon-name" gchararray : Read / Write / Construct</pre>
<p>The icon filename or icon theme-compliant name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565332"></a><h3>
<a name="NotifyNotification--summary"></a>The "<code class="literal">summary</code>" property</h3>
<a class="indexterm" name="id2565345"></a><pre class="programlisting"> "summary" gchararray : Read / Write / Construct</pre>
<p>The summary text.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="signals"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2565380"></a><h3>
<a name="NotifyNotification-closed"></a>The "closed" signal</h3>
<a class="indexterm" name="id2565390"></a><pre class="programlisting">void user_function (<a href="NotifyNotification.html" title="NotifyNotification">NotifyNotification</a> *notification,
gpointer user_data) : Run first</pre>
<p>
Emitted when the notification is closed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>notification</code></em> :</span></td>
<td> The object which received the signal.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>