<?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::BackgroundChecker 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.4.4 -->
<div class="nav">
<a class="el" href="namespaceKSpell2.html">KSpell2</a>::<a class="el" href="classKSpell2_1_1BackgroundChecker.html">BackgroundChecker</a></div>
<h1>KSpell2::BackgroundChecker Class Reference</h1><!-- doxytag: class="KSpell2::BackgroundChecker" --><!-- doxytag: inherits="QObject" --><code>#include <<a class="el" href="backgroundchecker_8h-source.html">backgroundchecker.h</a>></code>
<p>
<p>Inheritance diagram for KSpell2::BackgroundChecker:
<p><center><img src="classKSpell2_1_1BackgroundChecker.png" usemap="#KSpell2::BackgroundChecker_map" border="0" alt=""></center>
<map name="KSpell2::BackgroundChecker_map">
<area doxygen="qt.tag:" href="qobject.html" alt="QObject" shape="rect" coords="0,0,177,24">
</map>
<a href="classKSpell2_1_1BackgroundChecker-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classKSpell2_1_1BackgroundChecker.html">BackgroundChecker</a> is used to perform spell checking without blocking the application.class used for spell checking in the background.
<p>
You can use it as is by calling the checkText function or subclass it and reimplement getMoreText function.<p>
The misspelling signal is emitted whenever a mispelled word is found. The background checker stops right before emitting the signal. So the parent has to call continueChecking function to resume the checking.<p>
done signal is emitted when whole text is spell checked.<p>
<dl compact><dt><b>Author:</b></dt><dd>Zack Rusin <<a href="mailto:zack@kde.org">zack@kde.org</a>></dd></dl>
<p>
<p>
Definition at line <a class="el" href="backgroundchecker_8h-source.html#l00049">49</a> of file <a class="el" href="backgroundchecker_8h-source.html">backgroundchecker.h</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="i0"></a><!-- doxytag: member="KSpell2::BackgroundChecker::setFilter" ref="i0" args="(KSpell2::Filter *filter)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setFilter</b> (<a class="el" href="classKSpell2_1_1Filter.html">KSpell2::Filter</a> *filter)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="i1"></a><!-- doxytag: member="KSpell2::BackgroundChecker::start" ref="i1" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>start</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="i2"></a><!-- doxytag: member="KSpell2::BackgroundChecker::stop" ref="i2" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>stop</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1BackgroundChecker.html#i3">continueChecking</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1BackgroundChecker.html#l0">misspelling</a> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &word, int start)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1BackgroundChecker.html#l1">done</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="KSpell2::BackgroundChecker::BackgroundChecker" ref="a0" args="(const Broker::Ptr &broker, QObject *parent=0, const char *name=0)" -->
</td><td class="memItemRight" valign="bottom"><b>BackgroundChecker</b> (const <a class="el" href="classKSpell2_1_1Broker.html#w0">Broker::Ptr</a> &broker, <a class="elRef" doxygen="qt.tag:" href="qobject.html">QObject</a> *<a class="elRef" doxygen="qt.tag:" href="qobject.html#parent">parent</a>=0, const char *<a class="elRef" doxygen="qt.tag:" href="qobject.html#name">name</a>=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1BackgroundChecker.html#a2">checkText</a> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="KSpell2::BackgroundChecker::filter" ref="a3" args="() const " -->
<a class="el" href="classKSpell2_1_1Filter.html">Filter</a> * </td><td class="memItemRight" valign="bottom"><b>filter</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="KSpell2::BackgroundChecker::broker" ref="a4" args="() const " -->
<a class="el" href="classKSpell2_1_1Broker.html">Broker</a> * </td><td class="memItemRight" valign="bottom"><b>broker</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="KSpell2::BackgroundChecker::changeLanguage" ref="a5" args="(const QString &lang)" -->
void </td><td class="memItemRight" valign="bottom"><b>changeLanguage</b> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &lang)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="KSpell2::BackgroundChecker::checkWord" ref="a6" args="(const QString &word)" -->
bool </td><td class="memItemRight" valign="bottom"><b>checkWord</b> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &word)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="KSpell2::BackgroundChecker::suggest" ref="a7" args="(const QString &) const " -->
<a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><b>suggest</b> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="KSpell2::BackgroundChecker::addWord" ref="a8" args="(const QString &word)" -->
bool </td><td class="memItemRight" valign="bottom"><b>addWord</b> (const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> &word)</td></tr>
<tr><td colspan="2"><br><h2>Protected Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="j0"></a><!-- doxytag: member="KSpell2::BackgroundChecker::slotEngineDone" ref="j0" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>slotEngineDone</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1BackgroundChecker.html#b0">getMoreText</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1BackgroundChecker.html#b1">finishedCurrentFeed</a> ()</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2"></a><!-- doxytag: member="KSpell2::BackgroundChecker::checkText" ref="a2" args="(const QString &)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KSpell2::BackgroundChecker::checkText </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> & </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This method is used to spell check static text.
<p>
It automatically invokes start().<p>
Use <a class="el" href="classKSpell2_1_1BackgroundChecker.html#b0">getMoreText()</a> with start() to spell check a stream. </td>
</tr>
</table>
<a class="anchor" name="i3"></a><!-- doxytag: member="KSpell2::BackgroundChecker::continueChecking" ref="i3" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KSpell2::BackgroundChecker::continueChecking </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual, slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
After emitting misspelling signal the background checker stops.
<p>
The catcher is responsible for calling continueChecking function to resume checking. </td>
</tr>
</table>
<a class="anchor" name="l1"></a><!-- doxytag: member="KSpell2::BackgroundChecker::done" ref="l1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KSpell2::BackgroundChecker::done </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [signal]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Emitted after the whole text has been spell checked.
<p>
</td>
</tr>
</table>
<a class="anchor" name="b1"></a><!-- doxytag: member="KSpell2::BackgroundChecker::finishedCurrentFeed" ref="b1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KSpell2::BackgroundChecker::finishedCurrentFeed </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function will be called whenever the background checker will be finished text which it got from getMoreText.
<p>
</td>
</tr>
</table>
<a class="anchor" name="b0"></a><!-- doxytag: member="KSpell2::BackgroundChecker::getMoreText" ref="b0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> KSpell2::BackgroundChecker::getMoreText </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called to get the text to spell check.
<p>
It will be called continuesly until it returns QString::null in which case the <a class="el" href="classKSpell2_1_1BackgroundChecker.html#l1">done()</a> singnal is emitted. Note: the start parameter in mispelling() is not a combined position but a position in the last string returned by getMoreText. You need to store the state in the derivatives. </td>
</tr>
</table>
<a class="anchor" name="l0"></a><!-- doxytag: member="KSpell2::BackgroundChecker::misspelling" ref="l0" args="(const QString &word, int start)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KSpell2::BackgroundChecker::misspelling </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qstring.html">QString</a> & </td>
<td class="mdname" nowrap> <em>word</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>start</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [signal]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Emitted whenever a misspelled word is found.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="backgroundchecker_8h-source.html">backgroundchecker.h</a></ul>
</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="dirs.html">Directories</a></li><li><a href="namespacemembers.html">Namespace Members</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="classASpellClient.html">aspellclient</option>, <option value="classASpellDict.html">aspelldict</option>, <option value="classHSpellClient.html">hspellclient</option>, <option value="classHSpellDict.html">hspelldict</option>, <option value="classISpellChecker.html">ispellchecker</option>, <option value="classISpellClient.html">ispellclient</option>, <option value="classISpellDict.html">ispelldict</option>, <option value="classKSpell2_1_1BackgroundChecker.html">kspell2::backgroundchecker</option>, <option value="classKSpell2_1_1BackgroundEngine.html">kspell2::backgroundengine</option>, <option value="classKSpell2_1_1BackgroundThread.html">kspell2::backgroundthread</option>, <option value="classKSpell2_1_1Broker.html">kspell2::broker</option>, <option value="classKSpell2_1_1Client.html">kspell2::client</option>, <option value="classKSpell2_1_1ConfigDialog.html">kspell2::configdialog</option>, <option value="classKSpell2_1_1ConfigWidget.html">kspell2::configwidget</option>, <option value="classKSpell2_1_1DefaultDictionary.html">kspell2::defaultdictionary</option>, <option value="classKSpell2_1_1Dialog.html">kspell2::dialog</option>, <option value="classKSpell2_1_1Dictionary.html">kspell2::dictionary</option>, <option value="classKSpell2_1_1Filter.html">kspell2::filter</option>, <option value="classKSpell2_1_1FinishedCheckingEvent.html">kspell2::finishedcheckingevent</option>, <option value="classKSpell2_1_1Highlighter.html">kspell2::highlighter</option>, <option value="classKSpell2_1_1MisspellingEvent.html">kspell2::misspellingevent</option>, <option value="classKSpell2_1_1Settings.html">kspell2::settings</option>, <option value="classKSpell2ConfigUI.html">kspell2configui</option>, <option value="classKSpell2UI.html">kspell2ui</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>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
90467ea6a387df728f7218a11e972208
>
files
>
9324
