/usr/share/gtk-doc/html/libinfgtk-0.6/InfGtkChat.html is in libinfinity-0.6-doc 0.6.7-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfGtkChat: libinfgtk-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfgtk-0.6 Reference Manual">
<link rel="up" href="ch01.html" title="libinfgtk API">
<link rel="prev" href="InfGtkCertificateView.html" title="InfGtkCertificateView">
<link rel="next" href="InfGtkAclSheetView.html" title="InfGtkAclSheetView">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#InfGtkChat.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfGtkChat.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfGtkChat.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfGtkChat.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfGtkCertificateView.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfGtkAclSheetView.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfGtkChat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfGtkChat.top_of_page"></a>InfGtkChat</span></h2>
<p>InfGtkChat — Gtk interface to <a href="../html/InfChatSession.html#InfChatSession-struct"><span class="type">InfChatSession</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfGtkChat.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfGtkChat.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="InfGtkChat.html#inf-gtk-chat-new" title="inf_gtk_chat_new ()">inf_gtk_chat_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()">inf_gtk_chat_set_session</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/InfUser.html#InfUser-struct"><span class="returnvalue">InfUser</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfGtkChat.html#inf-gtk-chat-get-active-user" title="inf_gtk_chat_get_active_user ()">inf_gtk_chat_get_active_user</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-active-user" title="inf_gtk_chat_set_active_user ()">inf_gtk_chat_set_active_user</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="InfGtkChat.html#inf-gtk-chat-get-entry" title="inf_gtk_chat_get_entry ()">inf_gtk_chat_get_entry</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfGtkChat.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../html/InfUser.html#InfUser-struct"><span class="type">InfUser</span></a> *</td>
<td class="property_name"><a class="link" href="InfGtkChat.html#InfGtkChat--active-user" title="The “active-user” property">active-user</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../html/InfChatSession.html#InfChatSession-struct"><span class="type">InfChatSession</span></a> *</td>
<td class="property_name"><a class="link" href="InfGtkChat.html#InfGtkChat--session" title="The “session” property">session</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfGtkChat.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfGtkChat.html#InfGtkChat-struct" title="struct InfGtkChat">InfGtkChat</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfGtkChat.html#InfGtkChatClass" title="struct InfGtkChatClass">InfGtkChatClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfGtkChat.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> GtkWidget
<span class="lineart">╰──</span> GtkContainer
<span class="lineart">╰──</span> GtkBox
<span class="lineart">╰──</span> GtkVBox
<span class="lineart">╰──</span> InfGtkChat
</pre>
</div>
<div class="refsect1">
<a name="InfGtkChat.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfGtkChat implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
</div>
<div class="refsect1">
<a name="InfGtkChat.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfgtk/inf-gtk-chat.h>
</pre>
</div>
<div class="refsect1">
<a name="InfGtkChat.description"></a><h2>Description</h2>
<p><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> is a widget showing a <a href="../html/InfChatSession.html#InfChatSession-struct"><span class="type">InfChatSession</span></a> conversation. Use
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()"><code class="function">inf_gtk_chat_set_session()</code></a> to set the session whose conversation to show
in the widget. If you have a local user in the session you can also call
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-active-user" title="inf_gtk_chat_set_active_user ()"><code class="function">inf_gtk_chat_set_active_user()</code></a>. In this case the input text entry is made
available and messages are sent via that user.</p>
</div>
<div class="refsect1">
<a name="InfGtkChat.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-gtk-chat-new"></a><h3>inf_gtk_chat_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
inf_gtk_chat_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>. To show a chat conversation set a session to
show via <a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()"><code class="function">inf_gtk_chat_set_session()</code></a>.</p>
<div class="refsect3">
<a name="inf-gtk-chat-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-gtk-chat-set-session"></a><h3>inf_gtk_chat_set_session ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_gtk_chat_set_session (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>,
<em class="parameter"><code><a href="../html/InfChatSession.html#InfChatSession-struct"><span class="type">InfChatSession</span></a> *session</code></em>);</pre>
<p>Sets the chat session to show in the chat widget. If there is a previous
session set the chat view will be cleared before showing the new session.
If the previous session had an active user set it will be unset. If
<em class="parameter"><code>session</code></em>
is <code class="literal">NULL</code> this function just clears the chat view and unsets the
active user, if any.</p>
<div class="refsect3">
<a name="inf-gtk-chat-set-session.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chat</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>The <a href="../html/InfChatSession.html#InfChatSession-struct"><span class="type">InfChatSession</span></a> to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-gtk-chat-get-active-user"></a><h3>inf_gtk_chat_get_active_user ()</h3>
<pre class="programlisting"><a href="../html/InfUser.html#InfUser-struct"><span class="returnvalue">InfUser</span></a> *
inf_gtk_chat_get_active_user (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>);</pre>
<p>Returns the active user for <em class="parameter"><code>chat</code></em>
as set with
<a class="link" href="InfGtkChat.html#inf-gtk-chat-set-active-user" title="inf_gtk_chat_set_active_user ()"><code class="function">inf_gtk_chat_set_active_user()</code></a>.</p>
<div class="refsect3">
<a name="inf-gtk-chat-get-active-user.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>chat</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-gtk-chat-get-active-user.returns"></a><h4>Returns</h4>
<p> The chat's active user, or <code class="literal">NULL</code> if there is none.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-gtk-chat-set-active-user"></a><h3>inf_gtk_chat_set_active_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_gtk_chat_set_active_user (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>,
<em class="parameter"><code><a href="../html/InfUser.html#InfUser-struct"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>Sets the active user for the chat. This must be a user in the chat's
session's user table and it must have the <a href="../html/InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set, i.e.
you need to have it joined before using <a href="../html/InfSessionProxy.html#inf-session-proxy-join-user"><code class="function">inf_session_proxy_join_user()</code></a>.</p>
<p>If an active user is set the chat's text entry is made sensitive and the
user can type chat messages. They are sent to the session as originated by
<em class="parameter"><code>user</code></em>
. If <em class="parameter"><code>user</code></em>
's status changes to <a href="../html/InfUser.html#INF-USER-UNAVAILABLE:CAPS"><code class="literal">INF_USER_UNAVAILABLE</code></a> or the
<a href="../html/InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag is removed the active user will be unset
automatically.</p>
<p>This cannot be called when the chat has no session set yet.
Use <a class="link" href="InfGtkChat.html#inf-gtk-chat-set-session" title="inf_gtk_chat_set_session ()"><code class="function">inf_gtk_chat_set_session()</code></a> first.</p>
<div class="refsect3">
<a name="inf-gtk-chat-set-active-user.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>chat</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p>A local <a href="../html/InfUser.html#InfUser-struct"><span class="type">InfUser</span></a> which joined chat's session.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-gtk-chat-get-entry"></a><h3>inf_gtk_chat_get_entry ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
inf_gtk_chat_get_entry (<em class="parameter"><code><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> *chat</code></em>);</pre>
<p>Returns the chat's text input entry.</p>
<div class="refsect3">
<a name="inf-gtk-chat-get-entry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>chat</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-gtk-chat-get-entry.returns"></a><h4>Returns</h4>
<p> The chat's <span class="type">GtkEntry</span>. This is owned by the chat, so you don't
need to free it.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfGtkChat.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfGtkChat-struct"></a><h3>struct InfGtkChat</h3>
<pre class="programlisting">struct InfGtkChat;</pre>
<p><a class="link" href="InfGtkChat.html" title="InfGtkChat"><span class="type">InfGtkChat</span></a> is an opaque data type. You should only access it via the
public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfGtkChatClass"></a><h3>struct InfGtkChatClass</h3>
<pre class="programlisting">struct InfGtkChatClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfGtkChat.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfGtkChat--active-user"></a><h3>The <code class="literal">“active-user”</code> property</h3>
<pre class="programlisting"> “active-user” <a href="../html/InfUser.html#InfUser-struct"><span class="type">InfUser</span></a> *</pre>
<p>The user outgoing messages come from.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfGtkChat--session"></a><h3>The <code class="literal">“session”</code> property</h3>
<pre class="programlisting"> “session” <a href="../html/InfChatSession.html#InfChatSession-struct"><span class="type">InfChatSession</span></a> *</pre>
<p>The chat session this widget is displaying.</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|