← Back to branch summary

~bcurtiswx/ubuntu/precise/empathy/3.4.2.1-0ubuntu1

« back to all changes in this revision

Viewing changes to docs/libempathy/xml/empathy-contact-monitor.xml

  • Committer: Bazaar Package Importer
  • Author(s): Laurent Bigonville
  • Date: 2009-11-16 23:40:52 UTC
  • mfrom: (1.1.39 upstream)
  • mto: (6.3.7 experimental)
  • mto: This revision was merged to the branch mainline in revision 80.
  • Revision ID: james.westby@ubuntu.com-20091116234052-7hhwrpeln4mwdyw7
Tags: upstream-2.29.2
Import upstream version 2.29.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/xml/empathy-contact-monitor.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version SYSTEM "version.xml">
5
 
]>
6
 
<refentry id="EmpathyContactMonitor">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="EmpathyContactMonitor.top_of_page">EmpathyContactMonitor</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>EmpathyContactMonitor</refname>
15
 
<refpurpose></refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="EmpathyContactMonitor.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
                    <link linkend="EmpathyContactMonitor-struct">EmpathyContactMonitor</link>;
23
 
<link linkend="void">void</link>                <link linkend="empathy-contact-monitor-set-iface">empathy_contact_monitor_set_iface</link>   (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *self,
24
 
                                                         <link linkend="EmpathyContactList">EmpathyContactList</link> *iface);
25
 
<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> * <link linkend="empathy-contact-monitor-new-for-iface">empathy_contact_monitor_new_for_iface</link>
26
 
                                                        (<link linkend="EmpathyContactList">EmpathyContactList</link> *iface);
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
<refsect1 id="EmpathyContactMonitor.object-hierarchy" role="object_hierarchy">
31
 
<title role="object_hierarchy.title">Object Hierarchy</title>
32
 
<synopsis>
33
 
  <link linkend="GObject">GObject</link>
34
 
   +----EmpathyContactMonitor
35
 
</synopsis>
36
 
</refsect1>
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
<refsect1 id="EmpathyContactMonitor.properties" role="properties">
43
 
<title role="properties.title">Properties</title>
44
 
<synopsis>
45
 
  &quot;<link linkend="EmpathyContactMonitor--iface">iface</link>&quot;                    <link linkend="EmpathyContactList">EmpathyContactList</link>*   : Read / Write / Construct Only
46
 
</synopsis>
47
 
</refsect1>
48
 
 
49
 
<refsect1 id="EmpathyContactMonitor.signals" role="signal_proto">
50
 
<title role="signal_proto.title">Signals</title>
51
 
<synopsis>
52
 
  &quot;<link linkend="EmpathyContactMonitor-contact-added">contact-added</link>&quot;                                  : Run Last
53
 
  &quot;<link linkend="EmpathyContactMonitor-contact-avatar-changed">contact-avatar-changed</link>&quot;                         : Run Last
54
 
  &quot;<link linkend="EmpathyContactMonitor-contact-capabilities-changed">contact-capabilities-changed</link>&quot;                   : Run Last
55
 
  &quot;<link linkend="EmpathyContactMonitor-contact-name-changed">contact-name-changed</link>&quot;                           : Run Last
56
 
  &quot;<link linkend="EmpathyContactMonitor-contact-presence-changed">contact-presence-changed</link>&quot;                       : Run Last
57
 
  &quot;<link linkend="EmpathyContactMonitor-contact-presence-message-changed">contact-presence-message-changed</link>&quot;               : Run Last
58
 
  &quot;<link linkend="EmpathyContactMonitor-contact-removed">contact-removed</link>&quot;                                : Run Last
59
 
</synopsis>
60
 
</refsect1>
61
 
 
62
 
 
63
 
<refsect1 id="EmpathyContactMonitor.description" role="desc">
64
 
<title role="desc.title">Description</title>
65
 
<para>
66
 
</para>
67
 
</refsect1>
68
 
 
69
 
<refsect1 id="EmpathyContactMonitor.details" role="details">
70
 
<title role="details.title">Details</title>
71
 
<refsect2 id="EmpathyContactMonitor-struct" role="struct">
72
 
<title>EmpathyContactMonitor</title>
73
 
<indexterm zone="EmpathyContactMonitor-struct"><primary sortas="EmpathyContactMonitor">EmpathyContactMonitor</primary></indexterm><programlisting>typedef struct _EmpathyContactMonitor EmpathyContactMonitor;</programlisting>
74
 
