<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kspell2: KSpell2::Dictionary Class Reference (kspell2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kspell2</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKSpell2.html">KSpell2</a> </li>
<li class="navelem"><a class="el" href="classKSpell2_1_1Dictionary.html">Dictionary</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KSpell2::Dictionary Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KSpell2::Dictionary" -->
<p>Class is returned by from <a class="el" href="classKSpell2_1_1Broker.html" title="Class used to deal with dictionaries.">Broker</a>.
<a href="classKSpell2_1_1Dictionary.html#details">More...</a></p>
<p><code>#include <<a class="el" href="dictionary_8h_source.html">dictionary.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KSpell2::Dictionary:</div>
<div class="dyncontent">
<div class="center">
<img src="classKSpell2_1_1Dictionary.png" usemap="#KSpell2::Dictionary_map" alt=""/>
<map id="KSpell2::Dictionary_map" name="KSpell2::Dictionary_map">
<area href="classASpellDict.html" title="kspell_aspelldict.h" alt="ASpellDict" shape="rect" coords="0,56,119,80"/>
<area href="classHSpellDict.html" title="kspell_hspelldict.h" alt="HSpellDict" shape="rect" coords="129,56,248,80"/>
</map>
</div></div>
<p><a href="classKSpell2_1_1Dictionary-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#a249a7c2e68695f8184b58b3434068184">check</a> (const <a class="elRef" href="qstring.html">QString</a> &word)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#a0159c6ef79338dab82fcf613ba89f840">suggest</a> (const <a class="elRef" href="qstring.html">QString</a> &word)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#a4d49b4ade381db41edffb85dcc6fa42b">checkAndSuggest</a> (const <a class="elRef" href="qstring.html">QString</a> &word, <a class="elRef" href="qstringlist.html">QStringList</a> &suggestions)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#a00ec9e3b3900046cfc74f59a1188a9db">storeReplacement</a> (const <a class="elRef" href="qstring.html">QString</a> &bad, const <a class="elRef" href="qstring.html">QString</a> &good)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#acc259c20f219863105998b0173d83e5b">addToPersonal</a> (const <a class="elRef" href="qstring.html">QString</a> &word)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#a4d0d03852408faf5897a160edc1721fd">addToSession</a> (const <a class="elRef" href="qstring.html">QString</a> &word)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#aaf26837e9d7fc59f6b5c73d896f16ed6">language</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Dictionary.html#a2b4181c3eb238ae172a80d48aa36e4b9">isDefault</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1dc1c1ac9a476c04afcfbd423928aafd"></a><!-- doxytag: member="KSpell2::Dictionary::Dictionary" ref="a1dc1c1ac9a476c04afcfbd423928aafd" args="(const QString &lang, bool def=false)" -->
 </td><td class="memItemRight" valign="bottom"><b>Dictionary</b> (const <a class="elRef" href="qstring.html">QString</a> &lang, bool def=false)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7163b8b4c4977dbb020fb0a7567d662"></a><!-- doxytag: member="KSpell2::Dictionary::m_language" ref="ad7163b8b4c4977dbb020fb0a7567d662" args="" -->
<a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><b>m_language</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32a59df77decab5f13c713fa619b51b0"></a><!-- doxytag: member="KSpell2::Dictionary::m_default" ref="a32a59df77decab5f13c713fa619b51b0" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>m_default</b></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f539fc72a1dacd841b904a7bf77c753"></a><!-- doxytag: member="KSpell2::Dictionary::Broker" ref="a1f539fc72a1dacd841b904a7bf77c753" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Broker</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class is returned by from <a class="el" href="classKSpell2_1_1Broker.html" title="Class used to deal with dictionaries.">Broker</a>. </p>
<p>It acts as the actual spellchecker.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Zack Rusin <<a href="mailto:zack@kde.org">zack@kde.org</a>> class used for actuall spell checking </dd></dl>
<p>Definition at line <a class="el" href="dictionary_8h_source.html#l00037">37</a> of file <a class="el" href="dictionary_8h_source.html">dictionary.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acc259c20f219863105998b0173d83e5b"></a><!-- doxytag: member="KSpell2::Dictionary::addToPersonal" ref="acc259c20f219863105998b0173d83e5b" args="(const QString &word)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KSpell2::Dictionary::addToPersonal </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>word</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds word to the list of of personal words. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
<p>Implemented in <a class="el" href="classASpellDict.html#ab0b0682562a850c7f5ca1e3c1bd21fc7">ASpellDict</a>, and <a class="el" href="classHSpellDict.html#ac8def8f974b383e7ec6f6aac2dee7fbf">HSpellDict</a>.</p>
</div>
</div>
<a class="anchor" id="a4d0d03852408faf5897a160edc1721fd"></a><!-- doxytag: member="KSpell2::Dictionary::addToSession" ref="a4d0d03852408faf5897a160edc1721fd" args="(const QString &word)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KSpell2::Dictionary::addToSession </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>word</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds word to the words recognizable in the current session. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
<p>Implemented in <a class="el" href="classASpellDict.html#af9abc69d0cf71b7a99f3ac703988e9c9">ASpellDict</a>, and <a class="el" href="classHSpellDict.html#a3593ab66bdb60cbb34dae33ffe962b36">HSpellDict</a>.</p>
</div>
</div>
<a class="anchor" id="a249a7c2e68695f8184b58b3434068184"></a><!-- doxytag: member="KSpell2::Dictionary::check" ref="a249a7c2e68695f8184b58b3434068184" args="(const QString &word)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KSpell2::Dictionary::check </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>word</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks the given word. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false if the word is misspelled. true otherwise </dd></dl>
<p>Implemented in <a class="el" href="classASpellDict.html#ab8e876f36b6f233c3e15800b035f1f96">ASpellDict</a>, and <a class="el" href="classHSpellDict.html#ad727efb97db404ae8c4f98350e93cdb7">HSpellDict</a>.</p>
</div>
</div>
<a class="anchor" id="a4d49b4ade381db41edffb85dcc6fa42b"></a><!-- doxytag: member="KSpell2::Dictionary::checkAndSuggest" ref="a4d49b4ade381db41edffb85dcc6fa42b" args="(const QString &word, QStringList &suggestions)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KSpell2::Dictionary::checkAndSuggest </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>word</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"><em>suggestions</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks the word and fetches suggestions for it. </p>
<p>Implemented in <a class="el" href="classASpellDict.html#a705280414355ab185cea6caa3001d7c6">ASpellDict</a>, and <a class="el" href="classHSpellDict.html#ae5f061973f1dd062821d1dffe5f812b4">HSpellDict</a>.</p>
</div>
</div>
<a class="anchor" id="a2b4181c3eb238ae172a80d48aa36e4b9"></a><!-- doxytag: member="KSpell2::Dictionary::isDefault" ref="a2b4181c3eb238ae172a80d48aa36e4b9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KSpell2::Dictionary::isDefault </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if this dictionary was constructed from default Settings values. </p>
<p>Definition at line <a class="el" href="dictionary_8h_source.html#l00092">92</a> of file <a class="el" href="dictionary_8h_source.html">dictionary.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaf26837e9d7fc59f6b5c73d896f16ed6"></a><!-- doxytag: member="KSpell2::Dictionary::language" ref="aaf26837e9d7fc59f6b5c73d896f16ed6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> KSpell2::Dictionary::language </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns language supported by this dictionary. </p>
<p>Definition at line <a class="el" href="dictionary_8h_source.html#l00083">83</a> of file <a class="el" href="dictionary_8h_source.html">dictionary.h</a>.</p>
</div>
</div>
<a class="anchor" id="a00ec9e3b3900046cfc74f59a1188a9db"></a><!-- doxytag: member="KSpell2::Dictionary::storeReplacement" ref="a00ec9e3b3900046cfc74f59a1188a9db" args="(const QString &bad, const QString &good)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KSpell2::Dictionary::storeReplacement </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>bad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>good</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores user defined good replacement for the bad word. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
<p>Implemented in <a class="el" href="classASpellDict.html#ab90028cb5b28b7c0b372e89bac4fee5c">ASpellDict</a>, and <a class="el" href="classHSpellDict.html#a3103c593ecf0d55c148f09fac5b357cc">HSpellDict</a>.</p>
</div>
</div>
<a class="anchor" id="a0159c6ef79338dab82fcf613ba89f840"></a><!-- doxytag: member="KSpell2::Dictionary::suggest" ref="a0159c6ef79338dab82fcf613ba89f840" args="(const QString &word)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" href="qstringlist.html">QStringList</a> KSpell2::Dictionary::suggest </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>word</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetches suggestions for the word. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>list of all suggestions for the word </dd></dl>
<p>Implemented in <a class="el" href="classASpellDict.html#a1e74b7448a5b20fcf3e906abaa3c3769">ASpellDict</a>, and <a class="el" href="classHSpellDict.html#a454d4e6b7894ac989d4348f09b885a9b">HSpellDict</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dictionary_8h_source.html">dictionary.h</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kspell2</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classASpellDict.html">aspelldict</option>, <option value="classHSpellDict.html">hspelldict</option>, <option value="classKSpell2_1_1BackgroundChecker.html">kspell2::backgroundchecker</option>, <option value="classKSpell2_1_1Broker.html">kspell2::broker</option>, <option value="classKSpell2_1_1Client.html">kspell2::client</option>, <option value="classKSpell2_1_1Dictionary.html">kspell2::dictionary</option>, <option value="classKSpell2_1_1Filter.html">kspell2::filter</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
