<?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::Filter 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_1Filter.html">Filter</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">KSpell2::Filter Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KSpell2::Filter" -->
<p><a class="el" href="classKSpell2_1_1Filter.html" title="Filter is used to split text into words which will be spell checked.">Filter</a> is used to split text into words which will be spell checked.
<a href="classKSpell2_1_1Filter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="filter_8h_source.html">filter.h</a>></code></p>
<p><a href="classKSpell2_1_1Filter-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Filter.html#a71c8308c111b71cd17e7409b9e6c480b">setSettings</a> (Settings *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Settings * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Filter.html#acbe110cc6719a25084b844361296ef93">settings</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b1d8a39004527c5df09124315803dd5"></a><!-- doxytag: member="KSpell2::Filter::atEnd" ref="a1b1d8a39004527c5df09124315803dd5" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>atEnd</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44ffa3d01245ef25cf32a1d3aeacf4e7"></a><!-- doxytag: member="KSpell2::Filter::setBuffer" ref="a44ffa3d01245ef25cf32a1d3aeacf4e7" args="(const QString &buffer)" -->
void </td><td class="memItemRight" valign="bottom"><b>setBuffer</b> (const <a class="elRef" href="qstring.html">QString</a> &buffer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59d638a8ffdfb81ff88a2dded87da23d"></a><!-- doxytag: member="KSpell2::Filter::buffer" ref="a59d638a8ffdfb81ff88a2dded87da23d" args="() const " -->
<a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><b>buffer</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af86b90496a1d20b71478e049f83715fe"></a><!-- doxytag: member="KSpell2::Filter::restart" ref="af86b90496a1d20b71478e049f83715fe" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>restart</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf6a1c6084f858659bf61012bebf98a9"></a><!-- doxytag: member="KSpell2::Filter::nextWord" ref="adf6a1c6084f858659bf61012bebf98a9" args="() const " -->
virtual <a class="el" href="structKSpell2_1_1Word.html">Word</a> </td><td class="memItemRight" valign="bottom"><b>nextWord</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fbf6390f61cd39c037ebc7461876e56"></a><!-- doxytag: member="KSpell2::Filter::previousWord" ref="a5fbf6390f61cd39c037ebc7461876e56" args="() const " -->
virtual <a class="el" href="structKSpell2_1_1Word.html">Word</a> </td><td class="memItemRight" valign="bottom"><b>previousWord</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9aa8df0c14edee6e4227e0ea9480a54c"></a><!-- doxytag: member="KSpell2::Filter::wordAtPosition" ref="a9aa8df0c14edee6e4227e0ea9480a54c" args="(unsigned int pos) const " -->
virtual <a class="el" href="structKSpell2_1_1Word.html">Word</a> </td><td class="memItemRight" valign="bottom"><b>wordAtPosition</b> (unsigned int pos) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a680ee3cba9765876b24602f2d1e023da"></a><!-- doxytag: member="KSpell2::Filter::setCurrentPosition" ref="a680ee3cba9765876b24602f2d1e023da" args="(int)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setCurrentPosition</b> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2260d9743b558ef5b015d1067d057efd"></a><!-- doxytag: member="KSpell2::Filter::currentPosition" ref="a2260d9743b558ef5b015d1067d057efd" args="() const " -->
virtual int </td><td class="memItemRight" valign="bottom"><b>currentPosition</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2190d2d1264e6f4f74c84480f180105"></a><!-- doxytag: member="KSpell2::Filter::replace" ref="ad2190d2d1264e6f4f74c84480f180105" args="(const Word &w, const QString &newWord)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>replace</b> (const <a class="el" href="structKSpell2_1_1Word.html">Word</a> &w, const <a class="elRef" href="qstring.html">QString</a> &newWord)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Filter.html#aeeb40f1a650bffa2621dc241fa6f0f6a">context</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3850dd4294e79c8e8a90bd65be900f27"></a><!-- doxytag: member="KSpell2::Filter::defaultFilter" ref="a3850dd4294e79c8e8a90bd65be900f27" args="()" -->
static <a class="el" href="classKSpell2_1_1Filter.html">Filter</a> * </td><td class="memItemRight" valign="bottom"><b>defaultFilter</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9302e5d6745fefd0d6c10af33b86c7da"></a><!-- doxytag: member="KSpell2::Filter::end" ref="a9302e5d6745fefd0d6c10af33b86c7da" args="()" -->
static <a class="el" href="structKSpell2_1_1Word.html">Word</a> </td><td class="memItemRight" valign="bottom"><b>end</b> ()</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="a0296d549b5502423d37770ea7a766cb5"></a><!-- doxytag: member="KSpell2::Filter::trySkipLinks" ref="a0296d549b5502423d37770ea7a766cb5" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>trySkipLinks</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50b908597ce1a8aa870e1c8df7ed31d2"></a><!-- doxytag: member="KSpell2::Filter::ignore" ref="a50b908597ce1a8aa870e1c8df7ed31d2" args="(const QString &word) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>ignore</b> (const <a class="elRef" href="qstring.html">QString</a> &word) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0013aa195fcd5a474913af053f436e4"></a><!-- doxytag: member="KSpell2::Filter::skipToLetter" ref="ae0013aa195fcd5a474913af053f436e4" args="(uint &fromPosition) const " -->
<a class="elRef" href="qchar.html">QChar</a> </td><td class="memItemRight" valign="bottom"><b>skipToLetter</b> (uint &fromPosition) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c7c4f4a6778e43c0762942c69ad4ef8"></a><!-- doxytag: member="KSpell2::Filter::shouldBeSkipped" ref="a5c7c4f4a6778e43c0762942c69ad4ef8" args="(bool wordWasUppercase, bool wordWasRunTogether, const QString &foundWord) const " -->
bool </td><td class="memItemRight" valign="bottom"><b>shouldBeSkipped</b> (bool wordWasUppercase, bool wordWasRunTogether, const <a class="elRef" href="qstring.html">QString</a> &foundWord) const </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="a64a9a02124537957e57972534ace3a63"></a><!-- doxytag: member="KSpell2::Filter::m_buffer" ref="a64a9a02124537957e57972534ace3a63" args="" -->
<a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><b>m_buffer</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adefd138ecabde4d442828292910367bd"></a><!-- doxytag: member="KSpell2::Filter::m_currentPosition" ref="adefd138ecabde4d442828292910367bd" args="" -->
uint </td><td class="memItemRight" valign="bottom"><b>m_currentPosition</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classKSpell2_1_1Filter.html" title="Filter is used to split text into words which will be spell checked.">Filter</a> is used to split text into words which will be spell checked. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Zack Rusin <<a href="mailto:zack@kde.org">zack@kde.org</a>> used to split text into words </dd></dl>
<p>Definition at line <a class="el" href="filter_8h_source.html#l00065">65</a> of file <a class="el" href="filter_8h_source.html">filter.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeeb40f1a650bffa2621dc241fa6f0f6a"></a><!-- doxytag: member="KSpell2::Filter::context" ref="aeeb40f1a650bffa2621dc241fa6f0f6a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> KSpell2::Filter::context </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Should return the sentence containing the current word. </p>
<p>Definition at line <a class="el" href="filter_8cpp_source.html#l00219">219</a> of file <a class="el" href="filter_8cpp_source.html">filter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a71c8308c111b71cd17e7409b9e6c480b"></a><!-- doxytag: member="KSpell2::Filter::setSettings" ref="a71c8308c111b71cd17e7409b9e6c480b" args="(Settings *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KSpell2::Filter::setSettings </td>
<td>(</td>
<td class="paramtype">Settings * </td>
<td class="paramname"><em>conf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Settings object for this <a class="el" href="classKSpell2_1_1Filter.html" title="Filter is used to split text into words which will be spell checked.">Filter</a>. </p>
<p>Definition at line <a class="el" href="filter_8cpp_source.html#l00072">72</a> of file <a class="el" href="filter_8cpp_source.html">filter.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acbe110cc6719a25084b844361296ef93"></a><!-- doxytag: member="KSpell2::Filter::settings" ref="acbe110cc6719a25084b844361296ef93" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Settings * KSpell2::Filter::settings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns currently used Settings object. </p>
<p>Definition at line <a class="el" href="filter_8cpp_source.html#l00077">77</a> of file <a class="el" href="filter_8cpp_source.html">filter.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="filter_8h_source.html">filter.h</a></li>
<li><a class="el" href="filter_8cpp_source.html">filter.cpp</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>
