/usr/share/gtk-doc/html/libinftextgtk-0.6/InfTextGtkView.html is in libinfinity-0.6-doc 0.6.7-1build1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfTextGtkView: libinftextgtk-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinftextgtk-0.6 Reference Manual">
<link rel="up" href="ch01.html" title="libinftextgtk API">
<link rel="prev" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer">
<link rel="next" href="InfTextGtkViewport.html" title="InfTextGtkViewport">
<meta name="generator" content="GTK-Doc V1.24 (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="#InfTextGtkView.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfTextGtkView.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfTextGtkView.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="InfTextGtkBuffer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfTextGtkViewport.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfTextGtkView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfTextGtkView.top_of_page"></a>InfTextGtkView</span></h2>
<p>InfTextGtkView — Drawing remote cursors and selections in a <span class="type">GtkTextView</span></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfTextGtkView.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="InfTextGtkView.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">
<a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="returnvalue">InfTextGtkView</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTextGtkView.html#inf-text-gtk-view-new" title="inf_text_gtk_view_new ()">inf_text_gtk_view_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkTextView</span> *
</td>
<td class="function_name">
<a class="link" href="InfTextGtkView.html#inf-text-gtk-view-get-text-view" title="inf_text_gtk_view_get_text_view ()">inf_text_gtk_view_get_text_view</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../libinfinity-0.6/InfUserTable.html"><span class="returnvalue">InfUserTable</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTextGtkView.html#inf-text-gtk-view-get-user-table" title="inf_text_gtk_view_get_user_table ()">inf_text_gtk_view_get_user_table</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="InfTextGtkView.html#inf-text-gtk-view-set-active-user" title="inf_text_gtk_view_set_active_user ()">inf_text_gtk_view_set_active_user</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../libinftext-0.6/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfTextGtkView.html#inf-text-gtk-view-get-active-user" title="inf_text_gtk_view_get_active_user ()">inf_text_gtk_view_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="InfTextGtkView.html#inf-text-gtk-view-set-show-remote-cursors" title="inf_text_gtk_view_set_show_remote_cursors ()">inf_text_gtk_view_set_show_remote_cursors</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="InfTextGtkView.html#inf-text-gtk-view-set-show-remote-selections" title="inf_text_gtk_view_set_show_remote_selections ()">inf_text_gtk_view_set_show_remote_selections</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="InfTextGtkView.html#inf-text-gtk-view-set-show-remote-current-lines" title="inf_text_gtk_view_set_show_remote_current_lines ()">inf_text_gtk_view_set_show_remote_current_lines</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfTextGtkView.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="../libinftext-0.6/InfTextUser.html"><span class="type">InfTextUser</span></a> *</td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--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="../libinfinity-0.6/InfIo.html"><span class="type">InfIo</span></a> *</td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--io" title="The “io” property">io</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--show-remote-current-lines" title="The “show-remote-current-lines” property">show-remote-current-lines</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--show-remote-cursors" title="The “show-remote-cursors” property">show-remote-cursors</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--show-remote-selections" title="The “show-remote-selections” property">show-remote-selections</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> *</td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--user-table" title="The “user-table” property">user-table</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">GtkTextView</span> *</td>
<td class="property_name"><a class="link" href="InfTextGtkView.html#InfTextGtkView--view" title="The “view” property">view</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfTextGtkView.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="InfTextGtkView.html#InfTextGtkView-struct" title="struct InfTextGtkView">InfTextGtkView</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfTextGtkView.html#InfTextGtkViewClass" title="struct InfTextGtkViewClass">InfTextGtkViewClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfTextGtkView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfTextGtkView
</pre>
</div>
<div class="refsect1">
<a name="InfTextGtkView.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinftextgtk/inf-text-gtk-view.h>
</pre>
</div>
<div class="refsect1">
<a name="InfTextGtkView.description"></a><h2>Description</h2>
<p><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> is a helper object which, as long as it is alive, draws
the cursor position, selected text of remote users into a <span class="type">GtkTextView</span>
widget. It can also highlight the current line of a remote user in a
similar way the <span class="type">GtkSourceView</span> widget can highlight the current line of
the local user.</p>
<p>This functionality was not implemented by subclassing <span class="type">GtkTextView</span> such
that it can also be used with existing subclasses, such as <span class="type">GtkSourceView</span>.</p>
<p>With the function <a class="link" href="InfTextGtkView.html#inf-text-gtk-view-set-active-user" title="inf_text_gtk_view_set_active_user ()"><code class="function">inf_text_gtk_view_set_active_user()</code></a> the local
<a href="../libinftext-0.6/InfTextUser.html"><span class="type">InfTextUser</span></a> who is editing the text can be set, if there is any. The
insertion position, seleceted text or current line are not drawn for this
user, since the normal <span class="type">GtkTextView</span> takes care of that already. This
assumes the local user cursor position and selection is synchronized to the
corresponding <a href="../libinftext-0.6/InfTextUser.html"><span class="type">InfTextUser</span></a> properties, which is automatically the case when
a <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> is used for the buffer the <span class="type">GtkTextView</span> is displaying.</p>
<p>See <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a> for drawing a marker at remote users' location into
the scrollbar.</p>
</div>
<div class="refsect1">
<a name="InfTextGtkView.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-text-gtk-view-new"></a><h3>inf_text_gtk_view_new ()</h3>
<pre class="programlisting"><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="returnvalue">InfTextGtkView</span></a> *
inf_text_gtk_view_new (<em class="parameter"><code><a href="../libinfinity-0.6/InfIo.html"><span class="type">InfIo</span></a> *io</code></em>,
<em class="parameter"><code><span class="type">GtkTextView</span> *view</code></em>,
<em class="parameter"><code><a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);</pre>
<p>Creates a new <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> for <em class="parameter"><code>view</code></em>
. This draws remote user's cursors
and selections into the text view.</p>
<div class="refsect3">
<a name="id-1.2.3.10.2.5"></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>io</p></td>
<td class="parameter_description"><p>A <a href="../libinfinity-0.6/InfIo.html"><span class="type">InfIo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>view</p></td>
<td class="parameter_description"><p>A <span class="type">GtkTextView</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_table</p></td>
<td class="parameter_description"><p>The <a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> for the text session displayed in <em class="parameter"><code>view</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.2.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-get-text-view"></a><h3>inf_text_gtk_view_get_text_view ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkTextView</span> *
inf_text_gtk_view_get_text_view (<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>);</pre>
<p>Returns the underlying <span class="type">GtkTextView</span>.</p>
<div class="refsect3">
<a name="id-1.2.3.10.3.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.3.6"></a><h4>Returns</h4>
<p> The <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>'s <span class="type">GtkTextView</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-get-user-table"></a><h3>inf_text_gtk_view_get_user_table ()</h3>
<pre class="programlisting"><a href="../libinfinity-0.6/InfUserTable.html"><span class="returnvalue">InfUserTable</span></a> *
inf_text_gtk_view_get_user_table (<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>);</pre>
<p>Returns the <a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> containing the users of the session the
<a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>'s <span class="type">GtkTextView</span> is displaying.</p>
<div class="refsect3">
<a name="id-1.2.3.10.4.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.4.6"></a><h4>Returns</h4>
<p> The <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>'s <a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-set-active-user"></a><h3>inf_text_gtk_view_set_active_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_text_gtk_view_set_active_user (<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>,
<em class="parameter"><code><a href="../libinftext-0.6/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
<p>Sets the user for which perspective to draw the view. The selection and
cursor position is not drawn for this user since it is assumed that the
view's buffer cursor position and selection match the active user ones
(which is automatically the case if the buffer is managed by a
<a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>).</p>
<div class="refsect3">
<a name="id-1.2.3.10.5.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</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 user from <em class="parameter"><code>view</code></em>
's user table, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-get-active-user"></a><h3>inf_text_gtk_view_get_active_user ()</h3>
<pre class="programlisting"><a href="../libinftext-0.6/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *
inf_text_gtk_view_get_active_user (<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>);</pre>
<p>Returns the active user of <em class="parameter"><code>view</code></em>
. See <a class="link" href="InfTextGtkView.html#inf-text-gtk-view-set-active-user" title="inf_text_gtk_view_set_active_user ()"><code class="function">inf_text_gtk_view_set_active_user()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.3.10.6.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.10.6.6"></a><h4>Returns</h4>
<p> The active user of <em class="parameter"><code>view</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-set-show-remote-cursors"></a><h3>inf_text_gtk_view_set_show_remote_cursors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_text_gtk_view_set_show_remote_cursors
(<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show</code></em>);</pre>
<p>If <em class="parameter"><code>show</code></em>
is <code class="literal">TRUE</code> then <em class="parameter"><code>view</code></em>
draws a cursor for each non-local user in
<a href="../libinfinity-0.6/InfUser.html#INF-USER-ACTIVE:CAPS"><code class="literal">INF_USER_ACTIVE</code></a> status in that user's color into its underlying
<span class="type">GtkTextView</span>. If it is <code class="literal">FALSE</code> then remote cursors are not drawn.</p>
<div class="refsect3">
<a name="id-1.2.3.10.7.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show</p></td>
<td class="parameter_description"><p>Whether to show cursors of non-local users.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-set-show-remote-selections"></a><h3>inf_text_gtk_view_set_show_remote_selections ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_text_gtk_view_set_show_remote_selections
(<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show</code></em>);</pre>
<p>If <em class="parameter"><code>show</code></em>
is <code class="literal">TRUE</code> then <em class="parameter"><code>view</code></em>
draws the selection ranges for each non-local
user in <a href="../libinfinity-0.6/InfUser.html#INF-USER-ACTIVE:CAPS"><code class="literal">INF_USER_ACTIVE</code></a> status. The selection range is drawn shaded in
that user's color on top of the author color which indicates who wrote the
selected text. If more than one user has a given piece of text selected
then an alternating stripe pattern with each of the user's colors is drawn.
If <em class="parameter"><code>show</code></em>
is <code class="literal">FALSE</code> then selection ranges of remote users are not drawn.</p>
<div class="refsect3">
<a name="id-1.2.3.10.8.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show</p></td>
<td class="parameter_description"><p>Whether to show selections of non-local users.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-view-set-show-remote-current-lines"></a><h3>inf_text_gtk_view_set_show_remote_current_lines ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_text_gtk_view_set_show_remote_current_lines
(<em class="parameter"><code><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a> *view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show</code></em>);</pre>
<p>If <em class="parameter"><code>show</code></em>
is <code class="literal">TRUE</code> then all lines in which the cursor of a non-local user
in <a href="../libinfinity-0.6/InfUser.html#INF-USER-ACTIVE:CAPS"><code class="literal">INF_USER_ACTIVE</code></a> status is is highlighted with that user's color, similar
to GtkSourceView's "highlight current line" functionality. If it is <code class="literal">FALSE</code>
then the current line of non-local users is not highlighted.</p>
<div class="refsect3">
<a name="id-1.2.3.10.9.5"></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>view</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show</p></td>
<td class="parameter_description"><p>Whether to highlight the current line of non-local users.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfTextGtkView.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfTextGtkView-struct"></a><h3>struct InfTextGtkView</h3>
<pre class="programlisting">struct InfTextGtkView;</pre>
<p><a class="link" href="InfTextGtkView.html" title="InfTextGtkView"><span class="type">InfTextGtkView</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="InfTextGtkViewClass"></a><h3>struct InfTextGtkViewClass</h3>
<pre class="programlisting">struct InfTextGtkViewClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfTextGtkView.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfTextGtkView--active-user"></a><h3>The <code class="literal">“active-user”</code> property</h3>
<pre class="programlisting"> “active-user” <a href="../libinftext-0.6/InfTextUser.html"><span class="type">InfTextUser</span></a> *</pre>
<p>The user for which to show the view.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkView--io"></a><h3>The <code class="literal">“io”</code> property</h3>
<pre class="programlisting"> “io” <a href="../libinfinity-0.6/InfIo.html"><span class="type">InfIo</span></a> *</pre>
<p>The IO object to schedule timeouts.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkView--show-remote-current-lines"></a><h3>The <code class="literal">“show-remote-current-lines”</code> property</h3>
<pre class="programlisting"> “show-remote-current-lines” <span class="type">gboolean</span></pre>
<p>Whether to highlight the line in which the cursor of non-local users is.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkView--show-remote-cursors"></a><h3>The <code class="literal">“show-remote-cursors”</code> property</h3>
<pre class="programlisting"> “show-remote-cursors” <span class="type">gboolean</span></pre>
<p>Whether to show cursors of non-local users.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkView--show-remote-selections"></a><h3>The <code class="literal">“show-remote-selections”</code> property</h3>
<pre class="programlisting"> “show-remote-selections” <span class="type">gboolean</span></pre>
<p>Whether to highlight text selected by non-local users.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkView--user-table"></a><h3>The <code class="literal">“user-table”</code> property</h3>
<pre class="programlisting"> “user-table” <a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> *</pre>
<p>The user table containing the users of the session shown in the view.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkView--view"></a><h3>The <code class="literal">“view”</code> property</h3>
<pre class="programlisting"> “view” <span class="type">GtkTextView</span> *</pre>
<p>The underlying GtkTextView.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfTextGtkView.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>, <a class="link" href="InfTextGtkViewport.html" title="InfTextGtkViewport"><span class="type">InfTextGtkViewport</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|