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
|
<?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="IndicateIndicator">
<refmeta>
<refentrytitle role="top_of_page" id="IndicateIndicator.top_of_page">IndicateIndicator</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
LIBINDICATE Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>IndicateIndicator</refname>
<refpurpose>A representation of state for applications</refpurpose>
</refnamediv>
<refsect1 id="IndicateIndicator.stability-level">
<title>Stability Level</title>
Unstable, unless otherwise indicated
</refsect1>
<refsynopsisdiv id="IndicateIndicator.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libindicate/indicator.h>
struct <link linkend="IndicateIndicator-struct">IndicateIndicator</link>;
struct <link linkend="IndicateIndicatorClass">IndicateIndicatorClass</link>;
<link linkend="guint"><returnvalue>guint</returnvalue></link> <link linkend="indicate-indicator-get-id">indicate_indicator_get_id</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="indicate-indicator-get-property">indicate_indicator_get_property</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-indicator-hide">indicate_indicator_hide</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="indicate-indicator-is-visible">indicate_indicator_is_visible</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
<link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link> * <link linkend="indicate-indicator-list-properties">indicate_indicator_list_properties</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
<link linkend="IndicateIndicator"><returnvalue>IndicateIndicator</returnvalue></link> * <link linkend="indicate-indicator-new">indicate_indicator_new</link> (<parameter><type>void</type></parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-indicator-set-property">indicate_indicator_set_property</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *data</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-indicator-set-property-time">indicate_indicator_set_property_time</link>
(<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
<parameter><link linkend="GTimeVal"><type>GTimeVal</type></link> *time</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-indicator-show">indicate_indicator_show</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="indicate-indicator-user-display">indicate_indicator_user_display</link> (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="IndicateIndicator.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----IndicateIndicator
</synopsis>
</refsect1>
<refsect1 id="IndicateIndicator.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="IndicateIndicator-displayed">displayed</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateIndicator-hide">hide</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateIndicator-modified">modified</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateIndicator-show">show</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
"<link linkend="IndicateIndicator-user-display">user-display</link>" : <link linkend="G-SIGNAL-RUN-LAST:CAPS"><literal>Run Last</literal></link>
</synopsis>
</refsect1>
<refsect1 id="IndicateIndicator.description" role="desc">
<title role="desc.title">Description</title>
<para>
An indicator is designed to represent a single instance of something
in your application. So this might be an IM or an e-mail mail box
or any other thing that is a small unit of information to pass on
to the user.
</para>
<para>
Indicators make no promises about how they are preceived by the
user, it's up to the listener to represent them in an intutive and
visually appealling way. But, what we can do is provide information
on the indicator to provide enough information for the listener
to do that.
</para>
<para>
Mostly this is done through properties.
</para>
<para>
It may be that some users don't want to create objects for every
indicator as it could be a lot of overhead if there are large numbers
and there is already a data structure representing them all. In that
case it is recommended that you ignore the <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> object
tree in general and move to subclassing <link linkend="IndicateServer"><type>IndicateServer</type></link> directly.
</para>
</refsect1>
<refsect1 id="IndicateIndicator.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="IndicateIndicator-struct" role="struct">
<title>struct IndicateIndicator</title>
<indexterm zone="IndicateIndicator-struct"><primary>IndicateIndicator</primary></indexterm>
<programlisting>struct IndicateIndicator;</programlisting>
<para>
The indicator object represents a single item that is shared over the
indicator bus. This could be something like one IM, one e-mail or
a single system update. It should be accessed only through its
accessors.
</para></refsect2>
<refsect2 id="IndicateIndicatorClass" role="struct">
<title>struct IndicateIndicatorClass</title>
<indexterm zone="IndicateIndicatorClass"><primary>IndicateIndicatorClass</primary></indexterm>
<programlisting>struct IndicateIndicatorClass {
/* Parents */
GObjectClass parent_class;
/* Signals */
void (*hide) (IndicateIndicator * indicator, gpointer data);
void (*show) (IndicateIndicator * indicator, gpointer data);
void (*user_display) (IndicateIndicator * indicator, guint timestamp, gpointer data);
void (*modified) (IndicateIndicator * indicator, gchar * property, gpointer data);
void (*displayed) (IndicateIndicator * indicator, gboolean displayed);
/* Subclassable functions */
void (*set_property) (IndicateIndicator * indicator, const gchar * key, GVariant * data);
GVariant * (*get_property) (IndicateIndicator * indicator, const gchar * key);
indicate_indicator_list_properties_slot_t list_properties;
/* Reserver for future use */
void (*indicate_indicator_reserved1)(void);
void (*indicate_indicator_reserved2)(void);
void (*indicate_indicator_reserved3)(void);
void (*indicate_indicator_reserved4)(void);
};
</programlisting>
<para>
All of the functions that are used to modify or change data that is
in the indicator. Typically gets subclassed by other types of
indicators, for example <link linkend="IndicateIndicatorMessages"><type>IndicateIndicatorMessages</type></link>.
</para><variablelist role="struct">
<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="IndicateIndicatorClass.parent-class">parent_class</structfield>;</term>
<listitem><simpara>Parent class <link linkend="GObjectClass"><type>GObjectClass</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.hide">hide</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateIndicator-hide"><type>"hide"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.show">show</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateIndicator-show"><type>"show"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.user-display">user_display</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateIndicator-user-display"><type>"user-display"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.modified">modified</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateIndicator-modified"><type>"modified"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.displayed">displayed</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="IndicateIndicator-displayed"><type>"displayed"</type></link>.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.set-property">set_property</structfield> ()</term>
<listitem><simpara>Called when <link linkend="indicate-indicator-set-property"><function>indicate_indicator_set_property()</function></link> is called
and should set the value. While typically it is overridden by
subclasses they usually handle special properties themselves and
then call the superclass for storage.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.get-property">get_property</structfield> ()</term>
<listitem><simpara>Called when <link linkend="indicate-indicator-get-property"><function>indicate_indicator_get_property()</function></link> is called
and should return the value requested. Many times this is left alone.</simpara></listitem>
</varlistentry>
<varlistentry><term><link linkend="indicate-indicator-list-properties-slot-t"><type>indicate_indicator_list_properties_slot_t</type></link> <structfield id="IndicateIndicatorClass.list-properties">list_properties</structfield>;</term>
<listitem><simpara>Called when <link linkend="indicate-indicator-list-properties"><function>indicate_indicator_list_properties()</function></link> is called
and returns a list of the properties available. Again this can be
overridden by subclasses to handle special properties.</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.indicate-indicator-reserved1">indicate_indicator_reserved1</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.indicate-indicator-reserved2">indicate_indicator_reserved2</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.indicate-indicator-reserved3">indicate_indicator_reserved3</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="IndicateIndicatorClass.indicate-indicator-reserved4">indicate_indicator_reserved4</structfield> ()</term>
<listitem><simpara>Reserved for future use</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-get-id" role="function">
<title>indicate_indicator_get_id ()</title>
<indexterm zone="indicate-indicator-get-id"><primary>indicate_indicator_get_id</primary></indexterm>
<programlisting><link linkend="guint"><returnvalue>guint</returnvalue></link> indicate_indicator_get_id (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
Gets the ID value of the <parameter>indicator</parameter>.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The ID of the indicator. Can not be zero.
Zero represents an error.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-get-property" role="function">
<title>indicate_indicator_get_property ()</title>
<indexterm zone="indicate-indicator-get-property"><primary>indicate_indicator_get_property</primary></indexterm>
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * indicate_indicator_get_property (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
<para>
Returns the value that is set for a property or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if that
property is not set.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>name of the property</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A constant string or NULL.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-hide" role="function">
<title>indicate_indicator_hide ()</title>
<indexterm zone="indicate-indicator-hide"><primary>indicate_indicator_hide</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_indicator_hide (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
Hides the indicator from the bus. Does not effect the
indicator's <link linkend="IndicateServer"><type>IndicateServer</type></link> in any way.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-is-visible" role="function">
<title>indicate_indicator_is_visible ()</title>
<indexterm zone="indicate-indicator-is-visible"><primary>indicate_indicator_is_visible</primary></indexterm>
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> indicate_indicator_is_visible (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
Checkes the visibility status of <parameter>indicator</parameter>.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the indicator is visible else <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-list-properties" role="function">
<title>indicate_indicator_list_properties ()</title>
<indexterm zone="indicate-indicator-list-properties"><primary>indicate_indicator_list_properties</primary></indexterm>
<programlisting><link linkend="GPtrArray"><returnvalue>GPtrArray</returnvalue></link> * indicate_indicator_list_properties (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
This function gets a list of all the properties that exist
on a <parameter>indicator</parameter>. The array may have zero entries.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on. <emphasis role="annotation">[<acronym>in</acronym>]</emphasis></simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>An array of
strings that is the keys of all the properties on this indicator. <emphasis role="annotation">[<acronym>transfer full</acronym>][<acronym>array</acronym>][<acronym>element-type</acronym> utf8]</emphasis></simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-new" role="function">
<title>indicate_indicator_new ()</title>
<indexterm zone="indicate-indicator-new"><primary>indicate_indicator_new</primary></indexterm>
<programlisting><link linkend="IndicateIndicator"><returnvalue>IndicateIndicator</returnvalue></link> * indicate_indicator_new (<parameter><type>void</type></parameter>);</programlisting>
<para>
Builds a new indicator object using <link linkend="g-object-new"><function>g_object_new()</function></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A pointer to a new <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> object.</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-set-property" role="function">
<title>indicate_indicator_set_property ()</title>
<indexterm zone="indicate-indicator-set-property"><primary>indicate_indicator_set_property</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_indicator_set_property (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *data</parameter>);</programlisting>
<para>
Sets a simple string property on <parameter>indicator</parameter>. If the property
had previously been set it will replace it with the new value,
otherwise it will create the property. This will include an
emition of <link linkend="IndicateIndicator-modified"><type>"modified"</type></link> if the property value
was changed.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>name of the property</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>value of the property</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-set-property-time" role="function">
<title>indicate_indicator_set_property_time ()</title>
<indexterm zone="indicate-indicator-set-property-time"><primary>indicate_indicator_set_property_time</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_indicator_set_property_time
(<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>,
<parameter><link linkend="GTimeVal"><type>GTimeVal</type></link> *time</parameter>);</programlisting>
<para>
This is a helper function that wraps around <link linkend="indicate-indicator-set-property"><type>indicate_indicator_set_property</type></link>
but takes an <link linkend="GTimeVal"><type>GTimeVal</type></link> parameter. It then takes the <parameter>data</parameter>
parameter converts it to an ISO 8601 time string and
uses that data to call <link linkend="indicate-indicator-set-property"><type>indicate_indicator_set_property</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>name of the property</simpara></listitem></varlistentry>
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara>time to set property with</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-show" role="function">
<title>indicate_indicator_show ()</title>
<indexterm zone="indicate-indicator-show"><primary>indicate_indicator_show</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_indicator_show (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>);</programlisting>
<para>
Shows this indicator on the bus. If the <link linkend="IndicateServer"><type>IndicateServer</type></link> that it's
connected to is not shown itself this function will show the server
as well using <link linkend="indicate-server-show"><type>indicate_server_show</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="indicate-indicator-user-display" role="function">
<title>indicate_indicator_user_display ()</title>
<indexterm zone="indicate-indicator-user-display"><primary>indicate_indicator_user_display</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> indicate_indicator_user_display (<parameter><link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicator</parameter>,
<parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>);</programlisting>
<para>
Emits the <link linkend="IndicateIndicator-user-display"><type>"user-display"</type></link> signal simliar to a user
clicking on <parameter>indicator</parameter> over the bus. Signal will not be sent if the
<parameter>indicator</parameter> is not visible.
</para><variablelist role="params">
<varlistentry><term><parameter>indicator</parameter> :</term>
<listitem><simpara>a <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> to act on</simpara></listitem></varlistentry>
<varlistentry><term><parameter>timestamp</parameter> :</term>
<listitem><simpara>The time that the event happened</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="IndicateIndicator.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="IndicateIndicator-displayed" role="signal"><title>The <literal>"displayed"</literal> signal</title>
<indexterm zone="IndicateIndicator-displayed"><primary>IndicateIndicator::displayed</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *arg0,
<link linkend="gboolean"><type>gboolean</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>
This is the signal that the indicator has been displayed, or
hidden by a listener. In most cases, the signal will be that it
has been displayed as most folks don't go hiding it later.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>Whether the indicator has been displayed</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="IndicateIndicator-hide" role="signal"><title>The <literal>"hide"</literal> signal</title>
<indexterm zone="IndicateIndicator-hide"><primary>IndicateIndicator::hide</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *arg0,
<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 this indicator is hidden. This
is mostly used by <link linkend="IndicateServer"><type>IndicateServer</type></link>.
</para>
<para>
Typically this results in an emition of <link linkend="IndicateServer-indicator-removed"><type>"indicator-removed"</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> object</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="IndicateIndicator-modified" role="signal"><title>The <literal>"modified"</literal> signal</title>
<indexterm zone="IndicateIndicator-modified"><primary>IndicateIndicator::modified</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateIndicator"><type>IndicateIndicator</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 every time an indicator property is changed.
This is mostly used by <link linkend="IndicateServer"><type>IndicateServer</type></link>.
</para>
<para>
Typically this results in an emition of <link linkend="IndicateServer-indicator-modified"><type>"indicator-modified"</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> object</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>The name of the property that 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="IndicateIndicator-show" role="signal"><title>The <literal>"show"</literal> signal</title>
<indexterm zone="IndicateIndicator-show"><primary>IndicateIndicator::show</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *arg0,
<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 this indicator is shown. This
is mostly used by <link linkend="IndicateServer"><type>IndicateServer</type></link>.
</para>
<para>
Typically this results in an emition of <link linkend="IndicateServer-indicator-added"><type>"indicator-added"</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>arg0</parameter> :</term>
<listitem><simpara>The <link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> object</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="IndicateIndicator-user-display" role="signal"><title>The <literal>"user-display"</literal> signal</title>
<indexterm zone="IndicateIndicator-user-display"><primary>IndicateIndicator::user-display</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="IndicateIndicator"><type>IndicateIndicator</type></link> *indicateindicator,
<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>indicateindicator</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>
</refsect1>
</refentry>
|
