← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/libnotify/oneiric

« back to all changes in this revision

Viewing changes to docs/reference/html/libnotify-notify.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt, Laurent Bigonville, Martin Pitt
  • Date: 2011-09-02 11:37:34 UTC
  • mfrom: (1.1.14 upstream)
  • Revision ID: package-import@ubuntu.com-20110902113734-wys0vzvb1v4donai
Tags: 0.7.4-1
[ Laurent Bigonville ]
* Follow multi-arch specification
* debian/control.in:
  - Bump cdbs and debhelper build-dependencies
  - Add Multi-Arch and Pre-Depends fields
* debian/rules:
  - Pass multi-arch compatible path to libdir
* debian/*.install:
  - Adjust for multi-arch paths
  - Drop "debian/tmp" from paths
* debian/libnotify-dev.install:
  - Drop .la file, no other package is referencing it anymore

[ Martin Pitt ]
* New upstream bug fix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/libnotify-notify.html
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="libnotify-notify.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libnotify-notify.html#notify-init" title="notify_init ()">notify_init</a>                         (<em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);
 
40
<pre class="synopsis"><span class="returnvalue">gboolean</span>            <a class="link" href="libnotify-notify.html#notify-init" title="notify_init ()">notify_init</a>                         (<em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);
41
41
<span class="returnvalue">void</span>                <a class="link" href="libnotify-notify.html#notify-uninit" title="notify_uninit ()">notify_uninit</a>                       (<em class="parameter"><code><span class="type">void</span></code></em>);
42
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libnotify-notify.html#notify-is-initted" title="notify_is_initted ()">notify_is_initted</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
42
<span class="returnvalue">gboolean</span>            <a class="link" href="libnotify-notify.html#notify-is-initted" title="notify_is_initted ()">notify_is_initted</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
43
43
const <span class="returnvalue">char</span> *        <a class="link" href="libnotify-notify.html#notify-get-app-name" title="notify_get_app_name ()">notify_get_app_name</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
44
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="libnotify-notify.html#notify-get-server-caps" title="notify_get_server_caps ()">notify_get_server_caps</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
45
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libnotify-notify.html#notify-get-server-info" title="notify_get_server_info ()">notify_get_server_info</a>              (<em class="parameter"><code><span class="type">char</span> **ret_name</code></em>,
 
44
<span class="returnvalue">GList</span> *             <a class="link" href="libnotify-notify.html#notify-get-server-caps" title="notify_get_server_caps ()">notify_get_server_caps</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
 
45
<span class="returnvalue">gboolean</span>            <a class="link" href="libnotify-notify.html#notify-get-server-info" title="notify_get_server_info ()">notify_get_server_info</a>              (<em class="parameter"><code><span class="type">char</span> **ret_name</code></em>,
46
46
                                                         <em class="parameter"><code><span class="type">char</span> **ret_vendor</code></em>,
47
47
                                                         <em class="parameter"><code><span class="type">char</span> **ret_version</code></em>,
48
48
                                                         <em class="parameter"><code><span class="type">char</span> **ret_spec_version</code></em>);
55
55
<a name="libnotify-notify.details"></a><h2>Details</h2>
56
56
<div class="refsect2">
57
57
<a name="notify-init"></a><h3>notify_init ()</h3>
58
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            notify_init                         (<em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);</pre>
 
58
<pre class="programlisting"><span class="returnvalue">gboolean</span>            notify_init                         (<em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);</pre>
59
59
<p>
60
60
Initialized libnotify. This must be called before any other functions.
61
61
</p>
69
69
<tr>
70
70
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
71
71
<td>
72
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</td>
 
72
<code class="literal">TRUE</code> if successful, or <code class="literal">FALSE</code> on error.</td>
73
73
</tr>
74
74
</tbody>
75
75
</table></div>
89
89
<hr>
90
90
<div class="refsect2">
91
91
<a name="notify-is-initted"></a><h3>notify_is_initted ()</h3>
92
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            notify_is_initted                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
92
<pre class="programlisting"><span class="returnvalue">gboolean</span>            notify_is_initted                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
93
93
<p>
94
94
Gets whether or not libnotify is initialized.
95
95
</p>
98
98
<tbody><tr>
99
99
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
100
100
<td>
101
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if libnotify is initialized, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 
101
<code class="literal">TRUE</code> if libnotify is initialized, or <code class="literal">FALSE</code> otherwise.</td>
102
102
</tr></tbody>
103
103
</table></div>
104
104
</div>
120
120
<hr>
121
121
<div class="refsect2">
122
122
<a name="notify-get-server-caps"></a><h3>notify_get_server_caps ()</h3>
123
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             notify_get_server_caps              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
123
<pre class="programlisting"><span class="returnvalue">GList</span> *             notify_get_server_caps              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
124
124
<p>
125
 
Synchronously queries the server for its capabilities and returns them in a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a>.
 
125
Synchronously queries the server for its capabilities and returns them in a <span class="type">GList</span>.
126
126
</p>
127
127
<div class="variablelist"><table border="0">
128
128
<col align="left" valign="top">
129
129
<tbody><tr>
130
130
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
131
 
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of server capability strings. Free
132
 
the list elements with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> and the list itself with <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8]</span>
 
131
<td>a <span class="type">GList</span> of server capability strings. Free
 
132
the list elements with <code class="function">g_free()</code> and the list itself with <code class="function">g_list_free()</code>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8]</span>
133
133
</td>
134
134
</tr></tbody>
135
135
</table></div>
137
137
<hr>
138
138
<div class="refsect2">
139
139
<a name="notify-get-server-info"></a><h3>notify_get_server_info ()</h3>
140
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            notify_get_server_info              (<em class="parameter"><code><span class="type">char</span> **ret_name</code></em>,
 
140
<pre class="programlisting"><span class="returnvalue">gboolean</span>            notify_get_server_info              (<em class="parameter"><code><span class="type">char</span> **ret_name</code></em>,
141
141
                                                         <em class="parameter"><code><span class="type">char</span> **ret_vendor</code></em>,
142
142
                                                         <em class="parameter"><code><span class="type">char</span> **ret_version</code></em>,
143
143
                                                         <em class="parameter"><code><span class="type">char</span> **ret_spec_version</code></em>);</pre>
151
151
<tbody>
152
152
<tr>
153
153
<td><p><span class="term"><em class="parameter"><code>ret_name</code></em> :</span></p></td>
154
 
<td>a location to store the server name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
154
<td>a location to store the server name, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
155
155
</td>
156
156
</tr>
157
157
<tr>
158
158
<td><p><span class="term"><em class="parameter"><code>ret_vendor</code></em> :</span></p></td>
159
 
<td>a location to store the server vendor, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
159
<td>a location to store the server vendor, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
160
160
</td>
161
161
</tr>
162
162
<tr>
163
163
<td><p><span class="term"><em class="parameter"><code>ret_version</code></em> :</span></p></td>
164
 
<td>a location to store the server version, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
164
<td>a location to store the server version, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
165
165
</td>
166
166
</tr>
167
167
<tr>
168
168
<td><p><span class="term"><em class="parameter"><code>ret_spec_version</code></em> :</span></p></td>
169
 
<td>a location to store the version the service is compliant with, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
169
<td>a location to store the version the service is compliant with, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
170
170
</td>
171
171
</tr>
172
172
<tr>
173
173
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
174
174
<td>
175
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, and the variables passed will be set, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
175
<code class="literal">TRUE</code> if successful, and the variables passed will be set, <code class="literal">FALSE</code>
176
176
on error. The returned strings must be freed with g_free</td>
177
177
</tr>
178
178
</tbody>