← Back to branch summary

~ubuntu-branches/ubuntu/utopic/glib2.0/utopic

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/gio-GNotification.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-10-02 13:08:24 UTC
  • mfrom: (1.67.13)
  • mto: This revision was merged to the branch mainline in revision 233.
  • Revision ID: package-import@ubuntu.com-20141002130824-cqp99rbif2g6wf6r
Tags: upstream-2.42.0
Import upstream version 2.42.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gio/html/gio-GNotification.html
173
173
<div class="refsect2">
174
174
<a name="g-notification-new"></a><h3>g_notification_new ()</h3>
175
175
<pre class="programlisting"><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="returnvalue">GNotification</span></a> *
176
 
g_notification_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre>
 
176
g_notification_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre>
177
177
<p>Creates a new <a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> with <em class="parameter"><code>title</code></em>
178
178
 as its title.</p>
179
179
<p>After populating <em class="parameter"><code>notification</code></em>
209
209
<a name="g-notification-set-title"></a><h3>g_notification_set_title ()</h3>
210
210
<pre class="programlisting"><span class="returnvalue">void</span>
211
211
g_notification_set_title (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
212
 
                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre>
 
212
                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre>
213
213
<p>Sets the title of <em class="parameter"><code>notification</code></em>
214
214
 to <em class="parameter"><code>title</code></em>
215
215
.</p>
243
243
<a name="g-notification-set-body"></a><h3>g_notification_set_body ()</h3>
244
244
<pre class="programlisting"><span class="returnvalue">void</span>
245
245
g_notification_set_body (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
246
 
                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *body</code></em>);</pre>
 
246
                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *body</code></em>);</pre>
247
247
<p>Sets the body of <em class="parameter"><code>notification</code></em>
248
248
 to <em class="parameter"><code>body</code></em>
249
249
.</p>
264
264
<tr>
265
265
<td class="parameter_name"><p>body</p></td>
266
266
<td class="parameter_description"><p> the new body for <em class="parameter"><code>notification</code></em>
267
 
, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
267
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
268
268
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
269
269
</tr>
270
270
</tbody>
311
311
<a name="g-notification-set-urgent"></a><h3>g_notification_set_urgent ()</h3>
312
312
<pre class="programlisting"><span class="returnvalue">void</span>
313
313
g_notification_set_urgent (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
314
 
                           <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> urgent</code></em>);</pre>
 
314
                           <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> urgent</code></em>);</pre>
315
315
<div class="warning"><p><code class="literal">g_notification_set_urgent</code> is deprecated and should not be used in newly-written code.</p></div>
316
316
<p>Deprecated in favor of <code class="function">g_notification_set_priority()</code>.</p>
317
317
<div class="refsect3">
330
330
</tr>
331
331
<tr>
332
332
<td class="parameter_name"><p>urgent</p></td>
333
 
<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>notification</code></em>
 
333
<td class="parameter_description"><p><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>notification</code></em>
334
334
is urgent</p></td>
335
335
<td class="parameter_annotations"> </td>
336
336
</tr>
344
344
<a name="g-notification-set-default-action"></a><h3>g_notification_set_default_action ()</h3>
345
345
<pre class="programlisting"><span class="returnvalue">void</span>
346
346
g_notification_set_default_action (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
347
 
                                   <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *detailed_action</code></em>);</pre>
 
347
                                   <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *detailed_action</code></em>);</pre>
348
348
<p>Sets the default action of <em class="parameter"><code>notification</code></em>
349
349
 to <em class="parameter"><code>detailed_action</code></em>
350
350
. This
389
389
<pre class="programlisting"><span class="returnvalue">void</span>
390
390
g_notification_set_default_action_and_target
391
391
                               (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
392
 
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
393
 
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_format</code></em>,
 
392
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
 
393
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_format</code></em>,
394
394
                                <em class="parameter"><code>...</code></em>);</pre>
395
395
<p>Sets the default action of <em class="parameter"><code>notification</code></em>
396
396
 to <em class="parameter"><code>action</code></em>
399
399
application-wide action (it must start with "app.").</p>
400
400
<p>If <em class="parameter"><code>target_format</code></em>
401
401
 is given, it is used to collect remaining
402
 
positional parameters into a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> instance, similar to
403
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>. <em class="parameter"><code>action</code></em>
404
 
 will be activated with that <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> as its
 
402
positional parameters into a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> instance, similar to
 
403
<a href="../glib/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>. <em class="parameter"><code>action</code></em>
 
404
 will be activated with that <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> as its
405
405
parameter.</p>
406
406
<p>When no default action is set, the application that the notification
407
407
was sent on is activated.</p>
426
426
</tr>
427
427
<tr>
428
428
<td class="parameter_name"><p>target_format</p></td>
429
 
