Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 1f9eb832ba1e4b88d9a5c2b384813bb4 > files > 6525

kdelibs3-apidocs-3.5.10-31.fc15.noarch.rpm

<?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: backgroundengine.cpp 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">backgroundengine.cpp</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00021"></a>00021 <span class="preprocessor">#include &quot;backgroundengine.h&quot;</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;defaultdictionary.h&quot;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;dictionary.h&quot;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;filter.h&quot;</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;kdebug.h&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;qtimer.h&gt;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">using namespace </span>KSpell2;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 BackgroundEngine::BackgroundEngine( <a class="codeRef" href="qobject.html">QObject</a> *parent )
<a name="l00034"></a>00034     : <a class="codeRef" href="qobject.html">QObject</a>( parent )
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036     m_filter = Filter::defaultFilter();
<a name="l00037"></a>00037     m_dict = 0;
<a name="l00038"></a>00038 }
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 BackgroundEngine::~BackgroundEngine()
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042     <span class="keyword">delete</span> m_dict; m_dict = 0;
<a name="l00043"></a>00043 }
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="keywordtype">void</span> BackgroundEngine::setBroker( <span class="keyword">const</span> Broker::Ptr&amp; broker )
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047     m_broker = broker;
<a name="l00048"></a>00048     <span class="keyword">delete</span> m_dict;
<a name="l00049"></a>00049     m_defaultDict = m_broker-&gt;defaultDictionary();
<a name="l00050"></a>00050     m_filter-&gt;setSettings( m_broker-&gt;settings() );
<a name="l00051"></a>00051 }
<a name="l00052"></a>00052 
<a name="l00053"></a>00053 <span class="keywordtype">void</span> BackgroundEngine::setText( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>&amp; text )
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055     m_filter-&gt;setBuffer( text );
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <a class="codeRef" href="qstring.html">QString</a> BackgroundEngine::text()<span class="keyword"> const</span>
<a name="l00059"></a>00059 <span class="keyword"></span>{
<a name="l00060"></a>00060     <span class="keywordflow">return</span> m_filter-&gt;buffer();
<a name="l00061"></a>00061 }
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="keywordtype">void</span> BackgroundEngine::changeLanguage( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>&amp; lang )
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065     <span class="keyword">delete</span> m_dict;
<a name="l00066"></a>00066     <span class="keywordflow">if</span> ( lang.<a class="codeRef" href="qstring.html#isEmpty">isEmpty</a>() ) {
<a name="l00067"></a>00067         m_dict = 0;
<a name="l00068"></a>00068     } <span class="keywordflow">else</span> {
<a name="l00069"></a>00069         m_dict = m_broker-&gt;dictionary( lang );
<a name="l00070"></a>00070     }
<a name="l00071"></a>00071 }
<a name="l00072"></a>00072 
<a name="l00073"></a>00073 <a class="codeRef" href="qstring.html">QString</a> BackgroundEngine::language()<span class="keyword"> const</span>
<a name="l00074"></a>00074 <span class="keyword"></span>{
<a name="l00075"></a>00075     <span class="keywordflow">if</span> ( m_dict )
<a name="l00076"></a>00076         <span class="keywordflow">return</span> m_dict-&gt;language();
<a name="l00077"></a>00077     <span class="keywordflow">else</span>
<a name="l00078"></a>00078         <span class="keywordflow">return</span> m_defaultDict-&gt;language();
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080 
<a name="l00081"></a>00081 <span class="keywordtype">void</span> BackgroundEngine::setFilter( <a class="code" href="classKSpell2_1_1Filter.html" title="Filter is used to split text into words which will be spell checked.">Filter</a> *filter )
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083     <a class="codeRef" href="qstring.html">QString</a> oldText = m_filter-&gt;buffer();
<a name="l00084"></a>00084     m_filter = filter;
<a name="l00085"></a>00085     m_filter-&gt;setBuffer( oldText );
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="keywordtype">void</span> BackgroundEngine::start()
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090     <a class="codeRef" href="qtimer.html#singleShot">QTimer::singleShot</a>( 0, <span class="keyword">this</span>, SLOT(checkNext()) );
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="keywordtype">void</span> BackgroundEngine::stop()
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 <span class="keywordtype">void</span> BackgroundEngine::continueChecking()
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099     <a class="codeRef" href="qtimer.html#singleShot">QTimer::singleShot</a>( 0, <span class="keyword">this</span>, SLOT(checkNext()) );
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101 
<a name="l00102"></a>00102 <span class="keywordtype">void</span> BackgroundEngine::checkNext()
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104     <a class="code" href="structKSpell2_1_1Word.html" title="Structure abstracts the word and its position in the parent text.">Word</a> w = m_filter-&gt;nextWord();
<a name="l00105"></a>00105     <span class="keywordflow">if</span> ( w.end ) {
<a name="l00106"></a>00106         emit done();
<a name="l00107"></a>00107         <span class="keywordflow">return</span>;
<a name="l00108"></a>00108     }
<a name="l00109"></a>00109 
<a name="l00110"></a>00110     <a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a> *dict = ( m_dict ) ? m_dict : static_cast&lt;Dictionary*&gt;( m_defaultDict );
<a name="l00111"></a>00111 
<a name="l00112"></a>00112     <span class="keywordflow">if</span> ( !dict-&gt;<a class="code" href="classKSpell2_1_1Dictionary.html#a249a7c2e68695f8184b58b3434068184" title="Checks the given word.">check</a>( w.word ) ) {
<a name="l00113"></a>00113         <span class="comment">//kdDebug()&lt;&lt;&quot;found misspelling &quot;&lt;&lt; w.word &lt;&lt;endl;</span>
<a name="l00114"></a>00114         emit misspelling( w.word, w.start );
<a name="l00115"></a>00115         <span class="comment">//wait for the handler. the parent will decide itself when to continue</span>
<a name="l00116"></a>00116     } <span class="keywordflow">else</span>
<a name="l00117"></a>00117         continueChecking();
<a name="l00118"></a>00118 }
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 <span class="keywordtype">bool</span> BackgroundEngine::checkWord( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>&amp; word )
<a name="l00121"></a>00121 {
<a name="l00122"></a>00122     <a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a> *dict = ( m_dict ) ? m_dict : static_cast&lt;Dictionary*&gt;( m_defaultDict );
<a name="l00123"></a>00123     <span class="keywordflow">return</span> dict-&gt;<a class="code" href="classKSpell2_1_1Dictionary.html#a249a7c2e68695f8184b58b3434068184" title="Checks the given word.">check</a>( word );
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125 
<a name="l00126"></a>00126 <span class="keywordtype">bool</span> BackgroundEngine::addWord( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>&amp; word )
<a name="l00127"></a>00127 {
<a name="l00128"></a>00128     <a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a> *dict = ( m_dict ) ? m_dict : static_cast&lt;Dictionary*&gt;( m_defaultDict );
<a name="l00129"></a>00129     <span class="keywordflow">return</span> dict-&gt;<a class="code" href="classKSpell2_1_1Dictionary.html#acc259c20f219863105998b0173d83e5b" title="Adds word to the list of of personal words.">addToPersonal</a>( word );
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131 
<a name="l00132"></a>00132 <a class="codeRef" href="qstringlist.html">QStringList</a> BackgroundEngine::suggest( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>&amp; word )
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134     <a class="code" href="classKSpell2_1_1Dictionary.html" title="Class is returned by from Broker.">Dictionary</a> *dict = ( m_dict ) ? m_dict : static_cast&lt;Dictionary*&gt;( m_defaultDict );
<a name="l00135"></a>00135     <span class="keywordflow">return</span> dict-&gt;<a class="code" href="classKSpell2_1_1Dictionary.html#a0159c6ef79338dab82fcf613ba89f840" title="Fetches suggestions for the word.">suggest</a>( word );
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137 
<a name="l00138"></a>00138 <span class="preprocessor">#include &quot;backgroundengine.moc&quot;</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>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>