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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="IndicateServer">
<refmeta>
<refentrytitle role="top_of_page" id="IndicateServer.top_of_page">IndicateServer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
LIBINDICATE Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>IndicateServer</refname>
<refpurpose>The representation of the application on DBus.</refpurpose>
</refnamediv>
<refsect1 id="IndicateServer.stability-level">
<title>Stability Level</title>
Unstable, unless otherwise indicated
</refsect1>
<refsynopsisdiv id="IndicateServer.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libindicate/server.h>
struct <link linkend="IndicateServer-struct">IndicateServer</link>;
struct <link linkend="IndicateServerClass">IndicateServerClass</link>;
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-add-indicator">indicate_server_add_indicator</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="indicate-server-check-interest">indicate_server_check_interest</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter><link linkend="IndicateInterests"><type>IndicateInterests</type></link> interest</parameter>);
<link linkend="guint"><returnvalue>guint</returnvalue></link> <link linkend="indicate-server-get-next-id">indicate_server_get_next_id</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-hide">indicate_server_hide</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);
<link linkend="IndicateServer"><returnvalue>IndicateServer</returnvalue></link> * <link linkend="indicate-server-ref-default">indicate_server_ref_default</link> (<parameter><type>void</type></parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-remove-indicator">indicate_server_remove_indicator</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-set-default">indicate_server_set_default</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-set-desktop-file">indicate_server_set_desktop_file</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-set-type">indicate_server_set_type</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-server-show">indicate_server_show</link> (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="IndicateServer.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----IndicateServer
</synopsis>
</refsect1>
<refsect1 id="IndicateServer.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="IndicateServer--count">count</link>" <link linkend="guint"><type>guint</type></link> : Read / Write
"<link linkend="IndicateServer--desktop">desktop</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write
"<link linkend="IndicateServer--icon-theme">icon-theme</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write
"<link linkend="IndicateServer--menu">menu</link>" <link linkend="gchar"><type>gchar</type></link>* : Read
"<link linkend="IndicateServer--path">path</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only
"<link linkend="IndicateServer--type">type</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write
</synopsis>
</refsect1>
<refsect1 id="IndicateServer.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="IndicateServer-indicator-delete">indicator-delete</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-indicator-modified">indicator-modified</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-indicator-new">indicator-new</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-interest-added">interest-added</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-interest-removed">interest-removed</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-max-indicators-changed">max-indicators-changed</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-server-count-changed">server-count-changed</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-server-display">server-display</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-server-hide">server-hide</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateServer-server-show">server-show</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
</synopsis>
</refsect1>
<refsect1 id="IndicateServer.description" role="desc">
<title role="desc.title">Description</title>
<para>
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.
</para>
<para>
For simple applications there is limited need to set anything
more than the desktop file and the type of the server using
<link linkend="indicate-server-set-desktop-file"><function>indicate_server_set_desktop_file()</function></link> and <link linkend="indicate-server-set-type"><function>indicate_server_set_type()</function></link>.
Each of these function sets the respective value and expresses
it in a way that other applications on the bus can read it.
</para>
<para>
More advanced applications might find the need to subclass the
<link linkend="IndicateServer"><type>IndicateServer</type></link> 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 <link linkend="GObjects"><type>GObjects</type></link> that can take up a
significant amount of memory in the program.
</para>
<para>
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.
</para>
</refsect1>
<refsect1 id="IndicateServer.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="IndicateServer-struct" role="struct">
<title>struct IndicateServer</title>
<indexterm zone="IndicateServer-struct"><primary>IndicateServer</primary></indexterm>
<programlisting>struct IndicateServer;</programlisting>
<para>
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.
</para></refsect2>
<refsect2 id="IndicateServerClass" role="struct">
<title>struct IndicateServerClass</title>
<indexterm zone="IndicateServerClass"><primary>IndicateServerClass</primary></indexterm>
<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);
};
</programlisting>
<para>
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.
</para><variablelist role="struct">
<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="IndicateServerClass.parent">parent</structfield>;</term>
<listitem><simpara>Parent Class</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicator-added">indicator_added</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-indicator-added"><type>"indicator-added"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicator-removed">indicator_removed</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-indicator-removed"><type>"indicator-removed"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicator-modified">indicator_modified</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-indicator-modified"><type>"indicator-modified"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.server-show">server_show</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-server-show"><type>"server-show"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.server-hide">server_hide</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-server-hide"><type>"server-hide"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.server-display">server_display</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-server-display"><type>"server-display"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.interest-added">interest_added</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-interest-added"><type>"interest-added"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.interest-removed">interest_removed</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-interest-removed"><type>"interest-removed"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.max-indicators-changed">max_indicators_changed</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-max-indicators-changed"><type>"max-indicators-changed"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.server-count-changed">server_count_changed</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateServer-server-count-changed"><type>"server-count-changed"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.get-indicator-count">get_indicator_count</structfield> ()</term>
<listitem><simpara>Returns the number of indicators that are visible
on the bus. Hidden indicators should not be counted.</simpara></listitem>
</varlistentry>
<varlistentry><term><link linkend="indicate-server-get-indicator-list-slot-t"><type>indicate_server_get_indicator_list_slot_t</type></link> <structfield id="IndicateServerClass.get-indicator-list">get_indicator_list</structfield>;</term>
<listitem><simpara>List all of the indicators that are visible.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.get-indicator-property">get_indicator_property</structfield> ()</term>
<listitem><simpara>Get a property from a particular indicator.</simpara></listitem>
</varlistentry>
<varlistentry><term><link linkend="indicate-server-get-indicator-property-group-slot-t"><type>indicate_server_get_indicator_property_group_slot_t</type></link> <structfield id="IndicateServerClass.get-indicator-property-group">get_indicator_property_group</structfield>;</term>
<listitem><simpara>Get the values for a set of properties
as an array of entries, returning an array as well.</simpara></listitem>
</varlistentry>
<varlistentry><term><link linkend="indicate-server-get-indicator-properties-slot-t"><type>indicate_server_get_indicator_properties_slot_t</type></link> <structfield id="IndicateServerClass.get-indicator-properties">get_indicator_properties</structfield>;</term>
<listitem><simpara>Get a list of all the properties that are
on a particular indicator.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.show-indicator-to-user">show_indicator_to_user</structfield> ()</term>
<listitem><simpara>Respond to someone on the bus asking to show
a particular indicator to the user.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicator-displayed">indicator_displayed</structfield> ()</term>
<listitem><simpara>An indicator has been visualized by the listener
or it hasn't. This function tracks that.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.get-next-id">get_next_id</structfield> ()</term>
<listitem><simpara>Get the next unused indicator ID.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.show-interest">show_interest</structfield> ()</term>
<listitem><simpara>React to someone signifying that they are interested
in this server.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.remove-interest">remove_interest</structfield> ()</term>
<listitem><simpara>Someone on the bus is no longer interest in this
server, remove it's interest.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.check-interest">check_interest</structfield> ()</term>
<listitem><simpara>Check to see if anyone on the bus is interested in this
server for a particular feature.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.max-indicators-set">max_indicators_set</structfield> ()</term>
<listitem><simpara>Set the maximum number of indicators that a
given listener can display.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.max-indicators-get">max_indicators_get</structfield> ()</term>
<listitem><simpara>Gets the maximum number of indicators from all
listeners that care about this server.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicate-server-reserved1">indicate_server_reserved1</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicate-server-reserved2">indicate_server_reserved2</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicate-server-reserved3">indicate_server_reserved3</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateServerClass.indicate-server-reserved4">indicate_server_reserved4</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-add-indicator" role="function">
<title>indicate_server_add_indicator ()</title>
<indexterm zone="indicate-server-add-indicator"><primary>indicate_server_add_indicator</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_add_indicator (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
This function adds an indicator <parameter>indicator</parameter> to the list that are
watched by the server <parameter>server</parameter>. This means that signals that are
emitted by the indicator will be picked up and passed via DBus onto
listeners of the application.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> to add the <link linkend="IndicateIndictor"><type>IndicateIndictor</type></link> to.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to add.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-check-interest" role="function">
<title>indicate_server_check_interest ()</title>
<indexterm zone="indicate-server-check-interest"><primary>indicate_server_check_interest</primary></indexterm>
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> indicate_server_check_interest (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter><link linkend="IndicateInterests"><type>IndicateInterests</type></link> interest</parameter>);</programlisting>
<para>
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 <parameter>interest</parameter>.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> being checked</simpara></listitem></varlistentry>
<varlistentry><term><parameter>interest</parameter> :</term>
<listitem><simpara>Which interest type we're checking for</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a listener as the interest otherwise <link linkend="FALSE:CAPS"><literal>FALSE</literal></link></simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-get-next-id" role="function">
<title>indicate_server_get_next_id ()</title>
<indexterm zone="indicate-server-get-next-id"><primary>indicate_server_get_next_id</primary></indexterm>
<programlisting><link linkend="guint"><returnvalue>guint</returnvalue></link> indicate_server_get_next_id (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);</programlisting>
<para>
Returns the next available unused ID that an indicator
can have.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> the ID will be on</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A valid indicator ID.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-hide" role="function">
<title>indicate_server_hide ()</title>
<indexterm zone="indicate-server-hide"><primary>indicate_server_hide</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_hide (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);</programlisting>
<para>
This function hides the server from DBus so that it does
not get signals anymore. This causes the signal <link linkend="IndicateServer-server-hide"><type>"server-hide"</type></link>
to be sent across the bus for all listeners. Also internally
it will signal <link linkend="IndicateServer-interest-removed"><type>"interest-removed"</type></link> for all the
interests that were currently set for this server.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> to hide.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-ref-default" role="function">
<title>indicate_server_ref_default ()</title>
<indexterm zone="indicate-server-ref-default"><primary>indicate_server_ref_default</primary></indexterm>
<programlisting><link linkend="IndicateServer"><returnvalue>IndicateServer</returnvalue></link> * indicate_server_ref_default (<parameter><type>void</type></parameter>);</programlisting>
<para>
This function will return a reference to the default <link linkend="IndicateServer"><type>IndicateServer</type></link>
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 <link linkend="IndicateServer"><type>IndicateServer</type></link> as it ensure that there
is only one per application.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A reference to the default <link linkend="IndicateServer"><type>IndicateServer</type></link> instance. <emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-remove-indicator" role="function">
<title>indicate_server_remove_indicator ()</title>
<indexterm zone="indicate-server-remove-indicator"><primary>indicate_server_remove_indicator</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_remove_indicator (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
Removes an indicator <parameter>indicator</parameter> from being watched by the server <parameter>server</parameter>
so it's signals are no longer watched and set over DBus.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> to remove the <link linkend="IndicateIndictor"><type>IndicateIndictor</type></link> from.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to remove.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-set-default" role="function">
<title>indicate_server_set_default ()</title>
<indexterm zone="indicate-server-set-default"><primary>indicate_server_set_default</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_set_default (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);</programlisting>
<para>
This function is used to set the default <link linkend="IndicateServer"><type>IndicateServer</type></link> that will
be used when creating <link linkend="IndicateIndicators"><type>IndicateIndicators</type></link> or for anyone else that
calls <link linkend="indicate-server-ref-default"><function>indicate_server_ref_default()</function></link>. Typically this is just an
instance of <link linkend="IndicateServer"><type>IndicateServer</type></link> but applications that create a subclass
of <link linkend="IndicateServer"><type>IndicateServer</type></link> should set this as well.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> that should be used</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-set-desktop-file" role="function">
<title>indicate_server_set_desktop_file ()</title>
<indexterm zone="indicate-server-set-desktop-file"><primary>indicate_server_set_desktop_file</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_set_desktop_file (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *path</parameter>);</programlisting>
<para>
This is a convience function to set the <link linkend="IndicateServer--desktop"><type>"desktop"</type></link>
property of the <parameter>server</parameter> object. The property can also be set
via traditional means, but this one is easier to read.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> to set the type of</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara>The new desktop file representing the server</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-set-type" role="function">
<title>indicate_server_set_type ()</title>
<indexterm zone="indicate-server-set-type"><primary>indicate_server_set_type</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_set_type (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>);</programlisting>
<para>
This is a convience function to set the <link linkend="IndicateServer--type"><type>"type"</type></link>
property of the <parameter>server</parameter> object. The property can also be set
via traditional means, but this one is easier to read.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> to set the type of</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara>The new type of the server</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-server-show" role="function">
<title>indicate_server_show ()</title>
<indexterm zone="indicate-server-show"><primary>indicate_server_show</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_server_show (<parameter><link linkend="IndicateServer"><type>IndicateServer</type></link> *server</parameter>);</programlisting>
<para>
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 <link linkend="IndicateServer-interest-added"><type>"interest-added"</type></link>
signals coming shortly after this function. This function
emits the <link linkend="IndicateServer-server-added"><type>"server-added"</type></link> signal across the bus.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> to be shown</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="IndicateServer.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="IndicateServer--count" role="property"><title>The <literal>"count"</literal> property</title>
<indexterm zone="IndicateServer--count"><primary>IndicateServer:count</primary></indexterm>
<programlisting> "count" <link linkend="guint"><type>guint</type></link> : Read / Write</programlisting>
<para>A number reprsenting the number of items in a server.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="IndicateServer--desktop" role="property"><title>The <literal>"desktop"</literal> property</title>
<indexterm zone="IndicateServer--desktop"><primary>IndicateServer:desktop</primary></indexterm>
<programlisting> "desktop" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
<para>The desktop file representing this server.</para><para>Default value: ""</para>
</refsect2>
<refsect2 id="IndicateServer--icon-theme" role="property"><title>The <literal>"icon-theme"</literal> property</title>
<indexterm zone="IndicateServer--icon-theme"><primary>IndicateServer:icon-theme</primary></indexterm>
<programlisting> "icon-theme" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
<para>The Custom Icon Theme Name to use when displaying this Server.</para><para>Default value: ""</para>
</refsect2>
<refsect2 id="IndicateServer--menu" role="property"><title>The <literal>"menu"</literal> property</title>
<indexterm zone="IndicateServer--menu"><primary>IndicateServer:menu</primary></indexterm>
<programlisting> "menu" <link linkend="gchar"><type>gchar</type></link>* : Read</programlisting>
<para>The DBus Object path to an object with a dbusmenu interface on it.</para><para>Default value: ""</para>
</refsect2>
<refsect2 id="IndicateServer--path" role="property"><title>The <literal>"path"</literal> property</title>
<indexterm zone="IndicateServer--path"><primary>IndicateServer:path</primary></indexterm>
<programlisting> "path" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only</programlisting>
<para>DBus path for the server object.</para><para>Default value: "/com/canonical/indicate"</para>
</refsect2>
<refsect2 id="IndicateServer--type" role="property"><title>The <literal>"type"</literal> property</title>
<indexterm zone="IndicateServer--type"><primary>IndicateServer:type</primary></indexterm>
<programlisting> "type" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
<para>The type of indicators that this server will provide.</para><para>Default value: ""</para>
</refsect2>
</refsect1>
<refsect1 id="IndicateServer.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="IndicateServer-indicator-delete" role="signal"><title>The <literal>"indicator-delete"</literal> signal</title>
<indexterm zone="IndicateServer-indicator-delete"><primary>IndicateServer::indicator-delete</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *indicateserver,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>indicateserver</parameter> :</term>
<listitem><simpara>the object which received the signal.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-indicator-modified" role="signal"><title>The <literal>"indicator-modified"</literal> signal</title>
<indexterm zone="IndicateServer-indicator-modified"><primary>IndicateServer::indicator-modified</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gchar"><type>gchar</type></link> *arg2,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
Emitted every time that a property on an indicator changes
and it is visible to the world. This results in a signal on DBus.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> ID number</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter> :</term>
<listitem><simpara>The name of the property modified</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-indicator-new" role="signal"><title>The <literal>"indicator-new"</literal> signal</title>
<indexterm zone="IndicateServer-indicator-new"><primary>IndicateServer::indicator-new</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *indicateserver,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>indicateserver</parameter> :</term>
<listitem><simpara>the object which received the signal.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-interest-added" role="signal"><title>The <literal>"interest-added"</literal> signal</title>
<indexterm zone="IndicateServer-interest-added"><primary>IndicateServer::interest-added</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
Emitted when a listener signals that they are interested in
this server for a particular reason. This signal is emitted by DBus.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The interest that was added from <link linkend="IndicateInterests"><type>IndicateInterests</type></link></simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-interest-removed" role="signal"><title>The <literal>"interest-removed"</literal> signal</title>
<indexterm zone="IndicateServer-interest-removed"><primary>IndicateServer::interest-removed</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
Emitted when a listener signals that they are no longer interested in
this server for a particular reason. This signal is emitted by DBus.
</para>
<para>
<parameter>note</parameter> This signal is also emitted after a timeout when the object
is created with <parameter>arg1</parameter> set to <link linkend="INDICATOR-INTREST-NONE:CAPS"><type>INDICATOR_INTREST_NONE</type></link> if no one has
shown any interest in the server.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The interest that was removed from <link linkend="IndicateInterests"><type>IndicateInterests</type></link></simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-max-indicators-changed" role="signal"><title>The <literal>"max-indicators-changed"</literal> signal</title>
<indexterm zone="IndicateServer-max-indicators-changed"><primary>IndicateServer::max-indicators-changed</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="gint"><type>gint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
Emitted when a listener either specifies their max number
to be higher, or at all. The default is -1 or infinite.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The new max number of indicators</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-server-count-changed" role="signal"><title>The <literal>"server-count-changed"</literal> signal</title>
<indexterm zone="IndicateServer-server-count-changed"><primary>IndicateServer::server-count-changed</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
Emitted when the count property of the server changes
to a new value.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The count variable on the server changed.</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-server-display" role="signal"><title>The <literal>"server-display"</literal> signal</title>
<indexterm zone="IndicateServer-server-display"><primary>IndicateServer::server-display</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="guint"><type>guint</type></link> arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
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.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>Timestamp of the show event</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-server-hide" role="signal"><title>The <literal>"server-hide"</literal> signal</title>
<indexterm zone="IndicateServer-server-hide"><primary>IndicateServer::server-hide</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="gchar"><type>gchar</type></link> *arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
Emitted when a server removes itself from DBus. This results
in a signal on DBus.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The type of the server</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="IndicateServer-server-show" role="signal"><title>The <literal>"server-show"</literal> signal</title>
<indexterm zone="IndicateServer-server-show"><primary>IndicateServer::server-show</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateServer"><type>IndicateServer</type></link> *arg0,
<link linkend="gchar"><type>gchar</type></link> *arg1,
<link linkend="gpointer"><type>gpointer</type></link> user_data) : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link></programlisting>
<para>
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.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateServer"><type>IndicateServer</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The type of the server</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