<td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> format string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
429
<td class="parameter_description"><p> a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> format string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
430
430
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
431
431
</tr>
432
432
<tr>
446
446
<pre class="programlisting"><span class="returnvalue">void</span>
447
447
g_notification_set_default_action_and_target_value
448
448
                               (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
449
 
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
450
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *target</code></em>);</pre>
 
449
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
 
450
                                <em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *target</code></em>);</pre>
451
451
<p>Sets the default action of <em class="parameter"><code>notification</code></em>
452
452
 to <em class="parameter"><code>action</code></em>
453
453
. This action is
454
454
activated when the notification is clicked on. It must be an
455
455
application-wide action (start with "app.").</p>
456
456
<p>If <em class="parameter"><code>target</code></em>
457
 
 is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>action</code></em>
 
457
 is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>action</code></em>
458
458
 will be activated with <em class="parameter"><code>target</code></em>
459
459
 as
460
460
its parameter.</p>
481
481
</tr>
482
482
<tr>
483
483
<td class="parameter_name"><p>target</p></td>
484
 
<td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to use as <em class="parameter"><code>action</code></em>
485
 
's parameter, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
484
<td class="parameter_description"><p> a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to use as <em class="parameter"><code>action</code></em>
 
485
's parameter, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
486
486
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
487
487
</tr>
488
488
</tbody>
495
495
<a name="g-notification-add-button"></a><h3>g_notification_add_button ()</h3>
496
496
<pre class="programlisting"><span class="returnvalue">void</span>
497
497
g_notification_add_button (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
498
 
                           <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
499
 
                           <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *detailed_action</code></em>);</pre>
 
498
                           <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
499
                           <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *detailed_action</code></em>);</pre>
500
500
<p>Adds a button to <em class="parameter"><code>notification</code></em>
501
501
 that activates the action in
502
502
<em class="parameter"><code>detailed_action</code></em>
542
542
<a name="g-notification-add-button-with-target"></a><h3>g_notification_add_button_with_target ()</h3>
543
543
<pre class="programlisting"><span class="returnvalue">void</span>
544
544
g_notification_add_button_with_target (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
545
 
                                       <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
546
 
                                       <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
547
 
                                       <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_format</code></em>,
 
545
                                       <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
546
                                       <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
 
547
                                       <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *target_format</code></em>,
548
548
                                       <em class="parameter"><code>...</code></em>);</pre>
549
549
<p>Adds a button to <em class="parameter"><code>notification</code></em>
550
550
 that activates <em class="parameter"><code>action</code></em>
553
553
 must be an application-wide action (it must start with "app.").</p>
554
554
<p>If <em class="parameter"><code>target_format</code></em>
555
555
 is given, it is used to collect remaining
556
 
positional parameters into a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> instance, similar to
557
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>. <em class="parameter"><code>action</code></em>
558
 
 will be activated with that <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> as its
 
556
positional parameters into a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> instance, similar to
 
557
<a href="../glib/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>. <em class="parameter"><code>action</code></em>
 
558
 will be activated with that <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> as its
559
559
parameter.</p>
560
560
<div class="refsect3">
561
561
<a name="id-1.4.22.17.7.11.6"></a><h4>Parameters</h4>
583
583
</tr>
584
584
<tr>
585
585
<td class="parameter_name"><p>target_format</p></td>
586
 
<td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> format string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
586
<td class="parameter_description"><p> a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> format string, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
587
587
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
588
588
</tr>
589
589
<tr>
603
603
<pre class="programlisting"><span class="returnvalue">void</span>
604
604
g_notification_add_button_with_target_value
605
605
                               (<em class="parameter"><code><a class="link" href="gio-GNotification.html#GNotification" title="GNotification"><span class="type">GNotification</span></a> *notification</code></em>,
606
 
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
607
 
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
608
 
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *target</code></em>);</pre>
 
606
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
607
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *action</code></em>,
 
608
                                <em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *target</code></em>);</pre>
609
609
<p>Adds a button to <em class="parameter"><code>notification</code></em>
610
610
 that activates <em class="parameter"><code>action</code></em>
611
611
 when clicked.
612
612
<em class="parameter"><code>action</code></em>
613
613
 must be an application-wide action (it must start with "app.").</p>
614
614
<p>If <em class="parameter"><code>target</code></em>
615
 
 is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>action</code></em>
 
615
 is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>action</code></em>
616
616
 will be activated with <em class="parameter"><code>target</code></em>
617
617
 as
618
618
its parameter.</p>
642
642
</tr>
643
643
<tr>
644
644
<td class="parameter_name"><p>target</p></td>
645
 
<td class="parameter_description"><p> a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to use as <em class="parameter"><code>action</code></em>
646
 
's parameter, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
645
<td class="parameter_description"><p> a <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to use as <em class="parameter"><code>action</code></em>
 
646
's parameter, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
647
647
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
648
648
</tr>
649
649
</tbody>