/usr/share/gtk-doc/html/libinfinity-0.6/InfUser.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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfUser: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfUserTable.html" title="InfUserTable">
<link rel="next" href="libinfinity-0.6-InfAcl.html" title="Access Control Lists">
<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="#InfUser.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfUser.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfUser.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfUser.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfUserTable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libinfinity-0.6-InfAcl.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfUser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfUser.top_of_page"></a>InfUser</span></h2>
<p>InfUser — User in a <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfUser.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="InfUser.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">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-get-id" title="inf_user_get_id ()">inf_user_get_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-get-name" title="inf_user_get_name ()">inf_user_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="returnvalue">InfUserStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-get-status" title="inf_user_get_status ()">inf_user_get_status</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfUser.html#InfUserFlags" title="enum InfUserFlags"><span class="returnvalue">InfUserFlags</span></a>
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-get-flags" title="inf_user_get_flags ()">inf_user_get_flags</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-get-connection" title="inf_user_get_connection ()">inf_user_get_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-status-to-string" title="inf_user_status_to_string ()">inf_user_status_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfUser.html#inf-user-status-from-string" title="inf_user_status_from_string ()">inf_user_status_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfUser.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 class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</td>
<td class="property_name"><a class="link" href="InfUser.html#InfUser--connection" title="The “connection” property">connection</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfUser.html#InfUserFlags" title="enum InfUserFlags"><span class="type">InfUserFlags</span></a></td>
<td class="property_name"><a class="link" href="InfUser.html#InfUser--flags" title="The “flags” property">flags</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfUser.html#InfUser--id" title="The “id” property">id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfUser.html#InfUser--name" title="The “name” property">name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a></td>
<td class="property_name"><a class="link" href="InfUser.html#InfUser--status" title="The “status” property">status</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfUser.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfUser.html#InfUser-set-status" title="The “set-status” signal">set-status</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfUser.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">enum</td>
<td class="function_name"><a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus">InfUserStatus</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfUser.html#InfUserFlags" title="enum InfUserFlags">InfUserFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfUser.html#InfUser-struct" title="struct InfUser">InfUser</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfUser.html#InfUserClass" title="struct InfUserClass">InfUserClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfUser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">╰──</span> InfUserStatus
<a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
<span class="lineart">╰──</span> InfUserFlags
GObject
<span class="lineart">╰──</span> InfUser
<span class="lineart">╰──</span> <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser">InfAdoptedUser</a>
</pre>
</div>
<div class="refsect1">
<a name="InfUser.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-user.h>
</pre>
</div>
<div class="refsect1">
<a name="InfUser.description"></a><h2>Description</h2>
<p><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> represents a user in an <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>. The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> object stores
basic user information required in all kinds of sessions, that is the user
ID, user name, its status and auxiliary flags.</p>
</div>
<div class="refsect1">
<a name="InfUser.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-user-get-id"></a><h3>inf_user_get_id ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_user_get_id (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>Returns the ID of the given <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p>
<div class="refsect3">
<a name="inf-user-get-id.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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-get-id.returns"></a><h4>Returns</h4>
<p> A numerical User ID.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-get-name"></a><h3>inf_user_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
inf_user_get_name (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>Returns the name of the given <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p>
<div class="refsect3">
<a name="inf-user-get-name.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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-get-name.returns"></a><h4>Returns</h4>
<p> The user's name.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-get-status"></a><h3>inf_user_get_status ()</h3>
<pre class="programlisting"><a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="returnvalue">InfUserStatus</span></a>
inf_user_get_status (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>Returns the status of the given <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p>
<div class="refsect3">
<a name="inf-user-get-status.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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-get-status.returns"></a><h4>Returns</h4>
<p> The user's status.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-get-flags"></a><h3>inf_user_get_flags ()</h3>
<pre class="programlisting"><a class="link" href="InfUser.html#InfUserFlags" title="enum InfUserFlags"><span class="returnvalue">InfUserFlags</span></a>
inf_user_get_flags (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>Returns the flags for the given <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p>
<div class="refsect3">
<a name="inf-user-get-flags.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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-get-flags.returns"></a><h4>Returns</h4>
<p> The user's flags.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-get-connection"></a><h3>inf_user_get_connection ()</h3>
<pre class="programlisting"><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *
inf_user_get_connection (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>Returns a connection to the given <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>, or <code class="literal">NULL</code>. If a non-<code class="literal">NULL</code>
connection is returned, then this is the connection through which records
from that user come from. This means that, when this connection is closed,
then the user is no longer available. However, you cannot send something
to this connection expecting the user will receive it. For example,
in central messaging mode, this connection is always the publisher, because
all records from the user are relayed via the publisher.</p>
<p>If this functions returns <code class="literal">NULL</code>, this either means <em class="parameter"><code>user</code></em>
is a local user
(<a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set) or it is not available (status is
<a class="link" href="InfUser.html#INF-USER-UNAVAILABLE:CAPS"><code class="literal">INF_USER_UNAVAILABLE</code></a>).</p>
<div class="refsect3">
<a name="inf-user-get-connection.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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-get-connection.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-status-to-string"></a><h3>inf_user_status_to_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
inf_user_status_to_string (<em class="parameter"><code><a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a> status</code></em>);</pre>
<p>Returns a non-localized string identifying the given status. This is not
meant to be shown to a user, but rather to serialize a user status, for
example to store it in XML.</p>
<div class="refsect3">
<a name="inf-user-status-to-string.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>status</p></td>
<td class="parameter_description"><p>A value from the <a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a> enumeration.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-status-to-string.returns"></a><h4>Returns</h4>
<p> A static string representation of <em class="parameter"><code>status</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-status-from-string"></a><h3>inf_user_status_from_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_user_status_from_string (<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a> *status</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function does the opposite of <a class="link" href="InfUser.html#inf-user-status-to-string" title="inf_user_status_to_string ()"><code class="function">inf_user_status_to_string()</code></a>. It turns
the given string back to a <a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a>, storing the result in <em class="parameter"><code>status</code></em>
if <em class="parameter"><code>status</code></em>
is non-<code class="literal">NULL</code>. If <em class="parameter"><code>string</code></em>
is invalid, then <em class="parameter"><code>status</code></em>
is left
untouched, <em class="parameter"><code>error</code></em>
is set and <code class="literal">FALSE</code> is returned. Otherwise, the function
returns <code class="literal">TRUE</code>.</p>
<div class="refsect3">
<a name="inf-user-status-from-string.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>string</p></td>
<td class="parameter_description"><p>A string representation of a <a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>status</p></td>
<td class="parameter_description"><p>A pointer to a <a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a> value, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-user-status-from-string.returns"></a><h4>Returns</h4>
<p> When an error occured during the conversion, <code class="literal">FALSE</code> is returned,
and <code class="literal">TRUE</code> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfUser.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfUserStatus"></a><h3>enum InfUserStatus</h3>
<p>Different possible types of status an <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> can have.</p>
<div class="refsect3">
<a name="InfUserStatus.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INF-USER-ACTIVE:CAPS"></a>INF_USER_ACTIVE</p></td>
<td class="enum_member_description">
<p>The user is available and currently looking at this
session.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-USER-INACTIVE:CAPS"></a>INF_USER_INACTIVE</p></td>
<td class="enum_member_description">
<p>The user is available but currently not paying
attention to this session.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-USER-UNAVAILABLE:CAPS"></a>INF_USER_UNAVAILABLE</p></td>
<td class="enum_member_description">
<p>The user is not available, i.e. not joined into the
session.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfUserFlags"></a><h3>enum InfUserFlags</h3>
<p>Additional flags for <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p>
<div class="refsect3">
<a name="InfUserFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="INF-USER-LOCAL:CAPS"></a>INF_USER_LOCAL</p></td>
<td class="enum_member_description">
<p>The user is local, i.e. joined by the local instance.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfUser-struct"></a><h3>struct InfUser</h3>
<pre class="programlisting">struct InfUser;</pre>
<p><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</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="InfUserClass"></a><h3>struct InfUserClass</h3>
<pre class="programlisting">struct InfUserClass {
void (*set_status)(InfUser* user,
InfUserStatus status);
};
</pre>
<p>This structure contains virtual functions for the <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> class.</p>
<div class="refsect3">
<a name="InfUserClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfUserClass.set-status"></a>set_status</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to change the status of a user. This is a
hook for user subclasses to react on status change.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfUser.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfUser--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
<pre class="programlisting"> “connection” <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</pre>
<p>Connection to the user.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfUser--flags"></a><h3>The <code class="literal">“flags”</code> property</h3>
<pre class="programlisting"> “flags” <a class="link" href="InfUser.html#InfUserFlags" title="enum InfUserFlags"><span class="type">InfUserFlags</span></a></pre>
<p>Flags the user currently has.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfUser--id"></a><h3>The <code class="literal">“id”</code> property</h3>
<pre class="programlisting"> “id” <span class="type">guint</span></pre>
<p>A Unique User ID.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="InfUser--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre>
<p>The Name with which a user joined a session. Most servers ensure that it is unique.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="InfUser--status"></a><h3>The <code class="literal">“status”</code> property</h3>
<pre class="programlisting"> “status” <a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a></pre>
<p>Whether the user is currently available or not.</p>
<p>Flags: Read / Write</p>
<p>Default value: INF_USER_UNAVAILABLE</p>
</div>
</div>
<div class="refsect1">
<a name="InfUser.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfUser-set-status"></a><h3>The <code class="literal">“set-status”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user,
<a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a> status,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever the user's status changes. This is
basically the same as a notification for the <a class="link" href="InfUser.html#InfUser--status" title="The “status” property"><span class="type">“status”</span></a> property,
but it allows to access the previous user status when connecting before
the default signal handler.</p>
<div class="refsect3">
<a name="InfUser-set-status.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>user</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> that changes status.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>status</p></td>
<td class="parameter_description"><p>The new user status.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="InfUser.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|