<para>
75
 
</para></refsect2>
76
 
<refsect2 id="empathy-contact-monitor-set-iface" role="function">
77
 
<title>empathy_contact_monitor_set_iface ()</title>
78
 
<indexterm zone="empathy-contact-monitor-set-iface"><primary sortas="empathy_contact_monitor_set_iface">empathy_contact_monitor_set_iface</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_contact_monitor_set_iface   (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *self,
79
 
                                                         <link linkend="EmpathyContactList">EmpathyContactList</link> *iface);</programlisting>
80
 
<para>
81
 
</para><variablelist role="params">
82
 
<varlistentry><term><parameter>self</parameter>&#160;:</term>
83
 
<listitem><simpara>
84
 
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><parameter>iface</parameter>&#160;:</term>
86
 
<listitem><simpara>
87
 
</simpara></listitem></varlistentry>
88
 
</variablelist></refsect2>
89
 
<refsect2 id="empathy-contact-monitor-new-for-iface" role="function">
90
 
<title>empathy_contact_monitor_new_for_iface ()</title>
91
 
<indexterm zone="empathy-contact-monitor-new-for-iface"><primary sortas="empathy_contact_monitor_new_for_iface">empathy_contact_monitor_new_for_iface</primary></indexterm><programlisting><link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> * empathy_contact_monitor_new_for_iface
92
 
                                                        (<link linkend="EmpathyContactList">EmpathyContactList</link> *iface);</programlisting>
93
 
<para>
94
 
</para><variablelist role="params">
95
 
<varlistentry><term><parameter>iface</parameter>&#160;:</term>
96
 
<listitem><simpara>
97
 
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
99
 
</simpara></listitem></varlistentry>
100
 
</variablelist></refsect2>
101
 
 
102
 
</refsect1>
103
 
<refsect1 id="EmpathyContactMonitor.property-details" role="property_details">
104
 
<title role="property_details.title">Property Details</title>
105
 
<refsect2 id="EmpathyContactMonitor--iface" role="property"><title>The <literal>&quot;iface&quot;</literal> property</title>
106
 
<indexterm zone="EmpathyContactMonitor--iface"><primary sortas="EmpathyContactMonitor:iface">EmpathyContactMonitor:iface</primary></indexterm><programlisting>  &quot;iface&quot;                    <link linkend="EmpathyContactList">EmpathyContactList</link>*   : Read / Write / Construct Only</programlisting>
107
 
<para>The contact list we're monitoring.</para></refsect2>
108
 
</refsect1>
109
 
 
110
 
<refsect1 id="EmpathyContactMonitor.signal-details" role="signals">
111
 
<title role="signals.title">Signal Details</title>
112
 
<refsect2 id="EmpathyContactMonitor-contact-added" role="signal"><title>The <literal>&quot;contact-added&quot;</literal> signal</title>
113
 
<indexterm zone="EmpathyContactMonitor-contact-added"><primary sortas="EmpathyContactMonitor::contact-added">EmpathyContactMonitor::contact-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
114
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
115
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
116
 
<para>
117
 
</para>
118
 
@:
119
 
@:<variablelist role="params">
120
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
121
 
<listitem><simpara>the object which received the signal.
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
124
 
<listitem><simpara>
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
127
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
128
 
</variablelist></refsect2><refsect2 id="EmpathyContactMonitor-contact-avatar-changed" role="signal"><title>The <literal>&quot;contact-avatar-changed&quot;</literal> signal</title>
129
 
<indexterm zone="EmpathyContactMonitor-contact-avatar-changed"><primary sortas="EmpathyContactMonitor::contact-avatar-changed">EmpathyContactMonitor::contact-avatar-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
130
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
131
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
132
 
<para>
133
 
</para>
134
 
@:
135
 
@:<variablelist role="params">
136
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
137
 
<listitem><simpara>the object which received the signal.
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
140
 
<listitem><simpara>
141
 
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
143
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
144
 
</variablelist></refsect2><refsect2 id="EmpathyContactMonitor-contact-capabilities-changed" role="signal"><title>The <literal>&quot;contact-capabilities-changed&quot;</literal> signal</title>
145
 
