← 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-idle.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-idle.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="EmpathyIdle">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="EmpathyIdle.top_of_page">EmpathyIdle</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>EmpathyIdle</refname>
15
 
<refpurpose></refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="EmpathyIdle.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
                    <link linkend="EmpathyIdle-struct">EmpathyIdle</link>;
23
 
<link linkend="EmpathyIdle">EmpathyIdle</link> *       <link linkend="empathy-idle-dup-singleton">empathy_idle_dup_singleton</link>          (void);
24
 
<link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link>  <link linkend="empathy-idle-get-state">empathy_idle_get_state</link>        (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);
25
 
<link linkend="void">void</link>                <link linkend="empathy-idle-set-state">empathy_idle_set_state</link>              (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
26
 
                                                         <link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link> state);
27
 
const <link linkend="gchar">gchar</link> *       <link linkend="empathy-idle-get-status">empathy_idle_get_status</link>             (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);
28
 
<link linkend="void">void</link>                <link linkend="empathy-idle-set-status">empathy_idle_set_status</link>             (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
29
 
                                                         const <link linkend="gchar">gchar</link> *status);
30
 
<link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link>  <link linkend="empathy-idle-get-flash-state">empathy_idle_get_flash_state</link>  (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);
31
 
<link linkend="void">void</link>                <link linkend="empathy-idle-set-flash-state">empathy_idle_set_flash_state</link>        (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
32
 
                                                         <link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link> state);
33
 
<link linkend="void">void</link>                <link linkend="empathy-idle-set-presence">empathy_idle_set_presence</link>           (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
34
 
                                                         <link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link> state,
35
 
                                                         const <link linkend="gchar">gchar</link> *status);
36
 
<link linkend="gboolean">gboolean</link>            <link linkend="empathy-idle-get-auto-away">empathy_idle_get_auto_away</link>          (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);
37
 
<link linkend="void">void</link>                <link linkend="empathy-idle-set-auto-away">empathy_idle_set_auto_away</link>          (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
38
 
                                                         <link linkend="gboolean">gboolean</link> auto_away);
39
 
</synopsis>
40
 
</refsynopsisdiv>
41
 
 
42
 
<refsect1 id="EmpathyIdle.object-hierarchy" role="object_hierarchy">
43
 
<title role="object_hierarchy.title">Object Hierarchy</title>
44
 
<synopsis>
45
 
  <link linkend="GObject">GObject</link>
46
 
   +----EmpathyIdle
47
 
</synopsis>
48
 
</refsect1>
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
<refsect1 id="EmpathyIdle.properties" role="properties">
55
 
<title role="properties.title">Properties</title>
56
 
<synopsis>
57
 
  &quot;<link linkend="EmpathyIdle--auto-away">auto-away</link>&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write
58
 
  &quot;<link linkend="EmpathyIdle--flash-state">flash-state</link>&quot;              <link linkend="guint">guint</link>                 : Read / Write
59
 
  &quot;<link linkend="EmpathyIdle--state">state</link>&quot;                    <link linkend="guint">guint</link>                 : Read / Write
60
 
  &quot;<link linkend="EmpathyIdle--status">status</link>&quot;                   <link linkend="gchar">gchar</link>*                : Read / Write
61
 
</synopsis>
62
 
</refsect1>
63
 
 
64
 
 
65
 
 
66
 
<refsect1 id="EmpathyIdle.description" role="desc">
67
 
<title role="desc.title">Description</title>
68
 
<para>
69
 
</para>
70
 
</refsect1>
71
 
 
72
 
<refsect1 id="EmpathyIdle.details" role="details">
73
 
<title role="details.title">Details</title>
74
 
<refsect2 id="EmpathyIdle-struct" role="struct">
75
 
<title>EmpathyIdle</title>
76
 
<indexterm zone="EmpathyIdle-struct"><primary sortas="EmpathyIdle">EmpathyIdle</primary></indexterm><programlisting>typedef struct _EmpathyIdle EmpathyIdle;</programlisting>
77
 
<para>
78
 
</para></refsect2>
79
 
<refsect2 id="empathy-idle-dup-singleton" role="function">
80
 
<title>empathy_idle_dup_singleton ()</title>
81
 
<indexterm zone="empathy-idle-dup-singleton"><primary sortas="empathy_idle_dup_singleton">empathy_idle_dup_singleton</primary></indexterm><programlisting><link linkend="EmpathyIdle">EmpathyIdle</link> *       empathy_idle_dup_singleton          (void);</programlisting>
82
 
