/usr/share/gtk-doc/html/gspell-1.0/GspellTextView.html is in libgspell-1-dev 1.2.2-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GspellTextView: gspell 1 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="gspell 1 Reference Manual">
<link rel="up" href="ch04.html" title="GtkTextView Support">
<link rel="prev" href="GspellTextBuffer.html" title="GspellTextBuffer">
<link rel="next" href="GspellNavigatorTextView.html" title="GspellNavigatorTextView">
<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="#GspellTextView.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GspellTextView.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GspellTextView.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GspellTextBuffer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GspellNavigatorTextView.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GspellTextView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GspellTextView.top_of_page"></a>GspellTextView</span></h2>
<p>GspellTextView — Spell checking support for GtkTextView</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GspellTextView.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="GspellTextView.html" title="GspellTextView"><span class="returnvalue">GspellTextView</span></a> *
</td>
<td class="function_name">
<a class="link" href="GspellTextView.html#gspell-text-view-get-from-gtk-text-view" title="gspell_text_view_get_from_gtk_text_view ()">gspell_text_view_get_from_gtk_text_view</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="GspellTextView.html#gspell-text-view-basic-setup" title="gspell_text_view_basic_setup ()">gspell_text_view_basic_setup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkTextView</span> *
</td>
<td class="function_name">
<a class="link" href="GspellTextView.html#gspell-text-view-get-view" title="gspell_text_view_get_view ()">gspell_text_view_get_view</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GspellTextView.html#gspell-text-view-get-inline-spell-checking" title="gspell_text_view_get_inline_spell_checking ()">gspell_text_view_get_inline_spell_checking</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="GspellTextView.html#gspell-text-view-set-inline-spell-checking" title="gspell_text_view_set_inline_spell_checking ()">gspell_text_view_set_inline_spell_checking</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GspellTextView.html#gspell-text-view-get-enable-language-menu" title="gspell_text_view_get_enable_language_menu ()">gspell_text_view_get_enable_language_menu</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="GspellTextView.html#gspell-text-view-set-enable-language-menu" title="gspell_text_view_set_enable_language_menu ()">gspell_text_view_set_enable_language_menu</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GspellTextView.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"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GspellTextView.html#GspellTextView--enable-language-menu" title="The “enable-language-menu” property">enable-language-menu</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GspellTextView.html#GspellTextView--inline-spell-checking" title="The “inline-spell-checking” property">inline-spell-checking</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">GtkTextView</span> *</td>
<td class="property_name"><a class="link" href="GspellTextView.html#GspellTextView--view" title="The “view” property">view</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GspellTextView.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"> </td>
<td class="function_name"><a class="link" href="GspellTextView.html#GspellTextView-struct" title="GspellTextView">GspellTextView</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GspellTextView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GspellTextView
</pre>
</div>
<div class="refsect1">
<a name="GspellTextView.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gspell/gspell.h>
</pre>
</div>
<div class="refsect1">
<a name="GspellTextView.description"></a><h2>Description</h2>
<p><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> extends the <span class="type">GtkTextView</span> class with inline spell checking.
Misspelled words are highlighted with a <code class="literal">PANGO_UNDERLINE_ERROR</code>, usually a red
wavy underline. Right-clicking a misspelled word pops up a context menu of
suggested replacements. The context menu also contains an “Ignore All” item
to add the misspelled word to the session dictionary. And an “Add” item to
add the word to the personal dictionary.</p>
<p>For a basic use-case, there is the <a class="link" href="GspellTextView.html#gspell-text-view-basic-setup" title="gspell_text_view_basic_setup ()"><code class="function">gspell_text_view_basic_setup()</code></a> convenience
function.</p>
<p>The spell is checked only on the visible region of the <span class="type">GtkTextView</span>. Note
that if a same <span class="type">GtkTextBuffer</span> is used for several views, the misspelled words
are visible in all views, because the highlighting is achieved with a
<span class="type">GtkTextTag</span> added to the buffer.</p>
<p>If you don't use the <a class="link" href="GspellTextView.html#gspell-text-view-basic-setup" title="gspell_text_view_basic_setup ()"><code class="function">gspell_text_view_basic_setup()</code></a> function, you need to
call <a class="link" href="GspellTextBuffer.html#gspell-text-buffer-set-spell-checker" title="gspell_text_buffer_set_spell_checker ()"><code class="function">gspell_text_buffer_set_spell_checker()</code></a> to associate a <a class="link" href="GspellChecker.html" title="GspellChecker"><span class="type">GspellChecker</span></a> to
the <span class="type">GtkTextBuffer</span>. <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> handles automatically changes to the
following properties: <span class="type">“buffer”</span>, <a class="link" href="GspellTextBuffer.html#GspellTextBuffer--spell-checker" title="The “spell-checker” property"><span class="type">“spell-checker”</span></a>
and <a class="link" href="GspellChecker.html#GspellChecker--language" title="The “language” property"><span class="type">“language”</span></a>.</p>
<p>Note that <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> extends the <span class="type">GtkTextView</span> class but without
subclassing it, because the GtkSourceView library has already a <span class="type">GtkTextView</span>
subclass.</p>
</div>
<div class="refsect1">
<a name="GspellTextView.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gspell-text-view-get-from-gtk-text-view"></a><h3>gspell_text_view_get_from_gtk_text_view ()</h3>
<pre class="programlisting"><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="returnvalue">GspellTextView</span></a> *
gspell_text_view_get_from_gtk_text_view
(<em class="parameter"><code><span class="type">GtkTextView</span> *gtk_view</code></em>);</pre>
<p>Returns the <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> of <em class="parameter"><code>gtk_view</code></em>
. The returned object is guaranteed
to be the same for the lifetime of <em class="parameter"><code>gtk_view</code></em>
.</p>
<div class="refsect3">
<a name="gspell-text-view-get-from-gtk-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>gtk_view</p></td>
<td class="parameter_description"><p>a <span class="type">GtkTextView</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gspell-text-view-get-from-gtk-text-view.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> of <em class="parameter"><code>gtk_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="gspell-text-view-basic-setup"></a><h3>gspell_text_view_basic_setup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gspell_text_view_basic_setup (<em class="parameter"><code><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> *gspell_view</code></em>);</pre>
<p>This function is a convenience function that does the following:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Set a spell checker. The language chosen is the one returned by
<a class="link" href="GspellLanguage.html#gspell-language-get-default" title="gspell_language_get_default ()"><code class="function">gspell_language_get_default()</code></a>.</p></li>
<li class="listitem"><p>Set the <a class="link" href="GspellTextView.html#GspellTextView--inline-spell-checking" title="The “inline-spell-checking” property"><span class="type">“inline-spell-checking”</span></a> property to <code class="literal">TRUE</code>.</p></li>
<li class="listitem"><p>Set the <a class="link" href="GspellTextView.html#GspellTextView--enable-language-menu" title="The “enable-language-menu” property"><span class="type">“enable-language-menu”</span></a> property to <code class="literal">TRUE</code>.</p></li>
</ul></div>
<p>Example:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5</pre></td>
<td class="listing_code"><pre class="programlisting">GtkTextView <span class="gtkdoc opt">*</span>gtk_view<span class="gtkdoc opt">;</span>
GspellTextView <span class="gtkdoc opt">*</span>gspell_view<span class="gtkdoc opt">;</span>
gspell_view <span class="gtkdoc opt">=</span> <span class="function"><a href="GspellTextView.html#gspell-text-view-get-from-gtk-text-view">gspell_text_view_get_from_gtk_text_view</a></span> <span class="gtkdoc opt">(</span>gtk_view<span class="gtkdoc opt">);</span>
<span class="function"><a href="GspellTextView.html#gspell-text-view-basic-setup">gspell_text_view_basic_setup</a></span> <span class="gtkdoc opt">(</span>gspell_view<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>This is equivalent to:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15</pre></td>
<td class="listing_code"><pre class="programlisting">GtkTextView <span class="gtkdoc opt">*</span>gtk_view<span class="gtkdoc opt">;</span>
GspellTextView <span class="gtkdoc opt">*</span>gspell_view<span class="gtkdoc opt">;</span>
GspellChecker <span class="gtkdoc opt">*</span>checker<span class="gtkdoc opt">;</span>
GtkTextBuffer <span class="gtkdoc opt">*</span>gtk_buffer<span class="gtkdoc opt">;</span>
GspellTextBuffer <span class="gtkdoc opt">*</span>gspell_buffer<span class="gtkdoc opt">;</span>
checker <span class="gtkdoc opt">=</span> <span class="function"><a href="GspellChecker.html#gspell-checker-new">gspell_checker_new</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">);</span>
gtk_buffer <span class="gtkdoc opt">=</span> <span class="function">gtk_text_view_get_buffer</span> <span class="gtkdoc opt">(</span>gtk_view<span class="gtkdoc opt">);</span>
gspell_buffer <span class="gtkdoc opt">=</span> <span class="function"><a href="GspellTextBuffer.html#gspell-text-buffer-get-from-gtk-text-buffer">gspell_text_buffer_get_from_gtk_text_buffer</a></span> <span class="gtkdoc opt">(</span>gtk_buffer<span class="gtkdoc opt">);</span>
<span class="function"><a href="GspellTextBuffer.html#gspell-text-buffer-set-spell-checker">gspell_text_buffer_set_spell_checker</a></span> <span class="gtkdoc opt">(</span>gspell_buffer<span class="gtkdoc opt">,</span> checker<span class="gtkdoc opt">);</span>
<span class="function">g_object_unref</span> <span class="gtkdoc opt">(</span>checker<span class="gtkdoc opt">);</span>
gspell_view <span class="gtkdoc opt">=</span> <span class="function"><a href="GspellTextView.html#gspell-text-view-get-from-gtk-text-view">gspell_text_view_get_from_gtk_text_view</a></span> <span class="gtkdoc opt">(</span>gtk_view<span class="gtkdoc opt">);</span>
<span class="function"><a href="GspellTextView.html#gspell-text-view-set-inline-spell-checking">gspell_text_view_set_inline_spell_checking</a></span> <span class="gtkdoc opt">(</span>gspell_view<span class="gtkdoc opt">,</span> TRUE<span class="gtkdoc opt">);</span>
<span class="function"><a href="GspellTextView.html#gspell-text-view-set-enable-language-menu">gspell_text_view_set_enable_language_menu</a></span> <span class="gtkdoc opt">(</span>gspell_view<span class="gtkdoc opt">,</span> TRUE<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="gspell-text-view-basic-setup.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>gspell_view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-1-2.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gspell-text-view-get-view"></a><h3>gspell_text_view_get_view ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkTextView</span> *
gspell_text_view_get_view (<em class="parameter"><code><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> *gspell_view</code></em>);</pre>
<div class="refsect3">
<a name="gspell-text-view-get-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>gspell_view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gspell-text-view-get-view.returns"></a><h4>Returns</h4>
<p> the <span class="type">GtkTextView</span> of <em class="parameter"><code>gspell_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="gspell-text-view-get-inline-spell-checking"></a><h3>gspell_text_view_get_inline_spell_checking ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gspell_text_view_get_inline_spell_checking
(<em class="parameter"><code><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> *gspell_view</code></em>);</pre>
<div class="refsect3">
<a name="gspell-text-view-get-inline-spell-checking.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>gspell_view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gspell-text-view-get-inline-spell-checking.returns"></a><h4>Returns</h4>
<p> whether the inline spell checking is enabled.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gspell-text-view-set-inline-spell-checking"></a><h3>gspell_text_view_set_inline_spell_checking ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gspell_text_view_set_inline_spell_checking
(<em class="parameter"><code><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> *gspell_view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enable</code></em>);</pre>
<p>Enables or disables the inline spell checking.</p>
<div class="refsect3">
<a name="gspell-text-view-set-inline-spell-checking.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>gspell_view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>the new state.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gspell-text-view-get-enable-language-menu"></a><h3>gspell_text_view_get_enable_language_menu ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gspell_text_view_get_enable_language_menu
(<em class="parameter"><code><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> *gspell_view</code></em>);</pre>
<div class="refsect3">
<a name="gspell-text-view-get-enable-language-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>gspell_view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gspell-text-view-get-enable-language-menu.returns"></a><h4>Returns</h4>
<p> whether the language context menu is enabled.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-2.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gspell-text-view-set-enable-language-menu"></a><h3>gspell_text_view_set_enable_language_menu ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gspell_text_view_set_enable_language_menu
(<em class="parameter"><code><a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a> *gspell_view</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enable_language_menu</code></em>);</pre>
<p>Sets whether to enable the language context menu. If enabled, doing a right
click on the <span class="type">GtkTextView</span> will show a sub-menu to choose the language for the
spell checking. If another language is chosen, it changes the
<a class="link" href="GspellChecker.html#GspellChecker--language" title="The “language” property"><span class="type">“language”</span></a> property of the <a class="link" href="GspellTextBuffer.html#GspellTextBuffer--spell-checker" title="The “spell-checker” property"><span class="type">“spell-checker”</span></a> of
the <span class="type">“buffer”</span> of the <a class="link" href="GspellTextView.html#GspellTextView--view" title="The “view” property"><span class="type">“view”</span></a>.</p>
<div class="refsect3">
<a name="gspell-text-view-set-enable-language-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>gspell_view</p></td>
<td class="parameter_description"><p>a <a class="link" href="GspellTextView.html" title="GspellTextView"><span class="type">GspellTextView</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enable_language_menu</p></td>
<td class="parameter_description"><p>whether to enable the language context menu.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-1-2.html#api-index-1.2">1.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="GspellTextView.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GspellTextView-struct"></a><h3>GspellTextView</h3>
<pre class="programlisting">typedef struct _GspellTextView GspellTextView;</pre>
</div>
</div>
<div class="refsect1">
<a name="GspellTextView.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GspellTextView--enable-language-menu"></a><h3>The <code class="literal">“enable-language-menu”</code> property</h3>
<pre class="programlisting"> “enable-language-menu” <span class="type">gboolean</span></pre>
<p>When the context menu is shown, whether to add a sub-menu to select
the language for the spell checking.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-1-2.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GspellTextView--inline-spell-checking"></a><h3>The <code class="literal">“inline-spell-checking”</code> property</h3>
<pre class="programlisting"> “inline-spell-checking” <span class="type">gboolean</span></pre>
<p>Whether the inline spell checking is enabled.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GspellTextView--view"></a><h3>The <code class="literal">“view”</code> property</h3>
<pre class="programlisting"> “view” <span class="type">GtkTextView</span> *</pre>
<p>The <span class="type">GtkTextView</span>.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|