<?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: dictionary.h Source File (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 class="header"> <div class="headertitle"> <div class="title">dictionary.h</div> </div> </div> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*-</span> <a name="l00002"></a>00002 <span class="comment">/*</span> <a name="l00003"></a>00003 <span class="comment"> * dictionary.h</span> <a name="l00004"></a>00004 <span class="comment"> *</span> <a name="l00005"></a>00005 <span class="comment"> * Copyright (C) 2004 Zack Rusin <zack@kde.org></span> <a name="l00006"></a>00006 <span class="comment"> *</span> <a name="l00007"></a>00007 <span class="comment"> * This library is free software; you can redistribute it and/or</span> <a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span> <a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span> <a name="l00010"></a>00010 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span> <a name="l00011"></a>00011 <span class="comment"> *</span> <a name="l00012"></a>00012 <span class="comment"> * This library is distributed in the hope that it will be useful,</span> <a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00015"></a>00015 <span class="comment"> * Lesser General Public License for more details.</span> <a name="l00016"></a>00016 <span class="comment"> *</span> <a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span> <a name="l00018"></a>00018 <span class="comment"> * License along with this library; if not, write to the Free Software</span> <a name="l00019"></a>00019 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA</span> <a name="l00020"></a>00020 <span class="comment"> * 02110-1301 USA</span> <a name="l00021"></a>00021 <span class="comment"> */</span> <a name="l00022"></a>00022 <span class="preprocessor">#ifndef KSPELL_DICTIONARY_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define KSPELL_DICTIONARY_H</span> <a name="l00024"></a>00024 <span class="preprocessor"></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <qstringlist.h></span> <a name="l00026"></a>00026 <span class="preprocessor">#include <qstring.h></span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="keyword">namespace </span>KSpell2 <a name="l00029"></a>00029 { <a name="l00037"></a><a class="code" href="classKSpell2_1_1Dictionary.html">00037</a> <span class="keyword">class </span><a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a> <a name="l00038"></a>00038 { <a name="l00039"></a>00039 <span class="keyword">public</span>: <a name="l00040"></a>00040 <span class="keyword">virtual</span> ~<a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a>() {} <a name="l00041"></a>00041 <a name="l00046"></a>00046 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKSpell2_1_1Dictionary.html#a249a7c2e68695f8184b58b3434068184" title="Checks the given word.">check</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& word ) =0; <a name="l00047"></a>00047 <a name="l00053"></a>00053 <span class="keyword">virtual</span> <a class="codeRef" href="qstringlist.html">QStringList</a> <a class="code" href="classKSpell2_1_1Dictionary.html#a0159c6ef79338dab82fcf613ba89f840" title="Fetches suggestions for the word.">suggest</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& word ) =0; <a name="l00054"></a>00054 <a name="l00058"></a>00058 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKSpell2_1_1Dictionary.html#a4d49b4ade381db41edffb85dcc6fa42b" title="Checks the word and fetches suggestions for it.">checkAndSuggest</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& word, <a name="l00059"></a>00059 <a class="codeRef" href="qstringlist.html">QStringList</a>& suggestions ) =0; <a name="l00060"></a>00060 <a name="l00065"></a>00065 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKSpell2_1_1Dictionary.html#a00ec9e3b3900046cfc74f59a1188a9db" title="Stores user defined good replacement for the bad word.">storeReplacement</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& bad, <a name="l00066"></a>00066 <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& good ) =0; <a name="l00067"></a>00067 <a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKSpell2_1_1Dictionary.html#acc259c20f219863105998b0173d83e5b" title="Adds word to the list of of personal words.">addToPersonal</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& word ) =0; <a name="l00073"></a>00073 <a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKSpell2_1_1Dictionary.html#a4d0d03852408faf5897a160edc1721fd" title="Adds word to the words recognizable in the current session.">addToSession</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& word ) =0; <a name="l00079"></a>00079 <a name="l00083"></a><a class="code" href="classKSpell2_1_1Dictionary.html#aaf26837e9d7fc59f6b5c73d896f16ed6">00083</a> <a class="codeRef" href="qstring.html">QString</a> <a class="code" href="classKSpell2_1_1Dictionary.html#aaf26837e9d7fc59f6b5c73d896f16ed6" title="Returns language supported by this dictionary.">language</a>()<span class="keyword"> const</span> <a name="l00084"></a>00084 <span class="keyword"> </span>{ <a name="l00085"></a>00085 <span class="keywordflow">return</span> m_language; <a name="l00086"></a>00086 } <a name="l00087"></a>00087 <a name="l00092"></a><a class="code" href="classKSpell2_1_1Dictionary.html#a2b4181c3eb238ae172a80d48aa36e4b9">00092</a> <span class="keywordtype">bool</span> <a class="code" href="classKSpell2_1_1Dictionary.html#a2b4181c3eb238ae172a80d48aa36e4b9" title="Returns true if this dictionary was constructed from default Settings values.">isDefault</a>()<span class="keyword"> const</span> <a name="l00093"></a>00093 <span class="keyword"> </span>{ <a name="l00094"></a>00094 <span class="keywordflow">return</span> m_default; <a name="l00095"></a>00095 } <a name="l00096"></a>00096 <a name="l00097"></a>00097 <span class="keyword">protected</span>: <a name="l00098"></a>00098 <a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& lang, <span class="keywordtype">bool</span> def = <span class="keyword">false</span> ) <a name="l00099"></a>00099 : m_language( lang ), m_default( def ) {} <a name="l00100"></a>00100 <span class="keyword">protected</span>: <a name="l00101"></a>00101 <span class="keyword">friend</span> <span class="keyword">class </span>Broker; <a name="l00102"></a>00102 <a class="codeRef" href="qstring.html">QString</a> m_language; <a name="l00103"></a>00103 <span class="keywordtype">bool</span> m_default; <a name="l00104"></a>00104 <span class="keyword">private</span>: <a name="l00105"></a>00105 <span class="keyword">class </span>Private; <a name="l00106"></a>00106 Private *d; <a name="l00107"></a>00107 }; <a name="l00108"></a>00108 } <a name="l00109"></a>00109 <a name="l00110"></a>00110 <span class="preprocessor">#endif</span> </pre></div></div> </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>