<para>
83
 
</para><variablelist role="params">
84
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
85
 
</simpara></listitem></varlistentry>
86
 
</variablelist></refsect2>
87
 
<refsect2 id="empathy-idle-get-state" role="function">
88
 
<title>empathy_idle_get_state ()</title>
89
 
<indexterm zone="empathy-idle-get-state"><primary sortas="empathy_idle_get_state">empathy_idle_get_state</primary></indexterm><programlisting><link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link>  empathy_idle_get_state        (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);</programlisting>
90
 
<para>
91
 
</para><variablelist role="params">
92
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
93
 
<listitem><simpara>
94
 
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
96
 
</simpara></listitem></varlistentry>
97
 
</variablelist></refsect2>
98
 
<refsect2 id="empathy-idle-set-state" role="function">
99
 
<title>empathy_idle_set_state ()</title>
100
 
<indexterm zone="empathy-idle-set-state"><primary sortas="empathy_idle_set_state">empathy_idle_set_state</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_idle_set_state              (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
101
 
                                                         <link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link> state);</programlisting>
102
 
<para>
103
 
</para><variablelist role="params">
104
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
105
 
<listitem><simpara>
106
 
</simpara></listitem></varlistentry>
107
 
<varlistentry><term><parameter>state</parameter>&#160;:</term>
108
 
<listitem><simpara>
109
 
</simpara></listitem></varlistentry>
110
 
</variablelist></refsect2>
111
 
<refsect2 id="empathy-idle-get-status" role="function">
112
 
<title>empathy_idle_get_status ()</title>
113
 
<indexterm zone="empathy-idle-get-status"><primary sortas="empathy_idle_get_status">empathy_idle_get_status</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       empathy_idle_get_status             (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);</programlisting>
114
 
<para>
115
 
</para><variablelist role="params">
116
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
117
 
<listitem><simpara>
118
 
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
120
 
</simpara></listitem></varlistentry>
121
 
</variablelist></refsect2>
122
 
<refsect2 id="empathy-idle-set-status" role="function">
123
 
<title>empathy_idle_set_status ()</title>
124
 
<indexterm zone="empathy-idle-set-status"><primary sortas="empathy_idle_set_status">empathy_idle_set_status</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_idle_set_status             (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
125
 
                                                         const <link linkend="gchar">gchar</link> *status);</programlisting>
126
 
<para>
127
 
</para><variablelist role="params">
128
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
129
 
<listitem><simpara>
130
 
</simpara></listitem></varlistentry>
131
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
132
 
<listitem><simpara>
133
 
</simpara></listitem></varlistentry>
134
 
</variablelist></refsect2>
135
 
<refsect2 id="empathy-idle-get-flash-state" role="function">
136
 
<title>empathy_idle_get_flash_state ()</title>
137
 
<indexterm zone="empathy-idle-get-flash-state"><primary sortas="empathy_idle_get_flash_state">empathy_idle_get_flash_state</primary></indexterm><programlisting><link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link>  empathy_idle_get_flash_state  (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);</programlisting>
138
 
<para>
139
 
</para><variablelist role="params">
140
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
141
 
<listitem><simpara>
142
 
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
144
 
</simpara></listitem></varlistentry>
145
 
</variablelist></refsect2>
146
 
<refsect2 id="empathy-idle-set-flash-state" role="function">
147
 
<title>empathy_idle_set_flash_state ()</title>
148
 
<indexterm zone="empathy-idle-set-flash-state"><primary sortas="empathy_idle_set_flash_state">empathy_idle_set_flash_state</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_idle_set_flash_state        (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
149
 
                                                         <link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link> state);</programlisting>
150
 
<para>
151
 
</para><variablelist role="params">
152
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
153
 
<listitem><simpara>
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>state</parameter>&#160;:</term>
156
 
<listitem><simpara>
157
 
</simpara></listitem></varlistentry>
158
 
</variablelist></refsect2>
159
 
<refsect2 id="empathy-idle-set-presence" role="function">
160
 
<title>empathy_idle_set_presence ()</title>
161
 
<indexterm zone="empathy-idle-set-presence"><primary sortas="empathy_idle_set_presence">empathy_idle_set_presence</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_idle_set_presence           (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
162
 
                                                         <link linkend="TpConnectionPresenceType">TpConnectionPresenceType</link> state,
163
 
                                                         const <link linkend="gchar">gchar</link> *status);</programlisting>
