~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201111172307

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-TpTextMixin.html

  • Committer: Ken VanDine
  • Date: 2011-11-17 20:53:21 UTC
  • mfrom: (1.6.34 upstream)
  • Revision ID: ken.vandine@canonical.com-20111117205321-l704j7kr1zgw5v9h
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch-obsolete.html" title="Obsolete modules">
9
9
<link rel="prev" href="telepathy-glib-debug-ansi.html" title="ANSI codes for debug messages">
10
10
<link rel="next" href="annotation-glossary.html" title="Annotation Glossary">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
42
42
 
43
43
                    <a class="link" href="telepathy-glib-TpTextMixin.html#TpTextMixin" title="TpTextMixin">TpTextMixin</a>;
44
44
struct              <a class="link" href="telepathy-glib-TpTextMixin.html#TpTextMixinClass" title="struct TpTextMixinClass">TpTextMixinClass</a>;
45
 
<span class="returnvalue">GQuark</span>              <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-get-offset-quark" title="tp_text_mixin_class_get_offset_quark ()">tp_text_mixin_class_get_offset_quark</a>
 
45
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-get-offset-quark" title="tp_text_mixin_class_get_offset_quark ()">tp_text_mixin_class_get_offset_quark</a>
46
46
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
47
 
<span class="returnvalue">GQuark</span>              <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-get-offset-quark" title="tp_text_mixin_get_offset_quark ()">tp_text_mixin_get_offset_quark</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
48
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-init" title="tp_text_mixin_class_init ()">tp_text_mixin_class_init</a>            (<em class="parameter"><code><span class="type">GObjectClass</span> *obj_cls</code></em>,
49
 
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>);
50
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-init" title="tp_text_mixin_init ()">tp_text_mixin_init</a>                  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
51
 
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>,
 
47
<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-get-offset-quark" title="tp_text_mixin_get_offset_quark ()">tp_text_mixin_get_offset_quark</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
 
48
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-init" title="tp_text_mixin_class_init ()">tp_text_mixin_class_init</a>            (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *obj_cls</code></em>,
 
49
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> offset</code></em>);
 
50
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-init" title="tp_text_mixin_init ()">tp_text_mixin_init</a>                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> offset</code></em>,
52
52
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *contacts_repo</code></em>);
53
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-set-message-types" title="tp_text_mixin_set_message_types ()">tp_text_mixin_set_message_types</a>     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
53
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-set-message-types" title="tp_text_mixin_set_message_types ()">tp_text_mixin_set_message_types</a>     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
54
54
                                                         <em class="parameter"><code>...</code></em>);
55
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-finalize" title="tp_text_mixin_finalize ()">tp_text_mixin_finalize</a>              (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
56
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive-with-flags" title="tp_text_mixin_receive_with_flags ()">tp_text_mixin_receive_with_flags</a>    (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
55
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-finalize" title="tp_text_mixin_finalize ()">tp_text_mixin_finalize</a>              (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);
 
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive-with-flags" title="tp_text_mixin_receive_with_flags ()">tp_text_mixin_receive_with_flags</a>    (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
57
57
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
58
58
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
59
59
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
60
60
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
61
61
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageFlags" title="enum TpChannelTextMessageFlags"><span class="type">TpChannelTextMessageFlags</span></a> flags</code></em>);
62
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive" title="tp_text_mixin_receive ()">tp_text_mixin_receive</a>               (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
62
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-receive" title="tp_text_mixin_receive ()">tp_text_mixin_receive</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
63
63
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
64
64
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
65
65
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
66
66
                                                         <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);
67
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-acknowledge-pending-messages" title="tp_text_mixin_acknowledge_pending_messages ()">tp_text_mixin_acknowledge_pending_messages</a>
68
 
                                                        (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
69
 
                                                         <em class="parameter"><code>const <span class="type">GArray</span> *ids</code></em>,
70
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
71
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-list-pending-messages" title="tp_text_mixin_list_pending_messages ()">tp_text_mixin_list_pending_messages</a> (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
72
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> clear</code></em>,
73
 
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> **ret</code></em>,
74
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
75
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-get-message-types" title="tp_text_mixin_get_message_types ()">tp_text_mixin_get_message_types</a>     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
76
 
                                                         <em class="parameter"><code><span class="type">GArray</span> **ret</code></em>,
77
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
78
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-clear" title="tp_text_mixin_clear ()">tp_text_mixin_clear</a>                 (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
79
 
<span class="returnvalue">gboolean</span>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-has-pending-messages" title="tp_text_mixin_has_pending_messages ()">tp_text_mixin_has_pending_messages</a>  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
67
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-acknowledge-pending-messages" title="tp_text_mixin_acknowledge_pending_messages ()">tp_text_mixin_acknowledge_pending_messages</a>
 
68
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
69
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *ids</code></em>,
 
70
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
71
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-list-pending-messages" title="tp_text_mixin_list_pending_messages ()">tp_text_mixin_list_pending_messages</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
72
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> clear</code></em>,
 
73
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> **ret</code></em>,
 
74
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
75
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-get-message-types" title="tp_text_mixin_get_message_types ()">tp_text_mixin_get_message_types</a>     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
76
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> **ret</code></em>,
 
77
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
78
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-clear" title="tp_text_mixin_clear ()">tp_text_mixin_clear</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);
 
79
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-has-pending-messages" title="tp_text_mixin_has_pending_messages ()">tp_text_mixin_has_pending_messages</a>  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
80
80
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> *first_sender</code></em>);
81
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-set-rescued" title="tp_text_mixin_set_rescued ()">tp_text_mixin_set_rescued</a>           (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);
82
 
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-iface-init" title="tp_text_mixin_iface_init ()">tp_text_mixin_iface_init</a>            (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
83
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);
 
