/usr/share/gtk-doc/html/libsexy/SexySpellEntry.html is in libsexy-doc 0.1.11-2.1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>SexySpellEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="libsexy Reference Manual">
<link rel="up" href="ch01.html" title="libsexy">
<link rel="prev" href="ch01.html" title="libsexy">
<link rel="next" href="SexyUrlLabel.html" title="SexyUrlLabel">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="libsexy">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libsexy Reference Manual</th>
<td><a accesskey="n" href="SexyUrlLabel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2550646" class="shortcut">Top</a>
 | 
<a href="#id2541815" class="shortcut">Description</a>
 | 
<a href="#id2499899" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2499947" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2541765" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="SexySpellEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2550646"></a><span class="refentrytitle">SexySpellEntry</span>
</h2>
<p>SexySpellEntry — A GtkEntry with inline spell checking.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="SexySpellEntry.html#SexySpellEntry-struct">SexySpellEntry</a>;
GtkWidget* <a href="SexySpellEntry.html#sexy-spell-entry-new">sexy_spell_entry_new</a> (void);
GSList* <a href="SexySpellEntry.html#sexy-spell-entry-get-languages">sexy_spell_entry_get_languages</a> (const <a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);
gchar* <a href="SexySpellEntry.html#sexy-spell-entry-get-language-name">sexy_spell_entry_get_language_name</a>
(const <a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang);
gboolean <a href="SexySpellEntry.html#sexy-spell-entry-language-is-active">sexy_spell_entry_language_is_active</a>
(const <a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang);
gboolean <a href="SexySpellEntry.html#sexy-spell-entry-activate-language">sexy_spell_entry_activate_language</a>
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang,
GError **error);
void <a href="SexySpellEntry.html#sexy-spell-entry-deactivate-language">sexy_spell_entry_deactivate_language</a>
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang);
gboolean <a href="SexySpellEntry.html#sexy-spell-entry-set-active-languages">sexy_spell_entry_set_active_languages</a>
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
GSList *langs,
GError **error);
GSList* <a href="SexySpellEntry.html#sexy-spell-entry-get-active-languages">sexy_spell_entry_get_active_languages</a>
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);
gboolean <a href="SexySpellEntry.html#sexy-spell-entry-is-checked">sexy_spell_entry_is_checked</a> (<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);
void <a href="SexySpellEntry.html#sexy-spell-entry-set-checked">sexy_spell_entry_set_checked</a> (<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
gboolean checked);
void <a href="SexySpellEntry.html#sexy-spell-entry-activate-default-languages">sexy_spell_entry_activate_default_languages</a>
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2499899"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkEntry
+----SexySpellEntry
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2499947"></a><h2>Implemented Interfaces</h2>
<p>
SexySpellEntry implements
GtkEditable, AtkImplementorIface and GtkCellEditable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2541765"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="SexySpellEntry.html#SexySpellEntry-word-check">word-check</a>"
gboolean user_function (<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
gchar *word,
gpointer user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2541815"></a><h2>Description</h2>
<p>
SexySpellEntry is a GtkEntry with inline spell checking. This makes use of
Enchant and allows the user to see what they've typed wrong as they type it.
A right-click menu is provided for misspelled words offering suggestions.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2541834"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2541845"></a><h3>
<a name="SexySpellEntry-struct"></a>SexySpellEntry</h3>
<a class="indexterm" name="id2541857"></a><pre class="programlisting">typedef struct _SexySpellEntry SexySpellEntry;</pre>
<p>
The <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a> struct contains private data only, and should be manipulated using the functions below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2541882"></a><h3>
<a name="sexy-spell-entry-new"></a>sexy_spell_entry_new ()</h3>
<a class="indexterm" name="id2541893"></a><pre class="programlisting">GtkWidget* sexy_spell_entry_new (void);</pre>
<p>
Creates a new SexySpellEntry widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2541940"></a><h3>
<a name="sexy-spell-entry-get-languages"></a>sexy_spell_entry_get_languages ()</h3>
<a class="indexterm" name="id2541951"></a><pre class="programlisting">GSList* sexy_spell_entry_get_languages (const <a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);</pre>
<p>
Retrieve a list of language codes for which dictionaries are available.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a new <span class="type">GList</span> object, or <code class="literal">NULL</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2477347"></a><h3>
<a name="sexy-spell-entry-get-language-name"></a>sexy_spell_entry_get_language_name ()</h3>
<a class="indexterm" name="id2477360"></a><pre class="programlisting">gchar* sexy_spell_entry_get_language_name
(const <a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang);</pre>
<p>
Get a friendly name for a given locale.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lang</code></em> :</span></td>
<td> The language code to lookup a friendly name for.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The name of the locale. Should be freed with <code class="function">g_free()</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2477461"></a><h3>
<a name="sexy-spell-entry-language-is-active"></a>sexy_spell_entry_language_is_active ()</h3>
<a class="indexterm" name="id2477475"></a><pre class="programlisting">gboolean sexy_spell_entry_language_is_active
(const <a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang);</pre>
<p>
Determine if a given language is currently active.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lang</code></em> :</span></td>
<td> The language to use, in a form enchant understands.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the language is active.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2477567"></a><h3>
<a name="sexy-spell-entry-activate-language"></a>sexy_spell_entry_activate_language ()</h3>
<a class="indexterm" name="id2477581"></a><pre class="programlisting">gboolean sexy_spell_entry_activate_language
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang,
GError **error);</pre>
<p>
Activate spell checking for the language specifed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lang</code></em> :</span></td>
<td> The language to use in a form Enchant understands. Typically either
a two letter language code or a locale code in the form xx_XX.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Return location for error.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> FALSE if there was an error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565236"></a><h3>
<a name="sexy-spell-entry-deactivate-language"></a>sexy_spell_entry_deactivate_language ()</h3>
<a class="indexterm" name="id2565249"></a><pre class="programlisting">void sexy_spell_entry_deactivate_language
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
const gchar *lang);</pre>
<p>
Deactivate spell checking for the language specifed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lang</code></em> :</span></td>
<td> The language in a form Enchant understands. Typically either
a two letter language code or a locale code in the form xx_XX.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565330"></a><h3>
<a name="sexy-spell-entry-set-active-languages"></a>sexy_spell_entry_set_active_languages ()</h3>
<a class="indexterm" name="id2565343"></a><pre class="programlisting">gboolean sexy_spell_entry_set_active_languages
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
GSList *langs,
GError **error);</pre>
<p>
Activate spell checking for only the languages specified.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>langs</code></em> :</span></td>
<td> A list of language codes to activate, in a form Enchant understands.
Typically either a two letter language code or a locale code in the
form xx_XX.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Return location for error.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> FALSE if there was an error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565459"></a><h3>
<a name="sexy-spell-entry-get-active-languages"></a>sexy_spell_entry_get_active_languages ()</h3>
<a class="indexterm" name="id2565472"></a><pre class="programlisting">GSList* sexy_spell_entry_get_active_languages
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);</pre>
<p>
Retrieve a list of the currently active languages.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A GSList of char* values with language codes (en, fr, etc). Both
the data and the list must be freed by the user.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565544"></a><h3>
<a name="sexy-spell-entry-is-checked"></a>sexy_spell_entry_is_checked ()</h3>
<a class="indexterm" name="id2565556"></a><pre class="programlisting">gboolean sexy_spell_entry_is_checked (<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);</pre>
<p>
Queries a <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a> and returns whether the entry has spell-checking enabled.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if the entry has spell-checking enabled.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565632"></a><h3>
<a name="sexy-spell-entry-set-checked"></a>sexy_spell_entry_set_checked ()</h3>
<a class="indexterm" name="id2565645"></a><pre class="programlisting">void sexy_spell_entry_set_checked (<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
gboolean checked);</pre>
<p>
Sets whether the entry has spell-checking enabled.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>checked</code></em> :</span></td>
<td> Whether to enable spell-checking
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565725"></a><h3>
<a name="sexy-spell-entry-activate-default-languages"></a>sexy_spell_entry_activate_default_languages ()</h3>
<a class="indexterm" name="id2565740"></a><pre class="programlisting">void sexy_spell_entry_activate_default_languages
(<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry);</pre>
<p>
Activate spell checking for languages specified in the $LANG
or $LANGUAGE environment variables. These languages are
activated by default, so this function need only be called
if they were previously deactivated.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexySpellEntry.html" title="SexySpellEntry"><span class="type">SexySpellEntry</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2565802"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2565813"></a><h3>
<a name="SexySpellEntry-word-check"></a>The "word-check" signal</h3>
<a class="indexterm" name="id2565821"></a><pre class="programlisting">gboolean user_function (<a href="SexySpellEntry.html" title="SexySpellEntry">SexySpellEntry</a> *entry,
gchar *word,
gpointer user_data) : Run last</pre>
<p>
The ::word-check signal is emitted whenever the entry has to check
a word. This allows the application to mark words as correct even
if none of the active dictionaries contain it, such as nicknames in
a chat client.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> The entry on which the signal is emitted.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>word</code></em> :</span></td>
<td> The word to check.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">FALSE</code> to indicate that the word should be marked as
correct.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|