164
 
<para>
165
 
</para><variablelist role="params">
166
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
167
 
<listitem><simpara>
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>state</parameter>&#160;:</term>
170
 
<listitem><simpara>
171
 
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>status</parameter>&#160;:</term>
173
 
<listitem><simpara>
174
 
</simpara></listitem></varlistentry>
175
 
</variablelist></refsect2>
176
 
<refsect2 id="empathy-idle-get-auto-away" role="function">
177
 
<title>empathy_idle_get_auto_away ()</title>
178
 
<indexterm zone="empathy-idle-get-auto-away"><primary sortas="empathy_idle_get_auto_away">empathy_idle_get_auto_away</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            empathy_idle_get_auto_away          (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle);</programlisting>
179
 
<para>
180
 
</para><variablelist role="params">
181
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
182
 
<listitem><simpara>
183
 
</simpara></listitem></varlistentry>
184
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
185
 
</simpara></listitem></varlistentry>
186
 
</variablelist></refsect2>
187
 
<refsect2 id="empathy-idle-set-auto-away" role="function">
188
 
<title>empathy_idle_set_auto_away ()</title>
189
 
<indexterm zone="empathy-idle-set-auto-away"><primary sortas="empathy_idle_set_auto_away">empathy_idle_set_auto_away</primary></indexterm><programlisting><link linkend="void">void</link>                empathy_idle_set_auto_away          (<link linkend="EmpathyIdle">EmpathyIdle</link> *idle,
190
 
                                                         <link linkend="gboolean">gboolean</link> auto_away);</programlisting>
191
 
<para>
192
 
</para><variablelist role="params">
193
 
<varlistentry><term><parameter>idle</parameter>&#160;:</term>
194
 
<listitem><simpara>
195
 
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>auto_away</parameter>&#160;:</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem></varlistentry>
199
 
</variablelist></refsect2>
200
 
 
201
 
</refsect1>
202
 
<refsect1 id="EmpathyIdle.property-details" role="property_details">
203
 
<title role="property_details.title">Property Details</title>
204
 
<refsect2 id="EmpathyIdle--auto-away" role="property"><title>The <literal>&quot;auto-away&quot;</literal> property</title>
205
 
<indexterm zone="EmpathyIdle--auto-away"><primary sortas="EmpathyIdle:auto-away">EmpathyIdle:auto-away</primary></indexterm><programlisting>  &quot;auto-away&quot;                <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
206
 
<para>Should it set presence to away if inactive.</para><para>Default value: FALSE</para>
207
 
</refsect2>
208
 
<refsect2 id="EmpathyIdle--flash-state" role="property"><title>The <literal>&quot;flash-state&quot;</literal> property</title>
209
 
<indexterm zone="EmpathyIdle--flash-state"><primary sortas="EmpathyIdle:flash-state">EmpathyIdle:flash-state</primary></indexterm><programlisting>  &quot;flash-state&quot;              <link linkend="guint">guint</link>                 : Read / Write</programlisting>
210
 
<para>flash-state.</para><para>Allowed values: &lt;= 9</para>
211
 
<para>Default value: 0</para>
212
 
</refsect2>
213
 
<refsect2 id="EmpathyIdle--state" role="property"><title>The <literal>&quot;state&quot;</literal> property</title>
214
 
<indexterm zone="EmpathyIdle--state"><primary sortas="EmpathyIdle:state">EmpathyIdle:state</primary></indexterm><programlisting>  &quot;state&quot;                    <link linkend="guint">guint</link>                 : Read / Write</programlisting>
215
 
<para>state.</para><para>Allowed values: &lt;= 9</para>
216
 
<para>Default value: 0</para>
217
 
</refsect2>
218
 
<refsect2 id="EmpathyIdle--status" role="property"><title>The <literal>&quot;status&quot;</literal> property</title>
219
 
<indexterm zone="EmpathyIdle--status"><primary sortas="EmpathyIdle:status">EmpathyIdle:status</primary></indexterm><programlisting>  &quot;status&quot;                   <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
220
 
<para>status.</para><para>Default value: NULL</para>
221
 
</refsect2>
222
 
</refsect1>
223
 
 
224
 
 
225
 
 
226
 
 
227
 
</refentry>