81
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-set-rescued" title="tp_text_mixin_set_rescued ()">tp_text_mixin_set_rescued</a>           (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);
 
82
<span class="returnvalue">void</span>                <a class="link" href="telepathy-glib-TpTextMixin.html#tp-text-mixin-iface-init" title="tp_text_mixin_iface_init ()">tp_text_mixin_iface_init</a>            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> g_iface</code></em>,
 
83
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> iface_data</code></em>);
84
84
</pre>
85
85
</div>
86
86
<div class="refsect1">
136
136
<hr>
137
137
<div class="refsect2">
138
138
<a name="tp-text-mixin-class-get-offset-quark"></a><h3>tp_text_mixin_class_get_offset_quark ()</h3>
139
 
<pre class="programlisting"><span class="returnvalue">GQuark</span>              tp_text_mixin_class_get_offset_quark
 
139
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              tp_text_mixin_class_get_offset_quark
140
140
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
141
141
<p>
142
142
 
152
152
<hr>
153
153
<div class="refsect2">
154
154
<a name="tp-text-mixin-get-offset-quark"></a><h3>tp_text_mixin_get_offset_quark ()</h3>
155
 
<pre class="programlisting"><span class="returnvalue">GQuark</span>              tp_text_mixin_get_offset_quark      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
155
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              tp_text_mixin_get_offset_quark      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
156
156
<p>
157
157
 
158
158
</p>
167
167
<hr>
168
168
<div class="refsect2">
169
169
<a name="tp-text-mixin-class-init"></a><h3>tp_text_mixin_class_init ()</h3>
170
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_class_init            (<em class="parameter"><code><span class="type">GObjectClass</span> *obj_cls</code></em>,
171
 
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>);</pre>
 
170
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_class_init            (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> *obj_cls</code></em>,
 
171
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> offset</code></em>);</pre>
172
172
<p>
173
173
Initialize the text mixin. Should be called from the implementation's
174
174
class_init function like so:
175
175
</p>
176
176
<p>
177
177
</p>
178
 
<div class="informalexample"><pre class="programlisting">
179
 
tp_text_mixin_class_init ((GObjectClass *) klass,
180
 
                          G_STRUCT_OFFSET (SomeObjectClass, text_mixin));
181
 
</pre></div>
 
178
<div class="informalexample">
 
179
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
180
    <tbody>
 
181
      <tr>
 
182
        <td class="listing_lines" align="right"><pre>1
 
183
2</pre></td>
 
