/usr/share/gtk-doc/html/gtkspell3/gtkspell3-gtkspell.html is in libgtkspell3-3-dev 3.0.9-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gtkspell: GtkSpell Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GtkSpell Reference Manual">
<link rel="up" href="ch02.html" title="Function Reference">
<link rel="prev" href="ch02.html" title="Function Reference">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gtkspell3-gtkspell.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#gtkspell3-gtkspell.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gtkspell3-gtkspell.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#gtkspell3-gtkspell.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gtkspell3-gtkspell"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtkspell3-gtkspell.top_of_page"></a>gtkspell</span></h2>
<p>gtkspell</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="returnvalue">GtkSpellChecker</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-new" title="gtk_spell_checker_new ()">gtk_spell_checker_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-attach" title="gtk_spell_checker_attach ()">gtk_spell_checker_attach</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="gtkspell3-gtkspell.html#gtk-spell-checker-detach" title="gtk_spell_checker_detach ()">gtk_spell_checker_detach</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-set-language" title="gtk_spell_checker_set_language ()">gtk_spell_checker_set_language</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-get-language" title="gtk_spell_checker_get_language ()">gtk_spell_checker_get_language</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-get-language-list" title="gtk_spell_checker_get_language_list ()">gtk_spell_checker_get_language_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-decode-language-code" title="gtk_spell_checker_decode_language_code ()">gtk_spell_checker_decode_language_code</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-check-word" title="gtk_spell_checker_check_word ()">gtk_spell_checker_check_word</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="gtkspell3-gtkspell.html#gtk-spell-checker-recheck-all" title="gtk_spell_checker_recheck_all ()">gtk_spell_checker_recheck_all</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="gtkspell3-gtkspell.html#gtk-spell-checker-add-to-dictionary" title="gtk_spell_checker_add_to_dictionary ()">gtk_spell_checker_add_to_dictionary</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="gtkspell3-gtkspell.html#gtk-spell-checker-ignore-word" title="gtk_spell_checker_ignore_word ()">gtk_spell_checker_ignore_word</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="returnvalue">GtkSpellChecker</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-get-from-text-view" title="gtk_spell_checker_get_from_text_view ()">gtk_spell_checker_get_from_text_view</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-get-suggestions" title="gtk_spell_checker_get_suggestions ()">gtk_spell_checker_get_suggestions</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-get-suggestions-menu" title="gtk_spell_checker_get_suggestions_menu ()">gtk_spell_checker_get_suggestions_menu</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker--decode-language-codes" title="The “decode-language-codes” property">decode-language-codes</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker-language-changed" title="The “language-changed” signal">language-changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<a name="GtkSpellChecker"></a><div class="refsect1">
<a name="gtkspell3-gtkspell.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker-struct" title="struct GtkSpellChecker">GtkSpellChecker</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gtkspell3-gtkspell.html#GtkSpellError" title="enum GtkSpellError">GtkSpellError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> GtkSpellChecker
</pre>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtkspell/gtkspell.h>
</pre>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-spell-checker-new"></a><h3>gtk_spell_checker_new ()</h3>
<pre class="programlisting"><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="returnvalue">GtkSpellChecker</span></a> *
gtk_spell_checker_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p>
<div class="refsect3">
<a name="gtk-spell-checker-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-attach"></a><h3>gtk_spell_checker_attach ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_spell_checker_attach (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> *view</code></em>);</pre>
<p>Attach <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object to <em class="parameter"><code>view</code></em>
.</p>
<p>Note: Please read the tutorial section of the documentation to make sure
you don't leak references!</p>
<div class="refsect3">
<a name="gtk-spell-checker-attach.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>A <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>view</p></td>
<td class="parameter_description"><p>The <a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> to attach to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-attach.returns"></a><h4>Returns</h4>
<p> TRUE on success, FALSE on failure.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-detach"></a><h3>gtk_spell_checker_detach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spell_checker_detach (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>);</pre>
<p>Detaches this <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> from its <a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>. Use
<a class="link" href="gtkspell3-gtkspell.html#gtk-spell-checker-get-from-text-view" title="gtk_spell_checker_get_from_text_view ()"><code class="function">gtk_spell_checker_get_from_text_view()</code></a> to retrieve a <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> from
a <a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>. If the <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> is not attached to any <a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>,
the function silently exits.</p>
<p>Note: if the <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> is owned by the <a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>, you must
take a reference to it to prevent it from being automatically destroyed.
Please read the tutorial section of the documentation!</p>
<div class="refsect3">
<a name="gtk-spell-checker-detach.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>A <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-set-language"></a><h3>gtk_spell_checker_set_language ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_spell_checker_set_language (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Set the language on <em class="parameter"><code>spell</code></em>
to <em class="parameter"><code>lang</code></em>
, possibily returning an error in
<em class="parameter"><code>error</code></em>
.</p>
<div class="refsect3">
<a name="gtk-spell-checker-set-language.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>The <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lang</p></td>
<td class="parameter_description"><p> The language to use, as a locale specifier (i.e. "en_US").
If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>, attempt to use the default system locale (LANG). </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>error</p></td>
<td class="parameter_description"><p> Return location for error. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-set-language.returns"></a><h4>Returns</h4>
<p> FALSE if there was an error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-get-language"></a><h3>gtk_spell_checker_get_language ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_spell_checker_get_language (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>);</pre>
<p>Fetches the current language.</p>
<div class="refsect3">
<a name="gtk-spell-checker-get-language.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>a <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-get-language.returns"></a><h4>Returns</h4>
<p> the current language. This string is
owned by the spell object and must not be modified or freed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-get-language-list"></a><h3>gtk_spell_checker_get_language_list ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gtk_spell_checker_get_language_list (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Requests the list of available languages from the enchant broker.</p>
<div class="refsect3">
<a name="gtk-spell-checker-get-language-list.returns"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of the available languages.
Use g_list_free_full with g_free to free the list after use. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p>
</div>
<p class="since">Since: 3.0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-decode-language-code"></a><h3>gtk_spell_checker_decode_language_code ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gtk_spell_checker_decode_language_code
(<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang</code></em>);</pre>
<p>Translates the language code to a human readable format
(i.e. "en_US" -> "English (United States)").
Note: If the iso-codes package is not available, the unchanged code is
returned.</p>
<div class="refsect3">
<a name="gtk-spell-checker-decode-language-code.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>lang</p></td>
<td class="parameter_description"><p>The language locale specifier (i.e. "en_US").</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-decode-language-code.returns"></a><h4>Returns</h4>
<p> The translated language specifier. Use g_free to
free the returned string after use. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 3.0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-check-word"></a><h3>gtk_spell_checker_check_word ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_spell_checker_check_word (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *word</code></em>);</pre>
<p>Check the specified word.</p>
<div class="refsect3">
<a name="gtk-spell-checker-check-word.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>The <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>word</p></td>
<td class="parameter_description"><p>The word to check.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-check-word.returns"></a><h4>Returns</h4>
<p> TRUE if the word is correctly spelled, FALSE otherwise.</p>
</div>
<p class="since">Since: 3.0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-recheck-all"></a><h3>gtk_spell_checker_recheck_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spell_checker_recheck_all (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>);</pre>
<p>Recheck the spelling in the entire buffer.</p>
<div class="refsect3">
<a name="gtk-spell-checker-recheck-all.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>The <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-add-to-dictionary"></a><h3>gtk_spell_checker_add_to_dictionary ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spell_checker_add_to_dictionary (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *word</code></em>);</pre>
<p>Add the specified word to the user dictionary.</p>
<div class="refsect3">
<a name="gtk-spell-checker-add-to-dictionary.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>The <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>word</p></td>
<td class="parameter_description"><p>The word to add to the user dictionary.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 3.0.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-ignore-word"></a><h3>gtk_spell_checker_ignore_word ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spell_checker_ignore_word (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *word</code></em>);</pre>
<p>Add the specified word to the user ignore list.</p>
<div class="refsect3">
<a name="gtk-spell-checker-ignore-word.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>The <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>word</p></td>
<td class="parameter_description"><p>The word to add to the user ignore list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 3.0.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-get-from-text-view"></a><h3>gtk_spell_checker_get_from_text_view ()</h3>
<pre class="programlisting"><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="returnvalue">GtkSpellChecker</span></a> *
gtk_spell_checker_get_from_text_view (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> *view</code></em>);</pre>
<p>Retrieves the <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object attached to a text view.</p>
<div class="refsect3">
<a name="gtk-spell-checker-get-from-text-view.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>view</p></td>
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-get-from-text-view.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a>
attached to <em class="parameter"><code>view</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-get-suggestions"></a><h3>gtk_spell_checker_get_suggestions ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
gtk_spell_checker_get_suggestions (<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *word</code></em>);</pre>
<p>Retreives a list of spelling suggestions for the specified word.</p>
<div class="refsect3">
<a name="gtk-spell-checker-get-suggestions.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>A <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>word</p></td>
<td class="parameter_description"><p>The word for which to fetch suggestions</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-get-suggestions.returns"></a><h4>Returns</h4>
<p> the list of spelling
suggestions for the specified word, or NULL if there are no suggestions. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p>
</div>
<p class="since">Since: 3.0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spell-checker-get-suggestions-menu"></a><h3>gtk_spell_checker_get_suggestions_menu ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gtk_spell_checker_get_suggestions_menu
(<em class="parameter"><code><a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
<p>Retrieves a submenu of replacement spellings, or NULL if the word at <em class="parameter"><code>iter</code></em>
is
not misspelt.</p>
<div class="refsect3">
<a name="gtk-spell-checker-get-suggestions-menu.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>A <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>Textiter of position in buffer to be corrected if necessary.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-spell-checker-get-suggestions-menu.returns"></a><h4>Returns</h4>
<p> the <a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a> widget, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no need for a menu. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSpellChecker-struct"></a><h3>struct GtkSpellChecker</h3>
<pre class="programlisting">struct GtkSpellChecker;</pre>
<p>The <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> struct contains only private fields.</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSpellError"></a><h3>enum GtkSpellError</h3>
<p>Error codes used for GtkSpell errors.</p>
<div class="refsect3">
<a name="GtkSpellError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="GTK-SPELL-ERROR-BACKEND:CAPS"></a>GTK_SPELL_ERROR_BACKEND</p></td>
<td class="enum_member_description">
<p>Error code for backend errors</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSpellChecker--decode-language-codes"></a><h3>The <code class="literal">“decode-language-codes”</code> property</h3>
<pre class="programlisting"> “decode-language-codes” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether to show decoded language codes in the context menu (requires the iso-codes package).</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="gtkspell3-gtkspell.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkSpellChecker-language-changed"></a><h3>The <code class="literal">“language-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> *spell,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *lang,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The ::language-changed signal is emitted when the user selects
a new spelling language from the context menu.</p>
<div class="refsect3">
<a name="GtkSpellChecker-language-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>spell</p></td>
<td class="parameter_description"><p>the <a class="link" href="gtkspell3-gtkspell.html#GtkSpellChecker"><span class="type">GtkSpellChecker</span></a> object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lang</p></td>
<td class="parameter_description"><p>the new language which was selected.</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: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|