diff options
Diffstat (limited to 'Documentation/webkitgtk/html/WebKitSpellChecker.html')
| -rw-r--r-- | Documentation/webkitgtk/html/WebKitSpellChecker.html | 387 |
1 files changed, 0 insertions, 387 deletions
diff --git a/Documentation/webkitgtk/html/WebKitSpellChecker.html b/Documentation/webkitgtk/html/WebKitSpellChecker.html deleted file mode 100644 index 3efca583f..000000000 --- a/Documentation/webkitgtk/html/WebKitSpellChecker.html +++ /dev/null @@ -1,387 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>WebKitGTK+ Reference Manual: WebKitSpellChecker</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="WebKitGTK+ Reference Manual"> -<link rel="up" href="ch02.html" title="Class Overview"> -<link rel="prev" href="WebKitIconDatabase.html" title="WebKitIconDatabase"> -<link rel="next" href="WebKitFaviconDatabase.html" title="WebKitFaviconDatabase"> -<meta name="generator" content="GTK-Doc V1.21.1 (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="#WebKitSpellChecker.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#WebKitSpellChecker.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> - <a href="#WebKitSpellChecker.prerequisites" class="shortcut">Prerequisites</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="WebKitIconDatabase.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="WebKitFaviconDatabase.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="WebKitSpellChecker"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="WebKitSpellChecker.top_of_page"></a>WebKitSpellChecker</span></h2> -<p>WebKitSpellChecker — the spell checking API for WebKit</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="WebKitSpellChecker.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"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="WebKitSpellChecker.html#webkit-spell-checker-check-spelling-of-string" title="webkit_spell_checker_check_spelling_of_string ()">webkit_spell_checker_check_spelling_of_string</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">char</span> ** -</td> -<td class="function_name"> -<a class="link" href="WebKitSpellChecker.html#webkit-spell-checker-get-guesses-for-word" title="webkit_spell_checker_get_guesses_for_word ()">webkit_spell_checker_get_guesses_for_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="WebKitSpellChecker.html#webkit-spell-checker-update-spell-checking-languages" title="webkit_spell_checker_update_spell_checking_languages ()">webkit_spell_checker_update_spell_checking_languages</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="WebKitSpellChecker.html#webkit-spell-checker-get-autocorrect-suggestions-for-misspelled-word" title="webkit_spell_checker_get_autocorrect_suggestions_for_misspelled_word ()">webkit_spell_checker_get_autocorrect_suggestions_for_misspelled_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="WebKitSpellChecker.html#webkit-spell-checker-learn-word" title="webkit_spell_checker_learn_word ()">webkit_spell_checker_learn_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="WebKitSpellChecker.html#webkit-spell-checker-ignore-word" title="webkit_spell_checker_ignore_word ()">webkit_spell_checker_ignore_word</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="WebKitSpellChecker.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="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="WebKitSpellChecker.html#WebKitSpellChecker-struct" title="WebKitSpellChecker">WebKitSpellChecker</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="WebKitSpellChecker.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/cgarcia/gnome/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> - <span class="lineart">╰──</span> WebKitSpellChecker -</pre> -</div> -<div class="refsect1"> -<a name="WebKitSpellChecker.prerequisites"></a><h2>Prerequisites</h2> -<p> -WebKitSpellChecker requires - <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> -</div> -<div class="refsect1"> -<a name="WebKitSpellChecker.description"></a><h2>Description</h2> -<p><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> provides APIs for the spell checking -functionality used internally by WebKit to perform spell checking -in editable areas. This can be used, for example, by browsers to -implement custom spell checking context menus or sophisticated -auto-correct features.</p> -</div> -<div class="refsect1"> -<a name="WebKitSpellChecker.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="webkit-spell-checker-check-spelling-of-string"></a><h3>webkit_spell_checker_check_spelling_of_string ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_spell_checker_check_spelling_of_string - (<em class="parameter"><code><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> *checker</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *string</code></em>, - <em class="parameter"><code><span class="type">int</span> *misspelling_location</code></em>, - <em class="parameter"><code><span class="type">int</span> *misspelling_length</code></em>);</pre> -<p>Checks <em class="parameter"><code>string</code></em> - for misspellings using <em class="parameter"><code>checker</code></em> -, storing the -location and length of the first misspelling in -<em class="parameter"><code>misspelling_location</code></em> - and <em class="parameter"><code>misspelling_length</code></em> - respectively.</p> -<div class="refsect3"> -<a name="id-1.3.25.8.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>checker</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>string</p></td> -<td class="parameter_description"><p>the string to check for misspellings</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>misspelling_location</p></td> -<td class="parameter_description"><p> a pointer to an integer to store the location of the first misspelling. </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> -<tr> -<td class="parameter_name"><p>misspelling_length</p></td> -<td class="parameter_description"><p> a pointer to an integer to store the length of the first misspelling. </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> -<p class="since">Since 1.5.1</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-spell-checker-get-guesses-for-word"></a><h3>webkit_spell_checker_get_guesses_for_word ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> ** -webkit_spell_checker_get_guesses_for_word - (<em class="parameter"><code><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> *checker</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *word</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *context</code></em>);</pre> -<p>Returns a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of guesses for corrections of the -misspelled word <em class="parameter"><code>word</code></em> -.</p> -<div class="refsect3"> -<a name="id-1.3.25.8.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>checker</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</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 misspelled word</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>context</p></td> -<td class="parameter_description"><p> the surrounding context of the misspelled word. </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> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.25.8.3.6"></a><h4>Returns</h4> -<p> a newly allocated <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array -of suggested corrections for a misspelled word <em class="parameter"><code>word</code></em> -. Free it with -<a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="literal">g_strfreev</code></a> when done with it. </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 1.5.1</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-spell-checker-update-spell-checking-languages"></a><h3>webkit_spell_checker_update_spell_checking_languages ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_spell_checker_update_spell_checking_languages - (<em class="parameter"><code><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> *checker</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *languages</code></em>);</pre> -<p>Sets <em class="parameter"><code>languages</code></em> - as the list of languages to use by <em class="parameter"><code>checker</code></em> -. The -accepted format is a list of comma (',') separated language codes -of the form 'en_US', ie, language_VARIANT.</p> -<div class="refsect3"> -<a name="id-1.3.25.8.4.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>checker</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>languages</p></td> -<td class="parameter_description"><p> a string of languages to use for <em class="parameter"><code>checker</code></em> -. </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> -</tbody> -</table></div> -</div> -<p class="since">Since 1.5.1</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-spell-checker-get-autocorrect-suggestions-for-misspelled-word"></a><h3>webkit_spell_checker_get_autocorrect_suggestions_for_misspelled_word ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -webkit_spell_checker_get_autocorrect_suggestions_for_misspelled_word - (<em class="parameter"><code><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> *checker</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *word</code></em>);</pre> -<p>Returns a suggestion for a word to use in an "autocorrect" feature.</p> -<div class="refsect3"> -<a name="id-1.3.25.8.5.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>checker</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>word</p></td> -<td class="parameter_description"><p>a misspelled word</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="id-1.3.25.8.5.6"></a><h4>Returns</h4> -<p> the suggestion for the autocorrection of -<em class="parameter"><code>word</code></em> -. </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 1.5.1</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-spell-checker-learn-word"></a><h3>webkit_spell_checker_learn_word ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_spell_checker_learn_word (<em class="parameter"><code><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> *checker</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *word</code></em>);</pre> -<p>Instructs the <em class="parameter"><code>checker</code></em> - to add <em class="parameter"><code>word</code></em> - to its dictionary as a properly -spelled word. The word will be learned permanently in the user's -personal dictionary.</p> -<div class="refsect3"> -<a name="id-1.3.25.8.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>checker</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</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 to learn</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since 1.5.1</p> -</div> -<hr> -<div class="refsect2"> -<a name="webkit-spell-checker-ignore-word"></a><h3>webkit_spell_checker_ignore_word ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -webkit_spell_checker_ignore_word (<em class="parameter"><code><a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</span></a> *checker</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *word</code></em>);</pre> -<p>Instructs the <em class="parameter"><code>checker</code></em> - to ignore <em class="parameter"><code>word</code></em> - as a misspelling for this -session.</p> -<div class="refsect3"> -<a name="id-1.3.25.8.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>checker</p></td> -<td class="parameter_description"><p>a <a class="link" href="WebKitSpellChecker.html" title="WebKitSpellChecker"><span class="type">WebKitSpellChecker</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 to ignore</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since 1.5.1</p> -</div> -</div> -<div class="refsect1"> -<a name="WebKitSpellChecker.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="WebKitSpellChecker-struct"></a><h3>WebKitSpellChecker</h3> -<pre class="programlisting">typedef struct _WebKitSpellChecker WebKitSpellChecker;</pre> -<p> -</p> -</div> -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.21.1</div> -</body> -</html>
\ No newline at end of file |