184
        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="telepathy-glib-TpTextMixin.html#tp-text-mixin-class-init">tp_text_mixin_class_init</a></span> <span class="gtkdoc opt">((</span>GObjectClass <span class="gtkdoc opt">*)</span> klass<span class="gtkdoc opt">,</span>
 
185
                          <span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-STRUCT-OFFSET:CAPS">G_STRUCT_OFFSET</a></span> <span class="gtkdoc opt">(</span>SomeObjectClass<span class="gtkdoc opt">,</span> text_mixin<span class="gtkdoc opt">));</span></pre></td>
 
186
      </tr>
 
187
    </tbody>
 
188
  </table>
 
189
</div>
 
190
 
182
191
<p>
183
192
</p>
184
193
<div class="variablelist"><table border="0">
198
207
<hr>
199
208
<div class="refsect2">
200
209
<a name="tp-text-mixin-init"></a><h3>tp_text_mixin_init ()</h3>
201
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_init                  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
202
 
                                                         <em class="parameter"><code><span class="type">glong</span> offset</code></em>,
 
210
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_init                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
211
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#glong"><span class="type">glong</span></a> offset</code></em>,
203
212
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle-repo.html#TpHandleRepoIface"><span class="type">TpHandleRepoIface</span></a> *contacts_repo</code></em>);</pre>
204
213
<p>
205
214
Initialize the text mixin. Should be called from the implementation's
207
216
</p>
208
217
<p>
209
218
</p>
210
 
<div class="informalexample"><pre class="programlisting">
211
 
tp_text_mixin_init ((GObject *) self,
212
 
                    G_STRUCT_OFFSET (SomeObject, text_mixin),
213
 
                    self-&gt;contact_repo);
214
 
</pre></div>
 
219
<div class="informalexample">
 
220
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
221
    <tbody>
 
222
      <tr>
 
223
        <td class="listing_lines" align="right"><pre>1
 
224
2
 
225
3</pre></td>
 
226
        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="telepathy-glib-TpTextMixin.html#tp-text-mixin-init">tp_text_mixin_init</a></span> <span class="gtkdoc opt">((</span>GObject <span class="gtkdoc opt">*)</span> self<span class="gtkdoc opt">,</span>
 
227
                    <span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#G-STRUCT-OFFSET:CAPS">G_STRUCT_OFFSET</a></span> <span class="gtkdoc opt">(</span>SomeObject<span class="gtkdoc opt">,</span> text_mixin<span class="gtkdoc opt">),</span>
 
228
                    self<span class="gtkdoc opt">-&gt;</span>contact_repo<span class="gtkdoc opt">);</span></pre></td>
 
229
      </tr>
 
230
    </tbody>
 
231
  </table>
 
232
</div>
 
233
 
215
234
<p>
216
235
</p>
217
236
<div class="variablelist"><table border="0">
235
254
<hr>
236
255
<div class="refsect2">
237
256
<a name="tp-text-mixin-set-message-types"></a><h3>tp_text_mixin_set_message_types ()</h3>
238
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_set_message_types     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
257
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_set_message_types     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
239
258
                                                         <em class="parameter"><code>...</code></em>);</pre>
