/usr/share/gtk-doc/html/clutter/ClutterTextBuffer.html is in libclutter-1.0-doc 1.16.4-0ubuntu2.
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 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Clutter Reference Manual: ClutterTextBuffer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch10.html" title="General purpose API">
<link rel="prev" href="clutter-Stage-Manager.html" title="Stage Manager">
<link rel="next" href="clutter-Unit-conversion.html" title="Unit conversion">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#ClutterTextBuffer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterTextBuffer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterTextBuffer.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterTextBuffer.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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="clutter-Stage-Manager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Unit-conversion.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterTextBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterTextBuffer.top_of_page"></a>ClutterTextBuffer</span></h2>
<p>ClutterTextBuffer — Text buffer for ClutterText</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterTextBuffer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-new" title="clutter_text_buffer_new ()">clutter_text_buffer_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-new-with-text" title="clutter_text_buffer_new_with_text ()">clutter_text_buffer_new_with_text</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="ClutterTextBuffer.html#clutter-text-buffer-set-text" title="clutter_text_buffer_set_text ()">clutter_text_buffer_set_text</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="ClutterTextBuffer.html#clutter-text-buffer-get-text" title="clutter_text_buffer_get_text ()">clutter_text_buffer_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gsize</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-get-bytes" title="clutter_text_buffer_get_bytes ()">clutter_text_buffer_get_bytes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-get-length" title="clutter_text_buffer_get_length ()">clutter_text_buffer_get_length</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="ClutterTextBuffer.html#clutter-text-buffer-set-max-length" title="clutter_text_buffer_set_max_length ()">clutter_text_buffer_set_max_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-get-max-length" title="clutter_text_buffer_get_max_length ()">clutter_text_buffer_get_max_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-insert-text" title="clutter_text_buffer_insert_text ()">clutter_text_buffer_insert_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-delete-text" title="clutter_text_buffer_delete_text ()">clutter_text_buffer_delete_text</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="ClutterTextBuffer.html#clutter-text-buffer-emit-inserted-text" title="clutter_text_buffer_emit_inserted_text ()">clutter_text_buffer_emit_inserted_text</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="ClutterTextBuffer.html#clutter-text-buffer-emit-deleted-text" title="clutter_text_buffer_emit_deleted_text ()">clutter_text_buffer_emit_deleted_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer--length" title="The “length” property">length</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer--max-length" title="The “max-length” property">max-length</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer--text" title="The “text” property">text</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table 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="ClutterTextBuffer.html#ClutterTextBuffer-deleted-text" title="The “deleted-text” signal">deleted-text</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer-inserted-text" title="The “inserted-text” signal">inserted-text</a></td>
<td class="signal_flags">Run First</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ClutterTextBuffer.html#CLUTTER-TEXT-BUFFER-MAX-SIZE:CAPS" title="CLUTTER_TEXT_BUFFER_MAX_SIZE">CLUTTER_TEXT_BUFFER_MAX_SIZE</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer-struct" title="struct ClutterTextBuffer">ClutterTextBuffer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterTextBuffer.html#ClutterTextBufferClass" title="struct ClutterTextBufferClass">ClutterTextBufferClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ClutterTextBuffer
</pre>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.description"></a><h2>Description</h2>
<p>The <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> class contains the actual text displayed in a
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> widget.</p>
<p>A single <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object can be shared by multiple <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
widgets which will then share the same text content, but not the cursor
position, visibility attributes, icon etc.</p>
<p><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> may be derived from. Such a derived class might allow
text to be stored in an alternate location, such as non-pageable memory,
useful in the case of important passwords. Or a derived class could
integrate with an application's concept of undo/redo.</p>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-text-buffer-new"></a><h3>clutter_text_buffer_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
clutter_text_buffer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new ClutterTextBuffer object.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.2.5"></a><h4>Returns</h4>
<p> A new ClutterTextBuffer object.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-new-with-text"></a><h3>clutter_text_buffer_new_with_text ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
clutter_text_buffer_new_with_text (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
<em class="parameter"><code><span class="type">gssize</span> text_len</code></em>);</pre>
<p>Create a new ClutterTextBuffer object with some text.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>text</p></td>
<td class="parameter_description"><p> initial buffer text. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>text_len</p></td>
<td class="parameter_description"><p>initial buffer text length, or -1 for null-terminated.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.3.6"></a><h4>Returns</h4>
<p> A new ClutterTextBuffer object.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-set-text"></a><h3>clutter_text_buffer_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_buffer_set_text (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *chars</code></em>,
<em class="parameter"><code><span class="type">gint</span> n_chars</code></em>);</pre>
<p>Sets the text in the buffer.</p>
<p>This is roughly equivalent to calling <a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-delete-text" title="clutter_text_buffer_delete_text ()"><code class="function">clutter_text_buffer_delete_text()</code></a>
and <a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-insert-text" title="clutter_text_buffer_insert_text ()"><code class="function">clutter_text_buffer_insert_text()</code></a>.</p>
<p>Note that <em class="parameter"><code>n_chars</code></em>
is in characters, not in bytes.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.4.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>chars</p></td>
<td class="parameter_description"><p>the new text</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>the number of characters in <em class="parameter"><code>text</code></em>
, or -1</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-get-text"></a><h3>clutter_text_buffer_get_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_text_buffer_get_text (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
<p>Retrieves the contents of the buffer.</p>
<p>The memory pointer returned by this call will not change
unless this object emits a signal, or is finalized.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.5.7"></a><h4>Returns</h4>
<p> a pointer to the contents of the widget as a
string. This string points to internally allocated
storage in the buffer and must not be freed, modified or
stored.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-get-bytes"></a><h3>clutter_text_buffer_get_bytes ()</h3>
<pre class="programlisting"><span class="returnvalue">gsize</span>
clutter_text_buffer_get_bytes (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
<p>Retrieves the length in bytes of the buffer.
See <a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-get-length" title="clutter_text_buffer_get_length ()"><code class="function">clutter_text_buffer_get_length()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.6.6"></a><h4>Returns</h4>
<p> The byte length of the buffer.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-get-length"></a><h3>clutter_text_buffer_get_length ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_text_buffer_get_length (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
<p>Retrieves the length in characters of the buffer.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.7.6"></a><h4>Returns</h4>
<p> The number of characters in the buffer.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-set-max-length"></a><h3>clutter_text_buffer_set_max_length ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_buffer_set_max_length (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">gint</span> max_length</code></em>);</pre>
<p>Sets the maximum allowed length of the contents of the buffer. If
the current contents are longer than the given length, then they
will be truncated to fit.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_length</p></td>
<td class="parameter_description"><p>the maximum length of the entry buffer, or 0 for no maximum.
(other than the maximum length of entries.) The value passed in will
be clamped to the range [ 0, <a class="link" href="ClutterTextBuffer.html#CLUTTER-TEXT-BUFFER-MAX-SIZE:CAPS" title="CLUTTER_TEXT_BUFFER_MAX_SIZE"><code class="literal">CLUTTER_TEXT_BUFFER_MAX_SIZE</code></a> ].</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-get-max-length"></a><h3>clutter_text_buffer_get_max_length ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_text_buffer_get_max_length (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
<p>Retrieves the maximum allowed length of the text in
<em class="parameter"><code>buffer</code></em>
. See <a class="link" href="ClutterTextBuffer.html#clutter-text-buffer-set-max-length" title="clutter_text_buffer_set_max_length ()"><code class="function">clutter_text_buffer_set_max_length()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.9.6"></a><h4>Returns</h4>
<p> the maximum allowed number of characters
in <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>, or 0 if there is no maximum.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-insert-text"></a><h3>clutter_text_buffer_insert_text ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_text_buffer_insert_text (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">guint</span> position</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *chars</code></em>,
<em class="parameter"><code><span class="type">gint</span> n_chars</code></em>);</pre>
<p>Inserts <em class="parameter"><code>n_chars</code></em>
characters of <em class="parameter"><code>chars</code></em>
into the contents of the
buffer, at position <em class="parameter"><code>position</code></em>
.</p>
<p>If <em class="parameter"><code>n_chars</code></em>
is negative, then characters from chars will be inserted
until a null-terminator is found. If <em class="parameter"><code>position</code></em>
or <em class="parameter"><code>n_chars</code></em>
are out of
bounds, or the maximum buffer text length is exceeded, then they are
coerced to sane values.</p>
<p>Note that the position and length are in characters, not in bytes.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.10.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position at which to insert text.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>chars</p></td>
<td class="parameter_description"><p>the text to insert into the buffer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>the length of the text in characters, or -1</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.10.8"></a><h4>Returns</h4>
<p> The number of characters actually inserted.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-delete-text"></a><h3>clutter_text_buffer_delete_text ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_text_buffer_delete_text (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">guint</span> position</code></em>,
<em class="parameter"><code><span class="type">gint</span> n_chars</code></em>);</pre>
<p>Deletes a sequence of characters from the buffer. <em class="parameter"><code>n_chars</code></em>
characters are
deleted starting at <em class="parameter"><code>position</code></em>
. If <em class="parameter"><code>n_chars</code></em>
is negative, then all characters
until the end of the text are deleted.</p>
<p>If <em class="parameter"><code>position</code></em>
or <em class="parameter"><code>n_chars</code></em>
are out of bounds, then they are coerced to sane
values.</p>
<p>Note that the positions are specified in characters, not bytes.</p>
<div class="refsect3">
<a name="id-1.7.2.13.9.11.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>position at which to delete text</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>number of characters to delete</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.13.9.11.8"></a><h4>Returns</h4>
<p> The number of characters deleted.</p>
<p></p>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-emit-inserted-text"></a><h3>clutter_text_buffer_emit_inserted_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_buffer_emit_inserted_text
(<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">guint</span> position</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *chars</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);</pre>
<p>Emits the <a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer-inserted-text" title="The “inserted-text” signal"><span class="type">“inserted-text”</span></a> signal on <em class="parameter"><code>buffer</code></em>
.</p>
<p>Used when subclassing <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p>
<div class="refsect3">
<a name="id-1.7.2.13.9.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>position at which text was inserted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>chars</p></td>
<td class="parameter_description"><p>text that was inserted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>number of characters inserted</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-buffer-emit-deleted-text"></a><h3>clutter_text_buffer_emit_deleted_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_buffer_emit_deleted_text (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><span class="type">guint</span> position</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);</pre>
<p>Emits the <a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer-deleted-text" title="The “deleted-text” signal"><span class="type">“deleted-text”</span></a> signal on <em class="parameter"><code>buffer</code></em>
.</p>
<p>Used when subclassing <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p>
<div class="refsect3">
<a name="id-1.7.2.13.9.13.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>position at which text was deleted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>number of characters deleted</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CLUTTER-TEXT-BUFFER-MAX-SIZE:CAPS"></a><h3>CLUTTER_TEXT_BUFFER_MAX_SIZE</h3>
<pre class="programlisting">#define CLUTTER_TEXT_BUFFER_MAX_SIZE G_MAXUSHORT
</pre>
<p>Maximum size of text buffer, in bytes.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextBuffer-struct"></a><h3>struct ClutterTextBuffer</h3>
<pre class="programlisting">struct ClutterTextBuffer;</pre>
<p>The <span class="structname">ClutterTextBuffer</span> structure contains private
data and it should only be accessed using the provided API.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextBufferClass"></a><h3>struct ClutterTextBufferClass</h3>
<pre class="programlisting">struct ClutterTextBufferClass {
/* Signals */
void (*inserted_text) (ClutterTextBuffer *buffer,
guint position,
const gchar *chars,
guint n_chars);
void (*deleted_text) (ClutterTextBuffer *buffer,
guint position,
guint n_chars);
/* Virtual Methods */
const gchar* (*get_text) (ClutterTextBuffer *buffer,
gsize *n_bytes);
guint (*get_length) (ClutterTextBuffer *buffer);
guint (*insert_text) (ClutterTextBuffer *buffer,
guint position,
const gchar *chars,
guint n_chars);
guint (*delete_text) (ClutterTextBuffer *buffer,
guint position,
guint n_chars);
};
</pre>
<p>The <span class="structname">ClutterTextBufferClass</span> structure contains
only private data.</p>
<div class="refsect3">
<a name="id-1.7.2.13.10.4.5"></a><h4>Members</h4>
<div class="informaltable"><table 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="ClutterTextBufferClass.inserted-text"></a>inserted_text</code></em> ()</p></td>
<td class="struct_member_description"><p>default handler for the <a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer-inserted-text" title="The “inserted-text” signal"><span class="type">“inserted-text”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextBufferClass.deleted-text"></a>deleted_text</code></em> ()</p></td>
<td class="struct_member_description"><p>default hanlder for the <a class="link" href="ClutterTextBuffer.html#ClutterTextBuffer-deleted-text" title="The “deleted-text” signal"><span class="type">“deleted-text”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextBufferClass.get-text"></a>get_text</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextBufferClass.get-length"></a>get_length</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextBufferClass.insert-text"></a>insert_text</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextBufferClass.delete-text"></a>delete_text</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterTextBuffer--length"></a><h3>The <code class="literal">“length”</code> property</h3>
<pre class="programlisting"> “length” <span class="type">guint</span></pre>
<p>The length (in characters) of the text in buffer.</p>
<p>Flags: Read</p>
<p>Allowed values: <= 65535</p>
<p>Default value: 0</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextBuffer--max-length"></a><h3>The <code class="literal">“max-length”</code> property</h3>
<pre class="programlisting"> “max-length” <span class="type">gint</span></pre>
<p>The maximum length (in characters) of the text in the buffer.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,65535]</p>
<p>Default value: 0</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextBuffer--text"></a><h3>The <code class="literal">“text”</code> property</h3>
<pre class="programlisting"> “text” <span class="type">gchar</span> *</pre>
<p>The contents of the buffer.</p>
<p>Flags: Read</p>
<p>Default value: ""</p>
<p class="since">Since 1.10</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterTextBuffer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterTextBuffer-deleted-text"></a><h3>The <code class="literal">“deleted-text”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer,
<span class="type">guint</span> position,
<span class="type">guint</span> n_chars,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted after text is deleted from the buffer.</p>
<div class="refsect3">
<a name="id-1.7.2.13.12.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position the text was deleted at.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>The number of characters that were deleted.</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 First</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextBuffer-inserted-text"></a><h3>The <code class="literal">“inserted-text”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer,
<span class="type">guint</span> position,
<span class="type">gchar</span> *chars,
<span class="type">guint</span> n_chars,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted after text is inserted into the buffer.</p>
<div class="refsect3">
<a name="id-1.7.2.13.12.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position the text was inserted at.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>chars</p></td>
<td class="parameter_description"><p>The text that was inserted.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>The number of characters that were inserted.</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 First</p>
<p class="since">Since 1.10</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|