<?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>kutils: kfind.h Source File (kutils)</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=".">kutils</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">kfind.h</div> </div> </div> <div class="contents"> <div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2001, S.R.Haque <srhaque@iee.org>.</span> <a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2002, David Faure <david@mandrakesoft.com></span> <a name="l00004"></a>00004 <span class="comment"> This file is part of the KDE project</span> <a name="l00005"></a>00005 <span class="comment"></span> <a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00008"></a>00008 <span class="comment"> License version 2, as published by the Free Software Foundation.</span> <a name="l00009"></a>00009 <span class="comment"></span> <a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span> <a name="l00014"></a>00014 <span class="comment"></span> <a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public License</span> <a name="l00016"></a>00016 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span> <a name="l00017"></a>00017 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span> <a name="l00018"></a>00018 <span class="comment"> Boston, MA 02110-1301, USA.</span> <a name="l00019"></a>00019 <span class="comment">*/</span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef KFIND_H</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define KFIND_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include <kdialogbase.h></span> <a name="l00025"></a>00025 <span class="preprocessor">#include <qrect.h></span> <a name="l00026"></a>00026 <a name="l00103"></a><a class="code" href="classKFind.html">00103</a> <span class="keyword">class </span>KUTILS_EXPORT <a class="code" href="classKFind.html" title="A generic implementation of the "find" function.">KFind</a> : <a name="l00104"></a>00104 <span class="keyword">public</span> <a class="codeRef" href="qobject.html">QObject</a> <a name="l00105"></a>00105 { <a name="l00106"></a>00106 Q_OBJECT <a name="l00107"></a>00107 <a name="l00108"></a>00108 <span class="keyword">public</span>: <a name="l00109"></a>00109 <a name="l00117"></a>00117 <a class="code" href="classKFind.html" title="A generic implementation of the "find" function.">KFind</a>(<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &pattern, <span class="keywordtype">long</span> options, <a class="codeRef" href="qwidget.html">QWidget</a> *parent); <a name="l00118"></a>00118 <a name="l00129"></a>00129 <a class="code" href="classKFind.html" title="A generic implementation of the "find" function.">KFind</a>(<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &pattern, <span class="keywordtype">long</span> options, <a class="codeRef" href="qwidget.html">QWidget</a> *parent, <a class="codeRef" href="qwidget.html">QWidget</a>* findDialog); <a name="l00130"></a>00130 <a name="l00134"></a>00134 <span class="keyword">virtual</span> ~<a class="code" href="classKFind.html" title="A generic implementation of the "find" function.">KFind</a>(); <a name="l00135"></a>00135 <a name="l00139"></a><a class="code" href="classKFind.html#a40a6b946c7c572127a8bc03f0983086f">00139</a> <span class="keyword">enum</span> <a class="code" href="classKFind.html#a40a6b946c7c572127a8bc03f0983086f" title="Result enum.">Result</a> { <a name="l00140"></a><a class="code" href="classKFind.html#a40a6b946c7c572127a8bc03f0983086faba61fbb9416d27f4ca375335f6aadf5a">00140</a> <a class="code" href="classKFind.html#a40a6b946c7c572127a8bc03f0983086faba61fbb9416d27f4ca375335f6aadf5a" title="No match was found.">NoMatch</a>, <a name="l00141"></a><a class="code" href="classKFind.html#a40a6b946c7c572127a8bc03f0983086fafbed2acec3f17225b88e7e8d7d4a6027">00141</a> Match <a name="l00142"></a>00142 }; <a name="l00143"></a>00143 <a name="l00150"></a>00150 <span class="keywordtype">bool</span> needData() <span class="keyword">const</span>; <a name="l00151"></a>00151 <a name="l00161"></a>00161 <span class="keywordtype">void</span> setData( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& data, <span class="keywordtype">int</span> startPos = -1 ); <a name="l00162"></a>00162 <a name="l00176"></a>00176 <span class="keywordtype">void</span> setData( <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& data, <span class="keywordtype">int</span> startPos = -1 ); <a name="l00177"></a>00177 <a name="l00184"></a>00184 Result find(); <a name="l00185"></a>00185 <a name="l00195"></a><a class="code" href="classKFind.html#a5aac4ccbdf73d8ee87c332f7e41484c2">00195</a> <span class="keywordtype">long</span> <a class="code" href="classKFind.html#a5aac4ccbdf73d8ee87c332f7e41484c2" title="Return the current options.">options</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_options; } <a name="l00196"></a>00196 <a name="l00203"></a>00203 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setOptions( <span class="keywordtype">long</span> options ); <a name="l00204"></a>00204 <a name="l00208"></a><a class="code" href="classKFind.html#a56d66f34345ae798fc561ad13336a779">00208</a> <a class="codeRef" href="qstring.html">QString</a> <a class="code" href="classKFind.html#a56d66f34345ae798fc561ad13336a779">pattern</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_pattern; } <a name="l00209"></a>00209 <a name="l00214"></a>00214 <span class="keywordtype">void</span> setPattern( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& pattern ); <a name="l00215"></a>00215 <a name="l00223"></a><a class="code" href="classKFind.html#a48e3acd3fc80b9209789b25269c5ece2">00223</a> <span class="keywordtype">int</span> <a class="code" href="classKFind.html#a48e3acd3fc80b9209789b25269c5ece2" title="Return the number of matches found (i.e.">numMatches</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_matches; } <a name="l00224"></a>00224 <a name="l00231"></a><a class="code" href="classKFind.html#afb374c90fc8ee5c1f21f84d934b0df35">00231</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKFind.html#afb374c90fc8ee5c1f21f84d934b0df35" title="Call this to reset the numMatches count (and the numReplacements count for a KReplace).">resetCounts</a>() { m_matches = 0; } <a name="l00232"></a>00232 <a name="l00243"></a><a class="code" href="classKFind.html#a469e02f43c69769b3f4c3c815241a69d">00243</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKFind.html#a469e02f43c69769b3f4c3c815241a69d" title="Virtual method, which allows applications to add extra checks for validating a candidate match...">validateMatch</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> & text, <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> matchedlength ) { <a name="l00244"></a>00244 Q_UNUSED(text); Q_UNUSED(index); Q_UNUSED(matchedlength); <span class="keywordflow">return</span> <span class="keyword">true</span>; } <a name="l00245"></a>00245 <a name="l00261"></a>00261 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> shouldRestart( <span class="keywordtype">bool</span> forceAsking = <span class="keyword">false</span>, <span class="keywordtype">bool</span> showNumMatches = <span class="keyword">true</span> ) <span class="keyword">const</span>; <a name="l00262"></a>00262 <a name="l00277"></a>00277 <span class="keyword">static</span> <span class="keywordtype">int</span> find( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &text, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &pattern, <span class="keywordtype">int</span> index, <span class="keywordtype">long</span> options, <span class="keywordtype">int</span> *matchedlength ); <a name="l00278"></a>00278 <a name="l00292"></a>00292 <span class="keyword">static</span> <span class="keywordtype">int</span> find( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &text, <span class="keyword">const</span> <a class="codeRef" href="qregexp.html">QRegExp</a> &pattern, <span class="keywordtype">int</span> index, <span class="keywordtype">long</span> options, <span class="keywordtype">int</span> *matchedlength ); <a name="l00293"></a>00293 <a name="l00298"></a>00298 <span class="keyword">virtual</span> <span class="keywordtype">void</span> displayFinalDialog() <span class="keyword">const</span>; <a name="l00299"></a>00299 <a name="l00308"></a>00308 <a class="codeRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKDialogBase.html">KDialogBase</a>* findNextDialog( <span class="keywordtype">bool</span> create = <span class="keyword">false</span> ); <a name="l00309"></a>00309 <a name="l00318"></a>00318 <span class="keywordtype">void</span> closeFindNextDialog(); <a name="l00319"></a>00319 <a name="l00327"></a>00327 <span class="keywordtype">int</span> index() <span class="keyword">const</span>; <a name="l00328"></a>00328 <a name="l00329"></a>00329 signals: <a name="l00330"></a>00330 <a name="l00347"></a>00347 <span class="keywordtype">void</span> highlight(<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &text, <span class="keywordtype">int</span> matchingIndex, <span class="keywordtype">int</span> matchedLength); <a name="l00348"></a>00348 <a name="l00367"></a>00367 <span class="keywordtype">void</span> highlight(<span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">int</span> matchingIndex, <span class="keywordtype">int</span> matchedLength); <a name="l00368"></a>00368 <a name="l00369"></a>00369 <span class="comment">// ## TODO docu</span> <a name="l00370"></a>00370 <span class="comment">// findprevious will also emit findNext, after temporarily switching the value</span> <a name="l00371"></a>00371 <span class="comment">// of FindBackwards</span> <a name="l00372"></a>00372 <span class="keywordtype">void</span> findNext(); <a name="l00373"></a>00373 <a name="l00379"></a>00379 <span class="keywordtype">void</span> optionsChanged(); <a name="l00380"></a>00380 <a name="l00387"></a>00387 <span class="keywordtype">void</span> dialogClosed(); <a name="l00388"></a>00388 <a name="l00389"></a>00389 <span class="keyword">protected</span>: <a name="l00390"></a>00390 <a name="l00391"></a>00391 <a class="codeRef" href="qwidget.html">QWidget</a>* parentWidget()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (<a class="codeRef" href="qwidget.html">QWidget</a> *)<a class="codeRef" href="qobject.html#parent">parent</a>(); } <a name="l00392"></a>00392 <a class="codeRef" href="qwidget.html">QWidget</a>* dialogsParent() <span class="keyword">const</span>; <a name="l00393"></a>00393 <a name="l00394"></a>00394 <span class="keyword">protected</span> slots: <a name="l00395"></a>00395 <a name="l00396"></a>00396 <span class="keywordtype">void</span> slotFindNext(); <a name="l00397"></a>00397 <span class="keywordtype">void</span> slotDialogClosed(); <a name="l00398"></a>00398 <a name="l00399"></a>00399 <span class="keyword">private</span>: <a name="l00400"></a>00400 <span class="keywordtype">void</span> init( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& pattern ); <a name="l00401"></a>00401 <span class="keywordtype">void</span> startNewIncrementalSearch(); <a name="l00402"></a>00402 <a name="l00403"></a>00403 <span class="keyword">static</span> <span class="keywordtype">bool</span> isInWord( <a class="codeRef" href="qchar.html">QChar</a> ch ); <a name="l00404"></a>00404 <span class="keyword">static</span> <span class="keywordtype">bool</span> isWholeWords( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &text, <span class="keywordtype">int</span> starts, <span class="keywordtype">int</span> matchedLength ); <a name="l00405"></a>00405 <a name="l00406"></a>00406 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKReplace.html" title="A generic implementation of the "replace" function.">KReplace</a>; <a name="l00407"></a>00407 <a name="l00408"></a>00408 <a name="l00409"></a>00409 <a class="codeRef" href="qstring.html">QString</a> m_pattern; <a name="l00410"></a>00410 <a class="codeRef" href="qregexp.html">QRegExp</a> *m_regExp; <a name="l00411"></a>00411 <a class="codeRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKDialogBase.html">KDialogBase</a>* m_dialog; <a name="l00412"></a>00412 <span class="keywordtype">long</span> m_options; <a name="l00413"></a>00413 <span class="keywordtype">unsigned</span> m_matches; <a name="l00414"></a>00414 <a name="l00415"></a>00415 <a class="codeRef" href="qstring.html">QString</a> m_text; <span class="comment">// the text set by setData</span> <a name="l00416"></a>00416 <span class="keywordtype">int</span> m_index; <a name="l00417"></a>00417 <span class="keywordtype">int</span> m_matchedLength; <a name="l00418"></a>00418 <span class="keywordtype">bool</span> m_dialogClosed; <a name="l00419"></a>00419 <span class="keywordtype">bool</span> m_lastResult; <a name="l00420"></a>00420 <a name="l00421"></a>00421 <span class="comment">// Binary compatible extensibility.</span> <a name="l00422"></a>00422 <span class="keyword">struct </span>Private; <a name="l00423"></a>00423 Private *d; <a name="l00424"></a>00424 }; <a name="l00425"></a>00425 <a name="l00426"></a>00426 <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>kutils</h2> <div class="nav_list"> <ul><li><a href="index.html">Main Page</a></li><li><a href="modules.html">Modules</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><li><a href="pages.html">Related Pages</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="classKCModuleContainer.html">kcmodulecontainer</option>, <option value="classKCModuleInfo.html">kcmoduleinfo</option>, <option value="classKCModuleLoader.html">kcmoduleloader</option>, <option value="classKCModuleProxy.html">kcmoduleproxy</option>, <option value="classKCModuleProxyIface.html">kcmoduleproxyiface</option>, <option value="classKCModuleProxyRootDispatcher.html">kcmoduleproxyrootdispatcher</option>, <option value="classKCMultiDialog.html">kcmultidialog</option>, <option value="classKFind.html">kfind</option>, <option value="classKFindDialog.html">kfinddialog</option>, <option value="classKMultiTabBar.html">kmultitabbar</option>, <option value="classKMultiTabBarButton.html">kmultitabbarbutton</option>, <option value="classKMultiTabBarTab.html">kmultitabbartab</option>, <option value="classKPluginInfo.html">kplugininfo</option>, <option value="classKPluginSelector.html">kpluginselector</option>, <option value="classKReplace.html">kreplace</option>, <option value="classKReplaceDialog.html">kreplacedialog</option>, <option value="classKSettings_1_1ComponentsDialog.html">ksettings::componentsdialog</option>, <option value="classKSettings_1_1Dialog.html">ksettings::dialog</option>, <option value="classKSettings_1_1Dispatcher.html">ksettings::dispatcher</option>, <option value="classKSettings_1_1PluginPage.html">ksettings::pluginpage</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>