240
259
<p>
241
260
Set the supported message types.
259
278
<hr>
260
279
<div class="refsect2">
261
280
<a name="tp-text-mixin-finalize"></a><h3>tp_text_mixin_finalize ()</h3>
262
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_finalize              (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
 
281
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_finalize              (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);</pre>
263
282
<p>
264
283
Free resources held by the text mixin.
265
284
</p>
274
293
<hr>
275
294
<div class="refsect2">
276
295
<a name="tp-text-mixin-receive-with-flags"></a><h3>tp_text_mixin_receive_with_flags ()</h3>
277
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_receive_with_flags    (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
296
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_text_mixin_receive_with_flags    (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
278
297
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
279
298
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
280
299
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
313
332
<tr>
314
333
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
315
334
<td>
316
 
<code class="literal">TRUE</code> on success; <code class="literal">FALSE</code> if the message was lost due to the memory
 
335
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the message was lost due to the memory
317
336
limit.</td>
318
337
</tr>
319
338
</tbody>
322
341
<hr>
323
342
<div class="refsect2">
324
343
<a name="tp-text-mixin-receive"></a><h3>tp_text_mixin_receive ()</h3>
325
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_receive               (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
344
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_text_mixin_receive               (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
326
345
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</code></em>,
327
346
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> sender</code></em>,
328
347
                                                         <em class="parameter"><code><span class="type">time_t</span> timestamp</code></em>,
357
376
<tr>
358
377
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
359
378
<td>
360
 
<code class="literal">TRUE</code> on success; <code class="literal">FALSE</code> if the message was lost due to the memory
 
379
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the message was lost due to the memory
361
380
limit.</td>
362
381
</tr>
363
382
</tbody>
366
385
<hr>
367
386
<div class="refsect2">
368
387
<a name="tp-text-mixin-acknowledge-pending-messages"></a><h3>tp_text_mixin_acknowledge_pending_messages ()</h3>
369
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_acknowledge_pending_messages
370
 
                                                        (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
371
 
                                                         <em class="parameter"><code>const <span class="type">GArray</span> *ids</code></em>,
372
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
388
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_text_mixin_acknowledge_pending_messages
 
389
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
390
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *ids</code></em>,
 
391
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
373
392
<p>
374
393
Implements D-Bus method AcknowledgePendingMessages
375
394
on interface org.freedesktop.Telepathy.Channel.Type.Text
401
420
<hr>
402
421
<div class="refsect2">
403
422
<a name="tp-text-mixin-list-pending-messages"></a><h3>tp_text_mixin_list_pending_messages ()</h3>
404
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_list_pending_messages (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
405
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> clear</code></em>,
406
 
                                                         <em class="parameter"><code><span class="type">GPtrArray</span> **ret</code></em>,
407
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
423
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_text_mixin_list_pending_messages (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
424
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> clear</code></em>,
 
425
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> **ret</code></em>,
 
426
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
408
427
<p>
409
428
Implements D-Bus method ListPendingMessages
410
429
on interface org.freedesktop.Telepathy.Channel.Type.Text
418
437
</tr>
419
438
<tr>
420
439
<td><p><span class="term"><em class="parameter"><code>clear</code></em> :</span></p></td>
421
 
<td>If <code class="literal">TRUE</code>, delete the pending messages from the queue</td>
 
440
<td>If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, delete the pending messages from the queue</td>
422
441
</tr>
423
442
<tr>
424
443
<td><p><span class="term"><em class="parameter"><code>ret</code></em> :</span></p></td>
440
459
<hr>
441
460
<div class="refsect2">
442
461
<a name="tp-text-mixin-get-message-types"></a><h3>tp_text_mixin_get_message_types ()</h3>
443
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_get_message_types     (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
444
 
                                                         <em class="parameter"><code><span class="type">GArray</span> **ret</code></em>,
445
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
462
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_text_mixin_get_message_types     (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
 
463
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Arrays.html#GArray"><span class="type">GArray</span></a> **ret</code></em>,
 
464
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
446
465
<p>
447
466
Return a newly allocated GArray of guint, representing message types
448
467
taken from <a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a>, through <em class="parameter"><code>ret</code></em>.
465
484
<tr>
466
485
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
467
486
<td>
468
 
<code class="literal">TRUE</code> on success</td>
 
487
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success</td>
469
488
</tr>
470
489
</tbody>
471
490
</table></div>
473
492
<hr>
474
493
<div class="refsect2">
475
494
<a name="tp-text-mixin-clear"></a><h3>tp_text_mixin_clear ()</h3>
476
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_clear                 (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
 
495
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_clear                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);</pre>
477
496
<p>
478
497
Clear the pending message queue, deleting all messages.
479
498
</p>
488
507
<hr>
489
508
<div class="refsect2">
490
509
<a name="tp-text-mixin-has-pending-messages"></a><h3>tp_text_mixin_has_pending_messages ()</h3>
491
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tp_text_mixin_has_pending_messages  (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>,
 
510
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tp_text_mixin_has_pending_messages  (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>,
492
511
                                                         <em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> *first_sender</code></em>);</pre>
493
512
<p>
494
513
Return whether the channel <em class="parameter"><code>obj</code></em> has unacknowledged messages. If so, and
495
 
<em class="parameter"><code>first_sender</code></em> is not <code class="literal">NULL</code>, the handle of the sender of the first message
 
514
<em class="parameter"><code>first_sender</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the handle of the sender of the first message
496
515
is placed in it, without incrementing the handle's reference count.
497
516
</p>
498
517
<div class="variablelist"><table border="0">
504
523
</tr>
505
524
<tr>
506
525
<td><p><span class="term"><em class="parameter"><code>first_sender</code></em> :</span></p></td>
507
 
<td>If not <code class="literal">NULL</code>, used to store the sender of the oldest pending
 
526
<td>If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, used to store the sender of the oldest pending
508
527
message</td>
509
528
</tr>
510
529
<tr>
511
530
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
512
531
<td>
513
 
<code class="literal">TRUE</code> if there are pending messages</td>
 
532
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there are pending messages</td>
514
533
</tr>
515
534
</tbody>
516
535
</table></div>
518
537
<hr>
519
538
<div class="refsect2">
520
539
<a name="tp-text-mixin-set-rescued"></a><h3>tp_text_mixin_set_rescued ()</h3>
521
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_set_rescued           (<em class="parameter"><code><span class="type">GObject</span> *obj</code></em>);</pre>
 
540
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_set_rescued           (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *obj</code></em>);</pre>
522
541
<p>
523
542
Mark all pending messages as having been "rescued" from a channel that
524
543
previously closed.
534
553
<hr>
535
554
<div class="refsect2">
536
555
<a name="tp-text-mixin-iface-init"></a><h3>tp_text_mixin_iface_init ()</h3>
537
 
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_iface_init            (<em class="parameter"><code><span class="type">gpointer</span> g_iface</code></em>,
538
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> iface_data</code></em>);</pre>
 
556
<pre class="programlisting"><span class="returnvalue">void</span>                tp_text_mixin_iface_init            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> g_iface</code></em>,
 
557
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> iface_data</code></em>);</pre>
539
558
<p>
540
559
Fill in this mixin's AcknowledgePendingMessages, GetMessageTypes and
541
560
ListPendingMessages implementations in the given interface vtable.
565
584
</div>
566
585
<div class="footer">
567
586
<hr>
568
 
          Generated by GTK-Doc V1.17</div>
 
587
          Generated by GTK-Doc V1.18</div>
569
588
</body>
570
589
</html>
 
 
b'\\ No newline at end of file'