<indexterm zone="EmpathyContactMonitor-contact-capabilities-changed"><primary sortas="EmpathyContactMonitor::contact-capabilities-changed">EmpathyContactMonitor::contact-capabilities-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
146
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
147
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
148
 
<para>
149
 
</para>
150
 
@:
151
 
@:<variablelist role="params">
152
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
153
 
<listitem><simpara>the object which received the signal.
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
156
 
<listitem><simpara>
157
 
</simpara></listitem></varlistentry>
158
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
159
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
160
 
</variablelist></refsect2><refsect2 id="EmpathyContactMonitor-contact-name-changed" role="signal"><title>The <literal>&quot;contact-name-changed&quot;</literal> signal</title>
161
 
<indexterm zone="EmpathyContactMonitor-contact-name-changed"><primary sortas="EmpathyContactMonitor::contact-name-changed">EmpathyContactMonitor::contact-name-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
162
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
163
 
                                                        <link linkend="gchar">gchar</link>                 *arg2,
164
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
165
 
<para>
166
 
</para>
167
 
@:
168
 
@:
169
 
@:<variablelist role="params">
170
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
171
 
<listitem><simpara>the object which received the signal.
172
 
</simpara></listitem></varlistentry>
173
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
174
 
<listitem><simpara>
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
177
 
<listitem><simpara>
178
 
</simpara></listitem></varlistentry>
179
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
180
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
181
 
</variablelist></refsect2><refsect2 id="EmpathyContactMonitor-contact-presence-changed" role="signal"><title>The <literal>&quot;contact-presence-changed&quot;</literal> signal</title>
182
 
<indexterm zone="EmpathyContactMonitor-contact-presence-changed"><primary sortas="EmpathyContactMonitor::contact-presence-changed">EmpathyContactMonitor::contact-presence-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
183
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
184
 
                                                        <link linkend="guint">guint</link>                  arg2,
185
 
                                                        <link linkend="guint">guint</link>                  arg3,
186
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
187
 
<para>
188
 
</para>
189
 
@:
190
 
@:
191
 
@:
192
 
@:<variablelist role="params">
193
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
194
 
<listitem><simpara>the object which received the signal.
195
 
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><parameter>arg3</parameter>&#160;:</term>
203
 
<listitem><simpara>
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
206
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
207
 
</variablelist></refsect2><refsect2 id="EmpathyContactMonitor-contact-presence-message-changed" role="signal"><title>The <literal>&quot;contact-presence-message-changed&quot;</literal> signal</title>
208
 
<indexterm zone="EmpathyContactMonitor-contact-presence-message-changed"><primary sortas="EmpathyContactMonitor::contact-presence-message-changed">EmpathyContactMonitor::contact-presence-message-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
209
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
210
 
                                                        <link linkend="gchar">gchar</link>                 *arg2,
211
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
212
 
<para>
213
 
</para>
214
 
@:
215
 
@:
216
 
@:<variablelist role="params">
217
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
218
 
<listitem><simpara>the object which received the signal.
219
 
</simpara></listitem></varlistentry>
220
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
221
 
<listitem><simpara>
222
 
</simpara></listitem></varlistentry>
223
 
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
224
 
<listitem><simpara>
225
 
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
227
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
228
 
</variablelist></refsect2><refsect2 id="EmpathyContactMonitor-contact-removed" role="signal"><title>The <literal>&quot;contact-removed&quot;</literal> signal</title>
229
 
<indexterm zone="EmpathyContactMonitor-contact-removed"><primary sortas="EmpathyContactMonitor::contact-removed">EmpathyContactMonitor::contact-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="EmpathyContactMonitor">EmpathyContactMonitor</link> *empathycontactmonitor,
230
 
                                                        <link linkend="EmpathyContact">EmpathyContact</link>        *arg1,
231
 
                                                        <link linkend="gpointer">gpointer</link>               user_data)                  : Run Last</programlisting>
232
 
<para>
233
 
</para>
234
 
@:
235
 
@:<variablelist role="params">
236
 
<varlistentry><term><parameter>empathycontactmonitor</parameter>&#160;:</term>
237
 
<listitem><simpara>the object which received the signal.
238
 
</simpara></listitem></varlistentry>
239
 
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
240
 
<listitem><simpara>
241
 
</simpara></listitem></varlistentry>
242
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
243
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
244
 
</variablelist></refsect2>
245
 
</refsect1>
246
 
 
247
 
 
248
 
 
249
 
</refentry>