/usr/share/gtk-doc/html/libinftextgtk-0.5/InfTextGtkBuffer.html is in libinfinity-0.5-doc 0.5.5-1.
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 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfTextGtkBuffer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinftextgtk-0.5 Reference Manual">
<link rel="up" href="ch01.html" title="libinftextgtk API">
<link rel="prev" href="ch01.html" title="libinftextgtk API">
<link rel="next" href="InfTextGtkView.html" title="InfTextGtkView">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinftextgtk-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfTextGtkView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfTextGtkBuffer.synopsis" class="shortcut">Top</a>
|
<a href="#InfTextGtkBuffer.description" class="shortcut">Description</a>
|
<a href="#InfTextGtkBuffer.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfTextGtkBuffer.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#InfTextGtkBuffer.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="InfTextGtkBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfTextGtkBuffer.top_of_page"></a>InfTextGtkBuffer</span></h2>
<p>InfTextGtkBuffer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="InfTextGtkBuffer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer-struct" title="InfTextGtkBuffer">InfTextGtkBuffer</a>;
<a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="returnvalue">InfTextGtkBuffer</span></a> * <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-new" title="inf_text_gtk_buffer_new ()">inf_text_gtk_buffer_new</a> (<em class="parameter"><code><span class="type">GtkTextBuffer</span> *buffer</code></em>,
<em class="parameter"><code><a href="../libinfinity-0.5/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);
<span class="returnvalue">GtkTextBuffer</span> * <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-text-buffer" title="inf_text_gtk_buffer_get_text_buffer ()">inf_text_gtk_buffer_get_text_buffer</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-active-user" title="inf_text_gtk_buffer_set_active_user ()">inf_text_gtk_buffer_set_active_user</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);
<a href="../libinftext-0.5/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> * <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-active-user" title="inf_text_gtk_buffer_get_active_user ()">inf_text_gtk_buffer_get_active_user</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<a href="../libinftext-0.5/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> * <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-author" title="inf_text_gtk_buffer_get_author ()">inf_text_gtk_buffer_get_author</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *location</code></em>);
<a href="../libinftext-0.5/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> * <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-user-for-tag" title="inf_text_gtk_buffer_get_user_for_tag ()">inf_text_gtk_buffer_get_user_for_tag</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextTag</span> *tag</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-is-author-toggle" title="inf_text_gtk_buffer_is_author_toggle ()">inf_text_gtk_buffer_is_author_toggle</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *iter</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-forward-to-author-toggle" title="inf_text_gtk_buffer_forward_to_author_toggle ()">inf_text_gtk_buffer_forward_to_author_toggle</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-backward-to-author-toggle" title="inf_text_gtk_buffer_backward_to_author_toggle ()">inf_text_gtk_buffer_backward_to_author_toggle</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-wake-on-cursor-movement" title="inf_text_gtk_buffer_set_wake_on_cursor_movement ()">inf_text_gtk_buffer_set_wake_on_cursor_movement</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> wake</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-wake-on-cursor-movement" title="inf_text_gtk_buffer_get_wake_on_cursor_movement ()">inf_text_gtk_buffer_get_wake_on_cursor_movement</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-ensure-author-tags-priority" title="inf_text_gtk_buffer_ensure_author_tags_priority ()">inf_text_gtk_buffer_ensure_author_tags_priority</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-saturation-value" title="inf_text_gtk_buffer_set_saturation_value ()">inf_text_gtk_buffer_set_saturation_value</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> saturation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-saturation" title="inf_text_gtk_buffer_get_saturation ()">inf_text_gtk_buffer_get_saturation</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">gdouble</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-value" title="inf_text_gtk_buffer_get_value ()">inf_text_gtk_buffer_get_value</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-show-user-colors" title="inf_text_gtk_buffer_set_show_user_colors ()">inf_text_gtk_buffer_set_show_user_colors</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-show-user-colors" title="inf_text_gtk_buffer_get_show_user_colors ()">inf_text_gtk_buffer_get_show_user_colors</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-show-user-colors" title="inf_text_gtk_buffer_show_user_colors ()">inf_text_gtk_buffer_show_user_colors</a>
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *start</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *end</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfTextGtkBuffer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----InfTextGtkBuffer
</pre>
</div>
<div class="refsect1">
<a name="InfTextGtkBuffer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfTextGtkBuffer implements
<a href="../libinfinity-0.5/InfBuffer.html">InfBuffer</a> and <a href="../libinftext-0.5/libinftext-0.5-inf-text-buffer.html#InfTextBuffer">InfTextBuffer</a>.</p>
</div>
<div class="refsect1">
<a name="InfTextGtkBuffer.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--active-user" title='The "active-user" property'>active-user</a>" <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>* : Read / Write
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--buffer" title='The "buffer" property'>buffer</a>" <span class="type">GtkTextBuffer</span>* : Read / Write / Construct Only
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--saturation" title='The "saturation" property'>saturation</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--show-user-colors" title='The "show-user-colors" property'>show-user-colors</a>" <span class="type">gboolean</span> : Read / Write
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--user-table" title='The "user-table" property'>user-table</a>" <a href="../libinfinity-0.5/InfUserTable.html"><span class="type">InfUserTable</span></a>* : Read / Write / Construct Only
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--value" title='The "value" property'>value</a>" <span class="type">gdouble</span> : Read / Write
"<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--wake-on-cursor-movement" title='The "wake-on-cursor-movement" property'>wake-on-cursor-movement</a>" <span class="type">gboolean</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="InfTextGtkBuffer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="InfTextGtkBuffer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfTextGtkBuffer-struct"></a><h3>InfTextGtkBuffer</h3>
<pre class="programlisting">typedef struct _InfTextGtkBuffer InfTextGtkBuffer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-new"></a><h3>inf_text_gtk_buffer_new ()</h3>
<pre class="programlisting"><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="returnvalue">InfTextGtkBuffer</span></a> * inf_text_gtk_buffer_new (<em class="parameter"><code><span class="type">GtkTextBuffer</span> *buffer</code></em>,
<em class="parameter"><code><a href="../libinfinity-0.5/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);</pre>
<p>
Creates a new <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> wrapping <em class="parameter"><code>buffer</code></em>. It implements the
<a href="../libinftext-0.5/libinftext-0.5-inf-text-buffer.html#InfTextBuffer"><span class="type">InfTextBuffer</span></a> interface by using <em class="parameter"><code>buffer</code></em> to store the text. User colors
are read from the users from <em class="parameter"><code>user_table</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>The underlaying <span class="type">GtkTextBuffer</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>The <a href="../libinfinity-0.5/InfUserTable.html"><span class="type">InfUserTable</span></a> containing the participating users.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-text-buffer"></a><h3>inf_text_gtk_buffer_get_text_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkTextBuffer</span> * inf_text_gtk_buffer_get_text_buffer (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the underlaying <span class="type">GtkTextBuffer</span>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">GtkTextBuffer</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-set-active-user"></a><h3>inf_text_gtk_buffer_set_active_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_text_gtk_buffer_set_active_user (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
<p>
Sets the active user for <em class="parameter"><code>buffer</code></em>. The active user is the user by which
edits not issued through the <a href="../libinftext-0.5/libinftext-0.5-inf-text-buffer.html#InfTextBuffer"><span class="type">InfTextBuffer</span></a> interface are performed (for
example, edits by the user when the underlaying buffer is displayed in
a <span class="type">GtkTextView</span>).
</p>
<p>
Note that such modifications should not be performed when no active user is
set. Note also the active user must be available and have the
<a href="../libinfinity-0.5/InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-active-user"></a><h3>inf_text_gtk_buffer_get_active_user ()</h3>
<pre class="programlisting"><a href="../libinftext-0.5/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> * inf_text_gtk_buffer_get_active_user (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the current active user for <em class="parameter"><code>buffer</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-author"></a><h3>inf_text_gtk_buffer_get_author ()</h3>
<pre class="programlisting"><a href="../libinftext-0.5/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> * inf_text_gtk_buffer_get_author (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *location</code></em>);</pre>
<p>
Returns the <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> which wrote the character at <em class="parameter"><code>location</code></em>. If there
is no such user, then <code class="literal">NULL</code> is returned.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
<td>A <span class="type">GtkTextIter</span> which is not the end iterator.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-user-for-tag"></a><h3>inf_text_gtk_buffer_get_user_for_tag ()</h3>
<pre class="programlisting"><a href="../libinftext-0.5/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> * inf_text_gtk_buffer_get_user_for_tag
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextTag</span> *tag</code></em>);</pre>
<p>
If <em class="parameter"><code>tag</code></em> is an author tag, i.e. used by <em class="parameter"><code>buffer</code></em> to mark text that a certain
user has written, then this function returns the <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> whose text is
marked by <em class="parameter"><code>tag</code></em>. If <em class="parameter"><code>tag</code></em> is not an author tag then the function returns
<code class="literal">NULL</code>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td>A <span class="type">GtkTextTag</span> from <em class="parameter"><code>buffer</code></em>'s underlying <span class="type">GtkTextBuffer</span>'s tag table.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-is-author-toggle"></a><h3>inf_text_gtk_buffer_is_author_toggle ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> inf_text_gtk_buffer_is_author_toggle
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code>const <span class="type">GtkTextIter</span> *iter</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);</pre>
<p>
This function returns <code class="literal">TRUE</code> if the author of the text in <em class="parameter"><code>buffer</code></em> changes
at <em class="parameter"><code>iter</code></em>, or <code class="literal">FALSE</code> otherwise. If it returns <code class="literal">TRUE</code>, then the user who
authored the text to the right hand side of <em class="parameter"><code>iter</code></em> is stored in <em class="parameter"><code>user_on</code></em> (if
non-<code class="literal">NULL</code>) and the author of the text to the left hand side of <em class="parameter"><code>iter</code></em> is
stored in <em class="parameter"><code>user_off</code></em> (if non-<code class="literal">NULL</code>). Both can also be set to <code class="literal">NULL</code> if there
is unowned text in the buffer or if <em class="parameter"><code>iter</code></em> is at the start or end of the
buffer.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <span class="type">GtkTextIter</span> pointing into <em class="parameter"><code>buffer</code></em>'s underlying <span class="type">GtkTextBuffer</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_on</code></em> :</span></p></td>
<td>A location to store a <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_off</code></em> :</span></p></td>
<td>Another location to store a <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether text attribution changes at <em class="parameter"><code>iter</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-forward-to-author-toggle"></a><h3>inf_text_gtk_buffer_forward_to_author_toggle ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> inf_text_gtk_buffer_forward_to_author_toggle
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);</pre>
<p>
Moves <em class="parameter"><code>iter</code></em> to the next point in <em class="parameter"><code>buffer</code></em>'s underlying <span class="type">GtkTextBuffer</span> where
the text has been written by another user. If <em class="parameter"><code>iter</code></em> points to the end of
the buffer, then the function does nothing and returns <code class="literal">FALSE</code>. Otherwise
it returns <code class="literal">TRUE</code> and sets <em class="parameter"><code>user_on</code></em> to the user which has written the text
on the right hand side of the location <em class="parameter"><code>iter</code></em> has been moved to (if
non-<code class="literal">NULL</code>) and <em class="parameter"><code>user_off</code></em> to the user which has written the left hand side
of the location <em class="parameter"><code>iter</code></em> has been moved to.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <span class="type">GtkTextIter</span> pointing into <em class="parameter"><code>buffer</code></em>'s underlying <span class="type">GtkTextBuffer</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_on</code></em> :</span></p></td>
<td>A location to store a <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_off</code></em> :</span></p></td>
<td>Another location to store a <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> was moved, or <code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-backward-to-author-toggle"></a><h3>inf_text_gtk_buffer_backward_to_author_toggle ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> inf_text_gtk_buffer_backward_to_author_toggle
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
<em class="parameter"><code><a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);</pre>
<p>
Moves <em class="parameter"><code>iter</code></em> to the previous point in <em class="parameter"><code>buffer</code></em>'s underlying <span class="type">GtkTextBuffer</span>
where the text has been written by another user. If <em class="parameter"><code>iter</code></em> points to the
beginning of the buffer, then the function does nothing and returns <code class="literal">FALSE</code>.
Otherwise it returns <code class="literal">TRUE</code> and sets <em class="parameter"><code>user_on</code></em> to the user which has written
the text on the right hand side of the location <em class="parameter"><code>iter</code></em> has been moved to (if
non-<code class="literal">NULL</code>) and <em class="parameter"><code>user_off</code></em> to the user which has written the left hand side
of the location <em class="parameter"><code>iter</code></em> has been moved to.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <span class="type">GtkTextIter</span> pointing into <em class="parameter"><code>buffer</code></em>'s underlying <span class="type">GtkTextBuffer</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_on</code></em> :</span></p></td>
<td>A location to store a <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_off</code></em> :</span></p></td>
<td>Another location to store a <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> was moved, or <code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-set-wake-on-cursor-movement"></a><h3>inf_text_gtk_buffer_set_wake_on_cursor_movement ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_text_gtk_buffer_set_wake_on_cursor_movement
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> wake</code></em>);</pre>
<p>
This function spcecifies whether movement of the insertion point or
selection bound of the underlying text buffer causes the active user
(see <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-active-user" title="inf_text_gtk_buffer_set_active_user ()"><code class="function">inf_text_gtk_buffer_set_active_user()</code></a>) to become active when its
status is <code class="literal">INF_USER_STATUS_INACTIVE</code>.
</p>
<p>
If <em class="parameter"><code>wake</code></em> is <code class="literal">TRUE</code>, then the user status changes to <code class="literal">INF_USER_STATUS_ACTIVE</code>
in that case. If <em class="parameter"><code>wake</code></em> is <code class="literal">FALSE</code>, then the user status stays
<code class="literal">INF_USER_STATUS_INACTIVE</code>, and its caret-position and selection-length
properties will be no longer be synchronized to the buffer marks until
the user is set active again.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wake</code></em> :</span></p></td>
<td>Whether to make inactive users active on cursor movement.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-wake-on-cursor-movement"></a><h3>inf_text_gtk_buffer_get_wake_on_cursor_movement ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> inf_text_gtk_buffer_get_wake_on_cursor_movement
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns whether movement of the insertion point or selection bound of the
underlying text buffer causes whether the active user (see
<a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-active-user" title="inf_text_gtk_buffer_set_active_user ()"><code class="function">inf_text_gtk_buffer_set_active_user()</code></a>) to become active when its status
is <code class="literal">INF_USER_STATUS_INACTIVE</code>. See also
<a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-wake-on-cursor-movement" title="inf_text_gtk_buffer_set_wake_on_cursor_movement ()"><code class="function">inf_text_gtk_buffer_set_wake_on_cursor_movement()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether to make inactive users active when the insertion mark
is moved.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-ensure-author-tags-priority"></a><h3>inf_text_gtk_buffer_ensure_author_tags_priority ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_text_gtk_buffer_ensure_author_tags_priority
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Ensures that all author tags have the lowest priority of all tags in the
underlying <span class="type">GtkTextBuffer</span>'s tag table. Normally you do not need to use
this function if you do not set the priority for your tags explicitely.
However, if you do (or are forced to do, because you are using a library
that does this, such as GtkSourceView), then you can call this function
afterwards to make sure all the user tags have the lowest priority.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-set-saturation-value"></a><h3>inf_text_gtk_buffer_set_saturation_value ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_text_gtk_buffer_set_saturation_value
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> saturation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> value</code></em>);</pre>
<p>
Sets the saturation and value to use for user colors in a HSV color model.
The hue is defined by each user's individual color. The reason why S and V
are set locally the same for all users is that they can be adjusted
depending on one's theme: Dark themes want dark user colors, bright themes
want bright ones.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>saturation</code></em> :</span></p></td>
<td>Saturation to use for user colors.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>Value to use for user colors.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-saturation"></a><h3>inf_text_gtk_buffer_get_saturation ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> inf_text_gtk_buffer_get_saturation (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the saturation part of the HSV user color.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The saturation used for user colors.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-value"></a><h3>inf_text_gtk_buffer_get_value ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span> inf_text_gtk_buffer_get_value (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the value part of the HSV user color.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value used for user colors.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-set-show-user-colors"></a><h3>inf_text_gtk_buffer_set_show_user_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_text_gtk_buffer_set_show_user_colors
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</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> (the default), then the user color is used as background
for newly written text by that user. Otherwise, newly written text has no
background color.
</p>
<p>
Note that this setting is for newly written text only. If you want to show
or hide user colors for existing text use
<a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-show-user-colors" title="inf_text_gtk_buffer_show_user_colors ()"><code class="function">inf_text_gtk_buffer_show_user_colors()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show</code></em> :</span></p></td>
<td>Whether to show user colors or not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-get-show-user-colors"></a><h3>inf_text_gtk_buffer_get_show_user_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> inf_text_gtk_buffer_get_show_user_colors
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns whether newly written text is attributed with the author's user
color or not.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if user color is applied to newly written text, or <code class="literal">FALSE</code>
otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-gtk-buffer-show-user-colors"></a><h3>inf_text_gtk_buffer_show_user_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_text_gtk_buffer_show_user_colors
(<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *start</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *end</code></em>);</pre>
<p>
If <em class="parameter"><code>show</code></em> is <code class="literal">FALSE</code>, then don't show user colors (which user wrote what
text) as the background of the text, in the range from <em class="parameter"><code>start</code></em> to <em class="parameter"><code>end</code></em>.
If <em class="parameter"><code>show</code></em> is <code class="literal">TRUE</code>, show user colors if they have previously been hidden
via a call to this function with <em class="parameter"><code>show</code></em> being <code class="literal">FALSE</code>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show</code></em> :</span></p></td>
<td>Whether to show or hide user colors.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td>Beginning of the range for which to show or hide user colors.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>End of the range for which to show or hide user colors.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfTextGtkBuffer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfTextGtkBuffer--active-user"></a><h3>The <code class="literal">"active-user"</code> property</h3>
<pre class="programlisting"> "active-user" <a href="../libinftext-0.5/InfTextUser.html"><span class="type">InfTextUser</span></a>* : Read / Write</pre>
<p>The user currently inserting text locally.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkBuffer--buffer"></a><h3>The <code class="literal">"buffer"</code> property</h3>
<pre class="programlisting"> "buffer" <span class="type">GtkTextBuffer</span>* : Read / Write / Construct Only</pre>
<p>The underlaying GtkTextBuffer.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkBuffer--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
<pre class="programlisting"> "saturation" <span class="type">gdouble</span> : Read / Write</pre>
<p>Saturation of user colors in a HSV color model.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.35</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkBuffer--show-user-colors"></a><h3>The <code class="literal">"show-user-colors"</code> property</h3>
<pre class="programlisting"> "show-user-colors" <span class="type">gboolean</span> : Read / Write</pre>
<p>Whether to show user colors initially for newly written text.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkBuffer--user-table"></a><h3>The <code class="literal">"user-table"</code> property</h3>
<pre class="programlisting"> "user-table" <a href="../libinfinity-0.5/InfUserTable.html"><span class="type">InfUserTable</span></a>* : Read / Write / Construct Only</pre>
<p>A user table of the participating users.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkBuffer--value"></a><h3>The <code class="literal">"value"</code> property</h3>
<pre class="programlisting"> "value" <span class="type">gdouble</span> : Read / Write</pre>
<p>Value of user colors in a HSV color model.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="InfTextGtkBuffer--wake-on-cursor-movement"></a><h3>The <code class="literal">"wake-on-cursor-movement"</code> property</h3>
<pre class="programlisting"> "wake-on-cursor-movement" <span class="type">gboolean</span> : Read / Write</pre>
<p>Whether to make inactive users active when the insertion mark in the TextBuffer moves.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|