/usr/share/gtk-doc/html/libindicate/IndicateServer.html is in libindicate-doc 0.6.92-4.
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 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IndicateServer: libindicate Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libindicate Reference Manual">
<link rel="up" href="base.html" title="Part I. Base Classes for Applications">
<link rel="prev" href="IndicateIndicator.html" title="IndicateIndicator">
<link rel="next" href="listeners.html" title="Part II. Classes for Listeners">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#IndicateServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#IndicateServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#IndicateServer.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#IndicateServer.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="base.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="IndicateIndicator.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="listeners.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="IndicateServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IndicateServer.top_of_page"></a>IndicateServer</span></h2>
<p>IndicateServer — The representation of the application on DBus.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IndicateServer.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="IndicateServer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-add-indicator" title="indicate_server_add_indicator ()">indicate_server_add_indicator</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-check-interest" title="indicate_server_check_interest ()">indicate_server_check_interest</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-get-next-id" title="indicate_server_get_next_id ()">indicate_server_get_next_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-hide" title="indicate_server_hide ()">indicate_server_hide</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="returnvalue">IndicateServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-ref-default" title="indicate_server_ref_default ()">indicate_server_ref_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-remove-indicator" title="indicate_server_remove_indicator ()">indicate_server_remove_indicator</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-set-default" title="indicate_server_set_default ()">indicate_server_set_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-set-desktop-file" title="indicate_server_set_desktop_file ()">indicate_server_set_desktop_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-set-type" title="indicate_server_set_type ()">indicate_server_set_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IndicateServer.html#indicate-server-show" title="indicate_server_show ()">indicate_server_show</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IndicateServer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="IndicateServer.html#IndicateServer--count" title="The “count” property">count</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IndicateServer.html#IndicateServer--desktop" title="The “desktop” property">desktop</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IndicateServer.html#IndicateServer--icon-theme" title="The “icon-theme” property">icon-theme</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IndicateServer.html#IndicateServer--menu" title="The “menu” property">menu</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IndicateServer.html#IndicateServer--path" title="The “path” property">path</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IndicateServer.html#IndicateServer--type" title="The “type” property">type</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IndicateServer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-indicator-delete" title="The “indicator-delete” signal">indicator-delete</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-indicator-modified" title="The “indicator-modified” signal">indicator-modified</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-indicator-new" title="The “indicator-new” signal">indicator-new</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-interest-added" title="The “interest-added” signal">interest-added</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-interest-removed" title="The “interest-removed” signal">interest-removed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-max-indicators-changed" title="The “max-indicators-changed” signal">max-indicators-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-server-count-changed" title="The “server-count-changed” signal">server-count-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-server-display" title="The “server-display” signal">server-display</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-server-hide" title="The “server-hide” signal">server-hide</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="IndicateServer.html#IndicateServer-server-show" title="The “server-show” signal">server-show</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IndicateServer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="IndicateServer.html#IndicateServer-struct" title="struct IndicateServer">IndicateServer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="IndicateServer.html#IndicateServerClass" title="struct IndicateServerClass">IndicateServerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IndicateServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> IndicateServer
</pre>
</div>
<div class="refsect1">
<a name="IndicateServer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libindicate/server.h>
</pre>
</div>
<div class="refsect1">
<a name="IndicateServer.description"></a><h2>Description</h2>
<p>The server object is the object that provides the functions on
to DBus for other applications to call. It does this by implementing
the DBus indicator spec, but it also allows for subclassing so that
subclasses don't have to worry about the DBus-isms as much as
the functionality that they're trying to express.</p>
<p> For simple applications there is limited need to set anything
more than the desktop file and the type of the server using
<a class="link" href="IndicateServer.html#indicate-server-set-desktop-file" title="indicate_server_set_desktop_file ()"><code class="function">indicate_server_set_desktop_file()</code></a> and <a class="link" href="IndicateServer.html#indicate-server-set-type" title="indicate_server_set_type ()"><code class="function">indicate_server_set_type()</code></a>.
Each of these function sets the respective value and expresses
it in a way that other applications on the bus can read it.</p>
<p> More advanced applications might find the need to subclass the
<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object and make their own. This is likely the
case where applications have complex data stores that they don't
want to turn into a large set of <span class="type">GObjects</span> that can take up a
significant amount of memory in the program.</p>
<p> In general, it is recommended that application authors go with
the high memory path first, and then optimize by implementing
their server on a second pass.</p>
</div>
<div class="refsect1">
<a name="IndicateServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="indicate-server-add-indicator"></a><h3>indicate_server_add_indicator ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_add_indicator (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="IndicateIndicator.html" title="IndicateIndicator"><span class="type">IndicateIndicator</span></a> *indicator</code></em>);</pre>
<p>This function adds an indicator <em class="parameter"><code>indicator</code></em>
to the list that are
watched by the server <em class="parameter"><code>server</code></em>
. This means that signals that are
emitted by the indicator will be picked up and passed via DBus onto
listeners of the application.</p>
<div class="refsect3">
<a name="indicate-server-add-indicator.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> to add the <span class="type">IndicateIndictor</span> to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>indicator</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateIndicator.html" title="IndicateIndicator"><span class="type">IndicateIndicator</span></a> to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-check-interest"></a><h3>indicate_server_check_interest ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
indicate_server_check_interest (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>,
<em class="parameter"><code><span class="type">IndicateInterests</span> interest</code></em>);</pre>
<p>This function looks at all the interest that various listeners
have specified that they have for this server and returns whether
there is a listener that has the interest specified in <em class="parameter"><code>interest</code></em>
.</p>
<div class="refsect3">
<a name="indicate-server-check-interest.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> being checked</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>interest</p></td>
<td class="parameter_description"><p>Which interest type we're checking for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="indicate-server-check-interest.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if a listener as the interest otherwise <code class="literal">FALSE</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-get-next-id"></a><h3>indicate_server_get_next_id ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
indicate_server_get_next_id (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>);</pre>
<p>Returns the next available unused ID that an indicator
can have.</p>
<div class="refsect3">
<a name="indicate-server-get-next-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> the ID will be on</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="indicate-server-get-next-id.returns"></a><h4>Returns</h4>
<p> A valid indicator ID.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-hide"></a><h3>indicate_server_hide ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_hide (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>);</pre>
<p>This function hides the server from DBus so that it does
not get signals anymore. This causes the signal <a class="link" href="IndicateServer.html#IndicateServer-server-hide" title="The “server-hide” signal"><span class="type">“server-hide”</span></a>
to be sent across the bus for all listeners. Also internally
it will signal <a class="link" href="IndicateServer.html#IndicateServer-interest-removed" title="The “interest-removed” signal"><span class="type">“interest-removed”</span></a> for all the
interests that were currently set for this server.</p>
<div class="refsect3">
<a name="indicate-server-hide.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> to hide.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-ref-default"></a><h3>indicate_server_ref_default ()</h3>
<pre class="programlisting"><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="returnvalue">IndicateServer</span></a> *
indicate_server_ref_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This function will return a reference to the default <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a>
reference if there is one, or it will create one if one had not
previously been created. It is recommended that all applications
use this function to create a <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> as it ensure that there
is only one per application.</p>
<div class="refsect3">
<a name="indicate-server-ref-default.returns"></a><h4>Returns</h4>
<p> A reference to the default <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> instance. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-remove-indicator"></a><h3>indicate_server_remove_indicator ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_remove_indicator (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>,
<em class="parameter"><code><a class="link" href="IndicateIndicator.html" title="IndicateIndicator"><span class="type">IndicateIndicator</span></a> *indicator</code></em>);</pre>
<p>Removes an indicator <em class="parameter"><code>indicator</code></em>
from being watched by the server <em class="parameter"><code>server</code></em>
so it's signals are no longer watched and set over DBus.</p>
<div class="refsect3">
<a name="indicate-server-remove-indicator.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> to remove the <span class="type">IndicateIndictor</span> from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>indicator</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateIndicator.html" title="IndicateIndicator"><span class="type">IndicateIndicator</span></a> to remove.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-set-default"></a><h3>indicate_server_set_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_set_default (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>);</pre>
<p>This function is used to set the default <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> that will
be used when creating <a href="IndicateIndicator.html#IndicateIndicator-struct"><span class="type">IndicateIndicators</span></a> or for anyone else that
calls <a class="link" href="IndicateServer.html#indicate-server-ref-default" title="indicate_server_ref_default ()"><code class="function">indicate_server_ref_default()</code></a>. Typically this is just an
instance of <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> but applications that create a subclass
of <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> should set this as well.</p>
<div class="refsect3">
<a name="indicate-server-set-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> that should be used</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-set-desktop-file"></a><h3>indicate_server_set_desktop_file ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_set_desktop_file (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
<p>This is a convience function to set the <a class="link" href="IndicateServer.html#IndicateServer--desktop" title="The “desktop” property"><span class="type">“desktop”</span></a>
property of the <em class="parameter"><code>server</code></em>
object. The property can also be set
via traditional means, but this one is easier to read.</p>
<div class="refsect3">
<a name="indicate-server-set-desktop-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> to set the type of</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>The new desktop file representing the server</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-set-type"></a><h3>indicate_server_set_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_set_type (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>);</pre>
<p>This is a convience function to set the <a class="link" href="IndicateServer.html#IndicateServer--type" title="The “type” property"><span class="type">“type”</span></a>
property of the <em class="parameter"><code>server</code></em>
object. The property can also be set
via traditional means, but this one is easier to read.</p>
<div class="refsect3">
<a name="indicate-server-set-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> to set the type of</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The new type of the server</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="indicate-server-show"></a><h3>indicate_server_show ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
indicate_server_show (<em class="parameter"><code><a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *server</code></em>);</pre>
<p>This function exports the object onto DBus and shows it
to the world. This will be the start of it receiving external
signals from DBus. It is likely that, if there are listeners
running, there will several <a class="link" href="IndicateServer.html#IndicateServer-interest-added" title="The “interest-added” signal"><span class="type">“interest-added”</span></a>
signals coming shortly after this function. This function
emits the <span class="type">“server-added”</span> signal across the bus.</p>
<div class="refsect3">
<a name="indicate-server-show.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> to be shown</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="IndicateServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="IndicateServer-struct"></a><h3>struct IndicateServer</h3>
<pre class="programlisting">struct IndicateServer;</pre>
<p>This is the object that represents the overall connection
between this application and DBus. It acts as the proxy for
incomming DBus calls and also sends the appropriate signals
on DBus for events happening on other objects locally. It
provides some settings that effection how the application as
a whole is perceived by listeners of the indicator protocol.</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServerClass"></a><h3>struct IndicateServerClass</h3>
<pre class="programlisting">struct IndicateServerClass {
GObjectClass parent;
/* Signals */
void (* indicator_added) (IndicateServer * server, guint id);
void (* indicator_removed) (IndicateServer * server, guint id);
void (* indicator_modified) (IndicateServer * server, guint id, gchar * property);
void (* server_show) (IndicateServer * server, gchar * type);
void (* server_hide) (IndicateServer * server, gchar * type);
void (* server_display) (IndicateServer * server, guint timestamp);
void (* interest_added) (IndicateServer * server, IndicateInterests interest);
void (* interest_removed) (IndicateServer * server, IndicateInterests interest);
void (* max_indicators_changed) (IndicateServer * server, gint max);
void (* server_count_changed) (IndicateServer * server, guint count);
/* Virtual Functions */
gboolean (*get_indicator_count) (IndicateServer * server, guint * count, GError **error);
indicate_server_get_indicator_list_slot_t get_indicator_list;
gboolean (*get_indicator_property) (IndicateServer * server, guint id, gchar * property, GVariant ** value, GError **error);
indicate_server_get_indicator_property_group_slot_t get_indicator_property_group;
indicate_server_get_indicator_properties_slot_t get_indicator_properties;
gboolean (*show_indicator_to_user) (IndicateServer * server, guint id, guint timestamp, GError ** error);
gboolean (*indicator_displayed) (IndicateServer * server, const gchar * sender, guint id, gboolean displayed, GError ** error);
guint (*get_next_id) (IndicateServer * server);
gboolean (*show_interest) (IndicateServer * server, const gchar * sender, IndicateInterests interest);
gboolean (*remove_interest) (IndicateServer * server, const gchar * sender, IndicateInterests interest);
gboolean (*check_interest) (IndicateServer * server, IndicateInterests interest);
gboolean (*max_indicators_set) (IndicateServer * server, const gchar * sender, gint max);
gint (*max_indicators_get) (IndicateServer * server);
/* Reserver for future use */
void (*indicate_server_reserved1)(void);
void (*indicate_server_reserved2)(void);
void (*indicate_server_reserved3)(void);
void (*indicate_server_reserved4)(void);
};
</pre>
<p>All of the functions and signals that make up the server class
including those that are public API to the application and those
that are public API to all of DBus. Subclasses may need to
implement a large portion of these.</p>
<div class="refsect3">
<a name="IndicateServerClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GObjectClass</span> <em class="structfield"><code><a name="IndicateServerClass.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>Parent Class</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicator-added"></a>indicator_added</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <span class="type">“indicator-added”</span>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicator-removed"></a>indicator_removed</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <span class="type">“indicator-removed”</span>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicator-modified"></a>indicator_modified</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-indicator-modified" title="The “indicator-modified” signal"><span class="type">“indicator-modified”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.server-show"></a>server_show</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-server-show" title="The “server-show” signal"><span class="type">“server-show”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.server-hide"></a>server_hide</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-server-hide" title="The “server-hide” signal"><span class="type">“server-hide”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.server-display"></a>server_display</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-server-display" title="The “server-display” signal"><span class="type">“server-display”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.interest-added"></a>interest_added</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-interest-added" title="The “interest-added” signal"><span class="type">“interest-added”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.interest-removed"></a>interest_removed</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-interest-removed" title="The “interest-removed” signal"><span class="type">“interest-removed”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.max-indicators-changed"></a>max_indicators_changed</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-max-indicators-changed" title="The “max-indicators-changed” signal"><span class="type">“max-indicators-changed”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.server-count-changed"></a>server_count_changed</code></em> ()</p></td>
<td class="struct_member_description"><p>Slot for <a class="link" href="IndicateServer.html#IndicateServer-server-count-changed" title="The “server-count-changed” signal"><span class="type">“server-count-changed”</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.get-indicator-count"></a>get_indicator_count</code></em> ()</p></td>
<td class="struct_member_description"><p>Returns the number of indicators that are visible
on the bus. Hidden indicators should not be counted.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">indicate_server_get_indicator_list_slot_t</span> <em class="structfield"><code><a name="IndicateServerClass.get-indicator-list"></a>get_indicator_list</code></em>;</p></td>
<td class="struct_member_description"><p>List all of the indicators that are visible.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.get-indicator-property"></a>get_indicator_property</code></em> ()</p></td>
<td class="struct_member_description"><p>Get a property from a particular indicator.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">indicate_server_get_indicator_property_group_slot_t</span> <em class="structfield"><code><a name="IndicateServerClass.get-indicator-property-group"></a>get_indicator_property_group</code></em>;</p></td>
<td class="struct_member_description"><p>Get the values for a set of properties
as an array of entries, returning an array as well.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">indicate_server_get_indicator_properties_slot_t</span> <em class="structfield"><code><a name="IndicateServerClass.get-indicator-properties"></a>get_indicator_properties</code></em>;</p></td>
<td class="struct_member_description"><p>Get a list of all the properties that are
on a particular indicator.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.show-indicator-to-user"></a>show_indicator_to_user</code></em> ()</p></td>
<td class="struct_member_description"><p>Respond to someone on the bus asking to show
a particular indicator to the user.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicator-displayed"></a>indicator_displayed</code></em> ()</p></td>
<td class="struct_member_description"><p>An indicator has been visualized by the listener
or it hasn't. This function tracks that.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.get-next-id"></a>get_next_id</code></em> ()</p></td>
<td class="struct_member_description"><p>Get the next unused indicator ID.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.show-interest"></a>show_interest</code></em> ()</p></td>
<td class="struct_member_description"><p>React to someone signifying that they are interested
in this server.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.remove-interest"></a>remove_interest</code></em> ()</p></td>
<td class="struct_member_description"><p>Someone on the bus is no longer interest in this
server, remove it's interest.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.check-interest"></a>check_interest</code></em> ()</p></td>
<td class="struct_member_description"><p>Check to see if anyone on the bus is interested in this
server for a particular feature.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.max-indicators-set"></a>max_indicators_set</code></em> ()</p></td>
<td class="struct_member_description"><p>Set the maximum number of indicators that a
given listener can display.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.max-indicators-get"></a>max_indicators_get</code></em> ()</p></td>
<td class="struct_member_description"><p>Gets the maximum number of indicators from all
listeners that care about this server.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicate-server-reserved1"></a>indicate_server_reserved1</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicate-server-reserved2"></a>indicate_server_reserved2</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicate-server-reserved3"></a>indicate_server_reserved3</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="IndicateServerClass.indicate-server-reserved4"></a>indicate_server_reserved4</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="IndicateServer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="IndicateServer--count"></a><h3>The <code class="literal">“count”</code> property</h3>
<pre class="programlisting"> “count” <span class="type">guint</span></pre>
<p>A number reprsenting the number of items in a server.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer--desktop"></a><h3>The <code class="literal">“desktop”</code> property</h3>
<pre class="programlisting"> “desktop” <span class="type">gchar</span> *</pre>
<p>The desktop file representing this server.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer--icon-theme"></a><h3>The <code class="literal">“icon-theme”</code> property</h3>
<pre class="programlisting"> “icon-theme” <span class="type">gchar</span> *</pre>
<p>The Custom Icon Theme Name to use when displaying this Server.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer--menu"></a><h3>The <code class="literal">“menu”</code> property</h3>
<pre class="programlisting"> “menu” <span class="type">gchar</span> *</pre>
<p>The DBus Object path to an object with a dbusmenu interface on it.</p>
<p>Flags: Read</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer--path"></a><h3>The <code class="literal">“path”</code> property</h3>
<pre class="programlisting"> “path” <span class="type">gchar</span> *</pre>
<p>DBus path for the server object.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: "/com/canonical/indicate"</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer--type"></a><h3>The <code class="literal">“type”</code> property</h3>
<pre class="programlisting"> “type” <span class="type">gchar</span> *</pre>
<p>The type of indicators that this server will provide.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1">
<a name="IndicateServer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="IndicateServer-indicator-delete"></a><h3>The <code class="literal">“indicator-delete”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *indicateserver,
<span class="type">guint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>
</p>
<div class="refsect3">
<a name="IndicateServer-indicator-delete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>indicateserver</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-indicator-modified"></a><h3>The <code class="literal">“indicator-modified”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">guint</span> arg1,
<span class="type">gchar</span> *arg2,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted every time that a property on an indicator changes
and it is visible to the world. This results in a signal on DBus.</p>
<div class="refsect3">
<a name="IndicateServer-indicator-modified.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateIndicator.html" title="IndicateIndicator"><span class="type">IndicateIndicator</span></a> ID number</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg2</p></td>
<td class="parameter_description"><p>The name of the property modified</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-indicator-new"></a><h3>The <code class="literal">“indicator-new”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *indicateserver,
<span class="type">guint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>
</p>
<div class="refsect3">
<a name="IndicateServer-indicator-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>indicateserver</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-interest-added"></a><h3>The <code class="literal">“interest-added”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">guint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when a listener signals that they are interested in
this server for a particular reason. This signal is emitted by DBus.</p>
<div class="refsect3">
<a name="IndicateServer-interest-added.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The interest that was added from <span class="type">IndicateInterests</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-interest-removed"></a><h3>The <code class="literal">“interest-removed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">guint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when a listener signals that they are no longer interested in
this server for a particular reason. This signal is emitted by DBus.</p>
<p><em class="parameter"><code>note</code></em>
This signal is also emitted after a timeout when the object
is created with <em class="parameter"><code>arg1</code></em>
set to <span class="type">INDICATOR_INTREST_NONE</span> if no one has
shown any interest in the server.</p>
<div class="refsect3">
<a name="IndicateServer-interest-removed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The interest that was removed from <span class="type">IndicateInterests</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-max-indicators-changed"></a><h3>The <code class="literal">“max-indicators-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">gint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when a listener either specifies their max number
to be higher, or at all. The default is -1 or infinite.</p>
<div class="refsect3">
<a name="IndicateServer-max-indicators-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The new max number of indicators</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-server-count-changed"></a><h3>The <code class="literal">“server-count-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">guint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when the count property of the server changes
to a new value.</p>
<div class="refsect3">
<a name="IndicateServer-server-count-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The count variable on the server changed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-server-display"></a><h3>The <code class="literal">“server-display”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">guint</span> arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when a listener signals that the server itself should be
displayed. This signal is caused by a user clicking on the application
item in the Messaging Menu. This signal is emitted by DBus.</p>
<div class="refsect3">
<a name="IndicateServer-server-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>Timestamp of the show event</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-server-hide"></a><h3>The <code class="literal">“server-hide”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">gchar</span> *arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when a server removes itself from DBus. This results
in a signal on DBus.</p>
<div class="refsect3">
<a name="IndicateServer-server-hide.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The type of the server</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="IndicateServer-server-show"></a><h3>The <code class="literal">“server-show”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> *arg0,
<span class="type">gchar</span> *arg1,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when a server comes onto DBus by being shown. This
is typically when listeners start reacting to the application's
indicators. This results in a signal on DBus.</p>
<div class="refsect3">
<a name="IndicateServer-server-show.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>arg0</p></td>
<td class="parameter_description"><p>The <a class="link" href="IndicateServer.html" title="IndicateServer"><span class="type">IndicateServer</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg1</p></td>
<td class="parameter_description"><p>The type of the server</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|