/usr/share/gtk-doc/html/libnotify/NotifyNotification.html is in libnotify-doc 0.7.6-1ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NotifyNotification</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libnotify Reference Manual">
<link rel="up" href="ch01.html" title="Libnotify">
<link rel="prev" href="libnotify-notify.html" title="notify">
<link rel="next" href="api-index-full.html" title="Index">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#NotifyNotification.synopsis" class="shortcut">Top</a>
|
<a href="#NotifyNotification.description" class="shortcut">Description</a>
|
<a href="#NotifyNotification.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#NotifyNotification.properties" class="shortcut">Properties</a>
|
<a href="#NotifyNotification.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="NotifyNotification"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NotifyNotification.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="NotifyNotification.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="NotifyNotification.html#NOTIFY-EXPIRES-DEFAULT:CAPS" title="NOTIFY_EXPIRES_DEFAULT">NOTIFY_EXPIRES_DEFAULT</a>
#define <a class="link" href="NotifyNotification.html#NOTIFY-EXPIRES-NEVER:CAPS" title="NOTIFY_EXPIRES_NEVER">NOTIFY_EXPIRES_NEVER</a>
struct <a class="link" href="NotifyNotification.html#NotifyNotification-struct" title="struct NotifyNotification">NotifyNotification</a>;
enum <a class="link" href="NotifyNotification.html#NotifyUrgency" title="enum NotifyUrgency">NotifyUrgency</a>;
<span class="returnvalue">void</span> (<a class="link" href="NotifyNotification.html#NotifyActionCallback" title="NotifyActionCallback ()">*NotifyActionCallback</a>) (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><span class="type">char</span> *action</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
#define <a class="link" href="NotifyNotification.html#NOTIFY-ACTION-CALLBACK:CAPS" title="NOTIFY_ACTION_CALLBACK()">NOTIFY_ACTION_CALLBACK</a> (func)
<a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="returnvalue">NotifyNotification</span></a> * <a class="link" href="NotifyNotification.html#notify-notification-new" title="notify_notification_new ()">notify_notification_new</a> (<em class="parameter"><code>const <span class="type">char</span> *summary</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *body</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *icon</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NotifyNotification.html#notify-notification-update" title="notify_notification_update ()">notify_notification_update</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *summary</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *body</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *icon</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NotifyNotification.html#notify-notification-show" title="notify_notification_show ()">notify_notification_show</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-app-name" title="notify_notification_set_app_name ()">notify_notification_set_app_name</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-timeout" title="notify_notification_set_timeout ()">notify_notification_set_timeout</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-category" title="notify_notification_set_category ()">notify_notification_set_category</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *category</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-urgency" title="notify_notification_set_urgency ()">notify_notification_set_urgency</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a class="link" href="NotifyNotification.html#NotifyUrgency" title="enum NotifyUrgency"><span class="type">NotifyUrgency</span></a> urgency</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-icon-from-pixbuf" title="notify_notification_set_icon_from_pixbuf ()">notify_notification_set_icon_from_pixbuf</a>
(<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-image-from-pixbuf" title="notify_notification_set_image_from_pixbuf ()">notify_notification_set_image_from_pixbuf</a>
(<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()">notify_notification_set_hint</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint-int32" title="notify_notification_set_hint_int32 ()">notify_notification_set_hint_int32</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint-uint32" title="notify_notification_set_hint_uint32 ()">notify_notification_set_hint_uint32</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint-double" title="notify_notification_set_hint_double ()">notify_notification_set_hint_double</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint-string" title="notify_notification_set_hint_string ()">notify_notification_set_hint_string</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint-byte" title="notify_notification_set_hint_byte ()">notify_notification_set_hint_byte</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-set-hint-byte-array" title="notify_notification_set_hint_byte_array ()">notify_notification_set_hint_byte_array</a>
(<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> len</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-clear-hints" title="notify_notification_clear_hints ()">notify_notification_clear_hints</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-add-action" title="notify_notification_add_action ()">notify_notification_add_action</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *action</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *label</code></em>,
<em class="parameter"><code><a class="link" href="NotifyNotification.html#NotifyActionCallback" title="NotifyActionCallback ()"><span class="type">NotifyActionCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#GFreeFunc"><span class="type">GFreeFunc</span></a> free_func</code></em>);
<span class="returnvalue">void</span> <a class="link" href="NotifyNotification.html#notify-notification-clear-actions" title="notify_notification_clear_actions ()">notify_notification_clear_actions</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NotifyNotification.html#notify-notification-close" title="notify_notification_close ()">notify_notification_close</a> (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="NotifyNotification.html#notify-notification-get-closed-reason" title="notify_notification_get_closed_reason ()">notify_notification_get_closed_reason</a>
(<em class="parameter"><code>const <a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="NotifyNotification.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----NotifyNotification
</pre>
</div>
<div class="refsect1">
<a name="NotifyNotification.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="NotifyNotification.html#NotifyNotification--app-name" title='The "app-name" property'>app-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="NotifyNotification.html#NotifyNotification--body" title='The "body" property'>body</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct
"<a class="link" href="NotifyNotification.html#NotifyNotification--closed-reason" title='The "closed-reason" property'>closed-reason</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read
"<a class="link" href="NotifyNotification.html#NotifyNotification--icon-name" title='The "icon-name" property'>icon-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct
"<a class="link" href="NotifyNotification.html#NotifyNotification--id" title='The "id" property'>id</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct
"<a class="link" href="NotifyNotification.html#NotifyNotification--summary" title='The "summary" property'>summary</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="NotifyNotification.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="NotifyNotification.html#NotifyNotification-closed" title='The "closed" signal'>closed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="NotifyNotification.description"></a><h2>Description</h2>
<p>
<a class="link" 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">
<a name="NotifyNotification.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NOTIFY-EXPIRES-DEFAULT:CAPS"></a><h3>NOTIFY_EXPIRES_DEFAULT</h3>
<pre class="programlisting">#define NOTIFY_EXPIRES_DEFAULT -1
</pre>
<p>
The default expiration time on a notification.
</p>
</div>
<hr>
<div class="refsect2">
<a name="NOTIFY-EXPIRES-NEVER:CAPS"></a><h3>NOTIFY_EXPIRES_NEVER</h3>
<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">
<a name="NotifyNotification-struct"></a><h3>struct NotifyNotification</h3>
<pre class="programlisting">struct NotifyNotification;</pre>
</div>
<hr>
<div class="refsect2">
<a name="NotifyUrgency"></a><h3>enum NotifyUrgency</h3>
<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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="NOTIFY-URGENCY-LOW:CAPS"></a><span class="term"><code class="literal">NOTIFY_URGENCY_LOW</code></span></p></td>
<td>Low urgency. Used for unimportant notifications.
</td>
</tr>
<tr>
<td><p><a name="NOTIFY-URGENCY-NORMAL:CAPS"></a><span class="term"><code class="literal">NOTIFY_URGENCY_NORMAL</code></span></p></td>
<td>Normal urgency. Used for most standard notifications.
</td>
</tr>
<tr>
<td><p><a name="NOTIFY-URGENCY-CRITICAL:CAPS"></a><span class="term"><code class="literal">NOTIFY_URGENCY_CRITICAL</code></span></p></td>
<td>Critical urgency. Used for very important notifications.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="NotifyActionCallback"></a><h3>NotifyActionCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*NotifyActionCallback) (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><span class="type">char</span> *action</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
An action callback function.
</p>
</div>
<hr>
<div class="refsect2">
<a name="NOTIFY-ACTION-CALLBACK:CAPS"></a><h3>NOTIFY_ACTION_CALLBACK()</h3>
<pre class="programlisting">#define NOTIFY_ACTION_CALLBACK(func) ((NotifyActionCallback)(func))
</pre>
<p>
A convenience macro for casting a function to a <a class="link" href="NotifyNotification.html#NotifyActionCallback" title="NotifyActionCallback ()"><span class="type">NotifyActionCallback</span></a>. This
is much like <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#G-CALLBACK:CAPS"><code class="function">G_CALLBACK()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>The function to cast.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-new"></a><h3>notify_notification_new ()</h3>
<pre class="programlisting"><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="returnvalue">NotifyNotification</span></a> * notify_notification_new (<em class="parameter"><code>const <span class="type">char</span> *summary</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *body</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *icon</code></em>);</pre>
<p>
Creates a new <a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>. The summary text is required, but
all other parameters are optional.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>The required summary text.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>body</code></em> :</span></p></td>
<td>The optional body text. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>The optional icon theme icon name or filename. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The new <a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-update"></a><h3>notify_notification_update ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> notify_notification_update (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *summary</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *body</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *icon</code></em>);</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 class="link" href="NotifyNotification.html#notify-notification-show" title="notify_notification_show ()"><code class="function">notify_notification_show()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification to update.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>summary</code></em> :</span></p></td>
<td>The new required summary text.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>body</code></em> :</span></p></td>
<td>The optional body text. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>The optional icon theme icon name or filename. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, unless an invalid parameter was passed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-show"></a><h3>notify_notification_show ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> notify_notification_show (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Tells the notification server to display the notification on the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>The returned error information.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful. On error, this will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set
<em class="parameter"><code>error</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-app-name"></a><h3>notify_notification_set_app_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_app_name (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *app_name</code></em>);</pre>
<p>
Sets the application name for the notification. If this function is
not called or if <em class="parameter"><code>app_name</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the application name will be
set from the value used in <a class="link" href="libnotify-notify.html#notify-init" title="notify_init ()"><code class="function">notify_init()</code></a> or overridden with
<a class="link" href="libnotify-notify.html#notify-set-app-name" title="notify_set_app_name ()"><code class="function">notify_set_app_name()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>a <a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>app_name</code></em> :</span></p></td>
<td>the localised application name</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.7.3</p>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-timeout"></a><h3>notify_notification_set_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_timeout (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timeout</code></em>);</pre>
<p>
Sets the timeout of the notification. To set the default time, pass
<a class="link" href="NotifyNotification.html#NOTIFY-EXPIRES-DEFAULT:CAPS" title="NOTIFY_EXPIRES_DEFAULT"><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 class="link" href="NotifyNotification.html#NOTIFY-EXPIRES-NEVER:CAPS" title="NOTIFY_EXPIRES_NEVER"><code class="literal">NOTIFY_EXPIRES_NEVER</code></a>.
</p>
<p>
Note that the timeout may be ignored by the server.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timeout</code></em> :</span></p></td>
<td>The timeout in milliseconds.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-category"></a><h3>notify_notification_set_category ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_category (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *category</code></em>);</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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
<td>The category.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-urgency"></a><h3>notify_notification_set_urgency ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_urgency (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a class="link" href="NotifyNotification.html#NotifyUrgency" title="enum NotifyUrgency"><span class="type">NotifyUrgency</span></a> urgency</code></em>);</pre>
<p>
Sets the urgency level of this notification.
</p>
<p>
See: <a class="link" href="NotifyNotification.html#NotifyUrgency" title="enum NotifyUrgency"><span class="type">NotifyUrgency</span></a>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>urgency</code></em> :</span></p></td>
<td>The urgency level.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-icon-from-pixbuf"></a><h3>notify_notification_set_icon_from_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_icon_from_pixbuf
(<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_icon_from_pixbuf</code> is deprecated and should not be used in newly-written code. use <a class="link" href="NotifyNotification.html#notify-notification-set-image-from-pixbuf" title="notify_notification_set_image_from_pixbuf ()"><code class="function">notify_notification_set_image_from_pixbuf()</code></a> instead.</p>
</div>
<p>
Sets the icon in the notification from a <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>The icon.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-image-from-pixbuf"></a><h3>notify_notification_set_image_from_pixbuf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_image_from_pixbuf
(<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre>
<p>
Sets the image in the notification from a <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>The image.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint"></a><h3>notify_notification_set_hint ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
<p>
Sets a hint for <em class="parameter"><code>key</code></em> with value <em class="parameter"><code>value</code></em>. If <em class="parameter"><code>value</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
a previously set hint for <em class="parameter"><code>key</code></em> is unset.
</p>
<p>
If <em class="parameter"><code>value</code></em> is floating, it is consumed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>a <a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the hint key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the hint value, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the hint. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint-int32"></a><h3>notify_notification_set_hint_int32 ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint_int32 (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_hint_int32</code> is deprecated and should not be used in newly-written code. 0.6. Use <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()"><code class="function">notify_notification_set_hint()</code></a> instead</p>
</div>
<p>
Sets a hint with a 32-bit integer value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The hint.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The hint's value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint-uint32"></a><h3>notify_notification_set_hint_uint32 ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint_uint32 (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_hint_uint32</code> is deprecated and should not be used in newly-written code. 0.6. Use <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()"><code class="function">notify_notification_set_hint()</code></a> instead</p>
</div>
<p>
Sets a hint with an unsigned 32-bit integer value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The hint.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The hint's value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint-double"></a><h3>notify_notification_set_hint_double ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint_double (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_hint_double</code> is deprecated and should not be used in newly-written code. 0.6. Use <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()"><code class="function">notify_notification_set_hint()</code></a> instead</p>
</div>
<p>
Sets a hint with a double value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The hint.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The hint's value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint-string"></a><h3>notify_notification_set_hint_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint_string (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_hint_string</code> is deprecated and should not be used in newly-written code. 0.6. Use <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()"><code class="function">notify_notification_set_hint()</code></a> instead</p>
</div>
<p>
Sets a hint with a string value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The hint.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The hint's value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint-byte"></a><h3>notify_notification_set_hint_byte ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint_byte (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> value</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_hint_byte</code> is deprecated and should not be used in newly-written code. 0.6. Use <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()"><code class="function">notify_notification_set_hint()</code></a> instead</p>
</div>
<p>
Sets a hint with a byte value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The hint.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The hint's value.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-set-hint-byte-array"></a><h3>notify_notification_set_hint_byte_array ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_set_hint_byte_array
(<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *value</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> len</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">notify_notification_set_hint_byte_array</code> is deprecated and should not be used in newly-written code. 0.6. Use <a class="link" href="NotifyNotification.html#notify-notification-set-hint" title="notify_notification_set_hint ()"><code class="function">notify_notification_set_hint()</code></a> instead</p>
</div>
<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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The hint.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The hint's value.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>The length of the byte array.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-clear-hints"></a><h3>notify_notification_clear_hints ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_clear_hints (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>);</pre>
<p>
Clears all hints from the notification.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-add-action"></a><h3>notify_notification_add_action ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_add_action (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *action</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *label</code></em>,
<em class="parameter"><code><a class="link" href="NotifyNotification.html#NotifyActionCallback" title="NotifyActionCallback ()"><span class="type">NotifyActionCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#GFreeFunc"><span class="type">GFreeFunc</span></a> free_func</code></em>);</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>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>The action ID.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>The human-readable action label.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>The action's callback function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Optional custom data to pass to <em class="parameter"><code>callback</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>free_func</code></em> :</span></p></td>
<td>An optional function to free <em class="parameter"><code>user_data</code></em> when the notification
is destroyed. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GLib.DestroyNotify]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-clear-actions"></a><h3>notify_notification_clear_actions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> notify_notification_clear_actions (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>);</pre>
<p>
Clears all actions from the notification.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-close"></a><h3>notify_notification_close ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> notify_notification_close (<em class="parameter"><code><a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Synchronously tells the notification server to hide the notification on the screen.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>The returned error information.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error with <em class="parameter"><code>error</code></em> filled in</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="notify-notification-get-closed-reason"></a><h3>notify_notification_get_closed_reason ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> notify_notification_get_closed_reason
(<em class="parameter"><code>const <a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification</code></em>);</pre>
<p>
Returns the closed reason code for the notification. This is valid only
after the "closed" signal is emitted.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The notification.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The closed reason code.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="NotifyNotification.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="NotifyNotification--app-name"></a><h3>The <code class="literal">"app-name"</code> property</h3>
<pre class="programlisting"> "app-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>The application name to use for this notification.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NotifyNotification--body"></a><h3>The <code class="literal">"body"</code> property</h3>
<pre class="programlisting"> "body" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre>
<p>The message body text.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NotifyNotification--closed-reason"></a><h3>The <code class="literal">"closed-reason"</code> property</h3>
<pre class="programlisting"> "closed-reason" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre>
<p>The reason code for why the notification was closed.</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="NotifyNotification--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
<pre class="programlisting"> "icon-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre>
<p>The icon filename or icon theme-compliant name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="NotifyNotification--id"></a><h3>The <code class="literal">"id"</code> property</h3>
<pre class="programlisting"> "id" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre>
<p>The notification ID.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="NotifyNotification--summary"></a><h3>The <code class="literal">"summary"</code> property</h3>
<pre class="programlisting"> "summary" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre>
<p>The summary text.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="NotifyNotification.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="NotifyNotification-closed"></a><h3>The <code class="literal">"closed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NotifyNotification.html" title="NotifyNotification"><span class="type">NotifyNotification</span></a> *notification,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Emitted when the notification is closed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>notification</code></em> :</span></p></td>
<td>The object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|