<?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>kmail: kmfoldersearch.h Source File (kmail)</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" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</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>
<img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM 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_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
/ <a href=".">kmail</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;">
<h2><a name="content"></a>kmail</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>kmfoldersearch.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> This file is part of KMail, the KDE mail client.</span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (c) 2000 Don Sanders <sanders@kde.org></span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> KMail is free software; you can redistribute it and/or modify it</span>
<a name="l00006"></a>00006 <span class="comment"> under the terms of the GNU General Public License, version 2, as</span>
<a name="l00007"></a>00007 <span class="comment"> published by the Free Software Foundation.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> KMail is distributed in the hope that it will be useful, but</span>
<a name="l00010"></a>00010 <span class="comment"> WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00015"></a>00015 <span class="comment"> along with this program; if not, write to the Free Software</span>
<a name="l00016"></a>00016 <span class="comment"> Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 <span class="comment">// Dynamic search folder</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef kmfoldersearch_h</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define kmfoldersearch_h</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <qguardedptr.h></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <qvaluelist.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <qvaluevector.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <qvaluestack.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <qmap.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "kmfolder.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "folderstorage.h"</span>
<a name="l00030"></a>00030
<a name="l00040"></a>00040 <span class="keyword">typedef</span> QValueList<Q_UINT32> SerNumList;
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="classKMSearchPattern.html" title="This class is an abstraction of a search over messages.">KMSearchPattern</a>;
<a name="l00042"></a>00042 <span class="keyword">class </span>KMFolderImap;
<a name="l00043"></a>00043 <span class="keyword">class </span>KMFolderSearchJob;
<a name="l00044"></a>00044 <span class="keyword">class </span>KMIndexSearchTarget;
<a name="l00045"></a>00045 <span class="keyword">class </span>QTimer;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">namespace </span>KMail {
<a name="l00048"></a>00048 <span class="keyword">class </span>AttachmentStrategy;
<a name="l00049"></a>00049 }
<a name="l00050"></a>00050 <span class="keyword">using</span> KMail::AttachmentStrategy;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">class </span>KMSearch: <span class="keyword">public</span> QObject
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 Q_OBJECT
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00057"></a>00057 KMSearch(QObject * parent = 0, <span class="keyword">const</span> <span class="keywordtype">char</span> * name = 0);
<a name="l00058"></a>00058 ~KMSearch();
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> write(QString location) <span class="keyword">const</span>;
<a name="l00061"></a>00061 <span class="keywordtype">bool</span> read(QString location);
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> recursive()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRecursive; }
<a name="l00063"></a>00063 <span class="keywordtype">void</span> setRecursive(<span class="keywordtype">bool</span> recursive) { <span class="keywordflow">if</span> (running()) stop(); mRecursive = recursive; }
<a name="l00064"></a>00064 <a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a>* root()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRoot; }
<a name="l00065"></a>00065 <span class="keywordtype">void</span> setRoot(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder) { <span class="keywordflow">if</span> (running()) stop(); mRoot = folder; }
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> inScope(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a>* folder) <span class="keyword">const</span>;
<a name="l00067"></a>00067 <span class="comment">//Takes ownership of @searchPattern</span>
<a name="l00068"></a>00068 <span class="keywordtype">void</span> setSearchPattern(<a class="code" href="classKMSearchPattern.html" title="This class is an abstraction of a search over messages.">KMSearchPattern</a> *searchPattern);
<a name="l00069"></a>00069 <a class="code" href="classKMSearchPattern.html" title="This class is an abstraction of a search over messages.">KMSearchPattern</a>* searchPattern()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mSearchPattern; }
<a name="l00070"></a>00070 <span class="keywordtype">void</span> start();
<a name="l00071"></a>00071 <span class="keywordtype">bool</span> running()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRunning; }
<a name="l00072"></a>00072 <span class="keywordtype">void</span> stop();
<a name="l00073"></a>00073 <span class="keywordtype">int</span> foundCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFoundCount; }
<a name="l00074"></a>00074 <span class="keywordtype">int</span> searchCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mSearchCount; }
<a name="l00075"></a>00075 QString currentFolder()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLastFolder; }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keyword">public</span> slots:
<a name="l00078"></a>00078 <span class="keywordtype">void</span> indexFinished();
<a name="l00079"></a>00079
<a name="l00080"></a>00080 signals:
<a name="l00081"></a>00081 <span class="keywordtype">void</span> found(Q_UINT32 serNum);
<a name="l00082"></a>00082 <span class="keywordtype">void</span> finished(<span class="keywordtype">bool</span> success);
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">protected</span> slots:
<a name="l00085"></a>00085 <span class="keywordtype">void</span> slotProcessNextBatch();
<a name="l00086"></a>00086 <span class="keywordtype">void</span> slotSearchFolderResult( <a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a>*, QValueList<Q_UINT32>,
<a name="l00087"></a>00087 <span class="keyword">const</span> <a class="code" href="classKMSearchPattern.html" title="This class is an abstraction of a search over messages.">KMSearchPattern</a>*, <span class="keywordtype">bool</span> );
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">protected</span>:
<a name="l00090"></a>00090 <span class="keyword">friend</span> class ::KMIndexSearchTarget;
<a name="l00091"></a>00091 <span class="keywordtype">void</span> setRunning(<span class="keywordtype">bool</span> b) { mRunning = b; }
<a name="l00092"></a>00092 <span class="keywordtype">void</span> setFoundCount(<span class="keywordtype">int</span> f) { mFoundCount = f; }
<a name="l00093"></a>00093 <span class="keywordtype">void</span> setCurrentFolder(<span class="keyword">const</span> QString &f) { mLastFolder = f; }
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">private</span>:
<a name="l00096"></a>00096 <span class="keywordtype">int</span> mRemainingFolders;
<a name="l00097"></a>00097 <span class="keywordtype">bool</span> mRecursive, mRunning, mIdle, mRunByIndex;
<a name="l00098"></a>00098 QGuardedPtr<KMFolder> mRoot;
<a name="l00099"></a>00099 <a class="code" href="classKMSearchPattern.html" title="This class is an abstraction of a search over messages.">KMSearchPattern</a>* mSearchPattern;
<a name="l00100"></a>00100 QValueList<QGuardedPtr<KMFolder> > mFolders, mOpenedFolders;
<a name="l00101"></a>00101 QValueList<QGuardedPtr<KMFolderImap> > mIncompleteFolders;
<a name="l00102"></a>00102 SerNumList mSerNums;
<a name="l00103"></a>00103 QString mLastFolder;
<a name="l00104"></a>00104 <span class="keywordtype">int</span> mFoundCount;
<a name="l00105"></a>00105 <span class="keywordtype">int</span> mSearchCount;
<a name="l00106"></a>00106 QTimer *mProcessNextBatchTimer;
<a name="l00107"></a>00107 };
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">class </span>KMFolderSearch: <span class="keyword">public</span> <a class="code" href="classFolderStorage.html" title="The FolderStorage class is the bass class for the storage related aspects of a collection...">FolderStorage</a>
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 Q_OBJECT
<a name="l00112"></a>00112 <span class="keyword">friend</span> class ::KMFolderSearchJob;
<a name="l00113"></a>00113 <span class="keyword">public</span>:
<a name="l00114"></a>00114 KMFolderSearch(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a>* folder, <span class="keyword">const</span> <span class="keywordtype">char</span>* name=0);
<a name="l00115"></a>00115 <span class="keyword">virtual</span> ~KMFolderSearch();
<a name="l00116"></a>00116
<a name="l00118"></a>00118 <span class="keyword">virtual</span> KMFolderType <a class="code" href="classFolderStorage.html#41196efc6926d01bc45fc2d61e97b39a" title="Returns the type of this folder.">folderType</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> KMFolderTypeSearch; }
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">// Sets and runs the search used by the folder</span>
<a name="l00121"></a>00121 <span class="keywordtype">void</span> setSearch(KMSearch *search);
<a name="l00122"></a>00122 <span class="comment">// Returns the current search used by the folder</span>
<a name="l00123"></a>00123 <span class="keyword">const</span> KMSearch* <a class="code" href="classFolderStorage.html#aeec4055eb21e569953caa54afbab7aa" title="Search for messages The end is signaled with searchDone().">search</a>() <span class="keyword">const</span>;
<a name="l00124"></a>00124 <span class="comment">// Stops the current search</span>
<a name="l00125"></a>00125 <span class="keywordtype">void</span> stopSearch() { <span class="keywordflow">if</span> (mSearch) mSearch->stop(); }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">virtual</span> <a class="code" href="classKMMessage.html" title="This is a Mime Message.">KMMessage</a>* <a class="code" href="classFolderStorage.html#e536ec5f8862677863c3a9c81488cc10" title="Read message at given index.">getMsg</a>(<span class="keywordtype">int</span> idx);
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFolderStorage.html#0b7fbbe8d9b25c6de16ed55a35fed3f8" title="Removes and deletes all jobs associated with the particular message.">ignoreJobsForMessage</a>( <a class="code" href="classKMMessage.html" title="This is a Mime Message.">KMMessage</a>* );
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFolderStorage.html#9c6a349b6abed38aa28ee5fe8fd4941e" title="Try releasing folder if possible, something is attempting an exclusive access to...">tryReleasingFolder</a>(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a>* folder);
<a name="l00131"></a>00131
<a name="l00133"></a>00133 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFolderStorage.html#b0ae4b58ece469ebe50eb437308ea889" title="Returns true if this folder can be moved.">isMoveable</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">protected</span> slots:
<a name="l00136"></a>00136 <span class="comment">// Reads search definition for this folder and creates a KMSearch</span>
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> readSearch();
<a name="l00138"></a>00138 <span class="comment">// Runs the current search again</span>
<a name="l00139"></a>00139 <span class="keywordtype">void</span> executeSearch();
<a name="l00140"></a>00140 <span class="comment">// Called when the search is finished</span>
<a name="l00141"></a>00141 <span class="keywordtype">void</span> searchFinished(<span class="keywordtype">bool</span> success);
<a name="l00142"></a>00142 <span class="comment">// Look at a new message and if it matches search() add it to the cache</span>
<a name="l00143"></a>00143 <span class="keywordtype">void</span> examineAddedMessage(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder, Q_UINT32 serNum);
<a name="l00144"></a>00144 <span class="comment">// Look at a removed message and remove it from the cache</span>
<a name="l00145"></a>00145 <span class="keywordtype">void</span> examineRemovedMessage(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder, Q_UINT32 serNum);
<a name="l00146"></a>00146 <span class="comment">// Look at a message whose status has changed</span>
<a name="l00147"></a>00147 <span class="keywordtype">void</span> examineChangedMessage(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder, Q_UINT32 serNum, <span class="keywordtype">int</span> delta);
<a name="l00148"></a>00148 <span class="comment">// The serial numbers for a folder have been invalidated, deal with it</span>
<a name="l00149"></a>00149 <span class="keywordtype">void</span> examineInvalidatedFolder(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder);
<a name="l00150"></a>00150 <span class="comment">// A folder has been deleted, deal with it</span>
<a name="l00151"></a>00151 <span class="keywordtype">void</span> examineRemovedFolder(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder);
<a name="l00152"></a>00152 <span class="comment">// Propagate the msgHeaderChanged signal</span>
<a name="l00153"></a>00153 <span class="keywordtype">void</span> propagateHeaderChanged(<a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder, <span class="keywordtype">int</span> idx);
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keyword">public</span> slots:
<a name="l00156"></a>00156 <span class="comment">// Appends the serial number to the cached list of messages that match</span>
<a name="l00157"></a>00157 <span class="comment">// the search for this folder</span>
<a name="l00158"></a>00158 <span class="keywordtype">void</span> addSerNum(Q_UINT32 serNum);
<a name="l00159"></a>00159 <span class="comment">// Removes the serial number from the cached list of messages that match</span>
<a name="l00160"></a>00160 <span class="comment">// the search for this folder</span>
<a name="l00161"></a>00161 <span class="keywordtype">void</span> removeSerNum(Q_UINT32 serNum);
<a name="l00162"></a>00162
<a name="l00164"></a>00164 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#21d1b3f89a18e73c44197cab9ffd579e" title="Incrementally update the index if possible else call writeIndex.">updateIndex</a>();
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">// Examine the message</span>
<a name="l00167"></a>00167 <span class="keywordtype">void</span> slotSearchExamineMsgDone( <a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a>*, Q_UINT32 serNum,
<a name="l00168"></a>00168 <span class="keyword">const</span> <a class="code" href="classKMSearchPattern.html" title="This class is an abstraction of a search over messages.">KMSearchPattern</a>*, <span class="keywordtype">bool</span> );
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="keyword">public</span>:
<a name="l00171"></a>00171 <span class="comment">//See base class for documentation</span>
<a name="l00172"></a>00172 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#bd989edf4fcba5192514d28574159ae4" title="Add the given message to the folder.">addMsg</a>(<a class="code" href="classKMMessage.html" title="This is a Mime Message.">KMMessage</a>* msg, <span class="keywordtype">int</span>* index_return = 0);
<a name="l00173"></a>00173 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#0ee31167b98ddd956152071f2464a4ed" title="Open folder for access.">open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *owner);
<a name="l00174"></a>00174 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#c16e633bfddbe6c8e2fc7b6ab494e0ca" title="Check folder for permissions Returns zero if readable and writable.">canAccess</a>();
<a name="l00175"></a>00175 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFolderStorage.html#bcda5b486fb4478b8a28ad3811cff4dd" title="fsync buffers to disk">sync</a>();
<a name="l00176"></a>00176 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reallyDoClose(<span class="keyword">const</span> <span class="keywordtype">char</span>* owner);
<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#0a690c1940cca8a8363e218babeab7d5" title="Create a new folder with the name of this object and open it.">create</a>();
<a name="l00178"></a>00178 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#f892aa2583cc51902efa1d70e888a059" title="Remove deleted messages from the folder.">compact</a>( <span class="keywordtype">bool</span> );
<a name="l00179"></a>00179 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFolderStorage.html#e3e2711e2212cdabb0fc5bb4a72cdaaf" title="Is the folder read-only?">isReadOnly</a>() <span class="keyword">const</span>;
<a name="l00180"></a>00180 <span class="keyword">virtual</span> <span class="keyword">const</span> KMMsgBase* <a class="code" href="classFolderStorage.html#e7b655f821f53f2b431dd0ebaf44743b" title="Provides access to the basic message fields that are also stored in the index.">getMsgBase</a>(<span class="keywordtype">int</span> idx) <span class="keyword">const</span>;
<a name="l00181"></a>00181 <span class="keyword">virtual</span> KMMsgBase* <a class="code" href="classFolderStorage.html#e7b655f821f53f2b431dd0ebaf44743b" title="Provides access to the basic message fields that are also stored in the index.">getMsgBase</a>(<span class="keywordtype">int</span> idx);
<a name="l00182"></a>00182 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#30899418b9d0e8659311a6a5c2b40a60" title="Returns the index of the given message or -1 if not found.">find</a>(<span class="keyword">const</span> KMMsgBase* msg) <span class="keyword">const</span>;
<a name="l00183"></a>00183 <span class="keyword">virtual</span> QString <a class="code" href="classFolderStorage.html#dc9e9405b32874b623442068194a71ea" title="Returns full path to index file.">indexLocation</a>() <span class="keyword">const</span>;
<a name="l00184"></a>00184 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#eb0072e4951df8057f271416264b03cc" title="Write index to index-file.">writeIndex</a>( <span class="keywordtype">bool</span> createEmptyIndex = <span class="keyword">false</span> );
<a name="l00185"></a>00185 DwString <a class="code" href="classFolderStorage.html#0c690ce0d230c64ae0303c0f1e74f2c7" title="Read a message and returns a DwString.">getDwString</a>(<span class="keywordtype">int</span> idx);
<a name="l00186"></a>00186 Q_UINT32 serNum(<span class="keywordtype">int</span> idx) { <span class="keywordflow">return</span> mSerNums[idx]; }
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="keyword">protected</span>:
<a name="l00189"></a>00189 <span class="keyword">virtual</span> FolderJob* <a class="code" href="classFolderStorage.html#db5443a87c62001d89de5f8014e78219" title="These two methods actually create the jobs.">doCreateJob</a>(<a class="code" href="classKMMessage.html" title="This is a Mime Message.">KMMessage</a> *msg, FolderJob::JobType jt,
<a name="l00190"></a>00190 <a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder, QString partSpecifier,
<a name="l00191"></a>00191 <span class="keyword">const</span> AttachmentStrategy *as ) <span class="keyword">const</span>;
<a name="l00192"></a>00192 <span class="keyword">virtual</span> FolderJob* <a class="code" href="classFolderStorage.html#db5443a87c62001d89de5f8014e78219" title="These two methods actually create the jobs.">doCreateJob</a>(QPtrList<KMMessage>& msgList, <span class="keyword">const</span> QString& sets,
<a name="l00193"></a>00193 FolderJob::JobType jt, <a class="code" href="classKMFolder.html" title="Mail folder.">KMFolder</a> *folder) <span class="keyword">const</span>;
<a name="l00194"></a>00194 <span class="keyword">virtual</span> <a class="code" href="classKMMessage.html" title="This is a Mime Message.">KMMessage</a>* <a class="code" href="classFolderStorage.html#3b14f85d019e1e077750514de52139a9" title="Load message from file and store it at given index.">readMsg</a>(<span class="keywordtype">int</span> idx);
<a name="l00195"></a>00195 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFolderStorage.html#27b761aebe9b4819191546c63a14f0cb" title="Read index file and fill the message-info list mMsgList.">readIndex</a>();
<a name="l00196"></a>00196 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#b5203e11f28a8618965662ddc7331a2d" title="Called by KMFolder::remove() to delete the actual contents.">removeContents</a>();
<a name="l00197"></a>00197 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#893e7869966ea01a212f25739b333a04" title="Called by KMFolder::expunge() to delete the actual contents.">expungeContents</a>();
<a name="l00198"></a>00198 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classFolderStorage.html#69529ce2d21f9dcf28e06ef4fb7f2a6f" title="Number of messages in this folder.">count</a>(<span class="keywordtype">bool</span> cache = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00199"></a>00199 <span class="keyword">virtual</span> KMMsgBase* takeIndexEntry(<span class="keywordtype">int</span> idx);
<a name="l00200"></a>00200 <span class="keyword">virtual</span> KMMsgInfo* setIndexEntry(<span class="keywordtype">int</span> idx, <a class="code" href="classKMMessage.html" title="This is a Mime Message.">KMMessage</a> *msg);
<a name="l00201"></a>00201 <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearIndex(<span class="keywordtype">bool</span> autoDelete=<span class="keyword">true</span>, <span class="keywordtype">bool</span> syncDict = <span class="keyword">false</span>);
<a name="l00202"></a>00202 <span class="keyword">virtual</span> <span class="keywordtype">void</span> truncateIndex();
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="keyword">private</span>:
<a name="l00205"></a>00205 QValueVector<Q_UINT32> mSerNums;
<a name="l00206"></a>00206 QValueList<QGuardedPtr<KMFolder> > mFolders;
<a name="l00207"></a>00207 QValueStack<Q_UINT32> mUnexaminedMessages;
<a name="l00208"></a>00208 FILE *mIdsStream;
<a name="l00209"></a>00209 KMSearch *mSearch;
<a name="l00210"></a>00210 <span class="keywordtype">bool</span> mInvalid, mUnlinked;
<a name="l00211"></a>00211 <span class="keywordtype">bool</span> mTempOpened;
<a name="l00212"></a>00212 QTimer *mExecuteSearchTimer;
<a name="l00213"></a>00213 QMap<const KMFolder*, unsigned int>mFoldersCurrentlyBeingSearched;
<a name="l00214"></a>00214 };
<a name="l00215"></a>00215 <span class="preprocessor">#endif </span><span class="comment">/*kmfoldersearch_h*/</span>
<a name="l00216"></a>00216
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kmail</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="namespacemembers.html">Namespace Members</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="classAccountUpdater.html">accountupdater</option>, <option value="classAttachmentModifyCommand.html">attachmentmodifycommand</option>, <option value="classFolderStorage.html">folderstorage</option>, <option value="classKCursorSaver.html">kcursorsaver</option>, <option value="classKleo_1_1KeyResolver.html">kleo::keyresolver</option>, <option value="classKListViewIndexedSearchLine.html">klistviewindexedsearchline</option>, <option value="classKMAcctFolder.html">kmacctfolder</option>, <option value="classKMAcctSelDlg.html">kmacctseldlg</option>, <option value="classKMail_1_1AccountComboBox.html">kmail::accountcombobox</option>, <option value="classKMail_1_1AccountManager.html">kmail::accountmanager</option>, <option value="classKMail_1_1ACLEntryDialog.html">kmail::aclentrydialog</option>, <option value="classKMail_1_1ACLJobs_1_1DeleteACLJob.html">kmail::acljobs::deleteacljob</option>, <option value="classKMail_1_1ACLJobs_1_1GetACLJob.html">kmail::acljobs::getacljob</option>, <option value="classKMail_1_1ACLJobs_1_1GetUserRightsJob.html">kmail::acljobs::getuserrightsjob</option>, <option value="classKMail_1_1ACLJobs_1_1MultiSetACLJob.html">kmail::acljobs::multisetacljob</option>, <option value="classKMail_1_1AnnotationJobs_1_1GetAnnotationJob.html">kmail::annotationjobs::getannotationjob</option>, <option value="classKMail_1_1AnnotationJobs_1_1MultiGetAnnotationJob.html">kmail::annotationjobs::multigetannotationjob</option>, <option value="classKMail_1_1AnnotationJobs_1_1MultiSetAnnotationJob.html">kmail::annotationjobs::multisetannotationjob</option>, <option value="classKMail_1_1AnnotationJobs_1_1MultiUrlGetAnnotationJob.html">kmail::annotationjobs::multiurlgetannotationjob</option>, <option value="classKMail_1_1AntiSpamConfig.html">kmail::antispamconfig</option>, <option value="classKMail_1_1AntiSpamWizard.html">kmail::antispamwizard</option>, <option value="classKMail_1_1AntiSpamWizard_1_1ConfigReader.html">kmail::antispamwizard::configreader</option>, <option value="classKMail_1_1AntiSpamWizard_1_1SpamToolConfig.html">kmail::antispamwizard::spamtoolconfig</option>, <option value="classKMail_1_1Callback.html">kmail::callback</option>, <option value="classKMail_1_1CopyFolderJob.html">kmail::copyfolderjob</option>, <option value="classKMail_1_1DictionaryComboBox.html">kmail::dictionarycombobox</option>, <option value="classKMail_1_1EditorWatcher.html">kmail::editorwatcher</option>, <option value="classKMail_1_1FilterImporterExporter.html">kmail::filterimporterexporter</option>, <option value="classKMail_1_1FilterLog.html">kmail::filterlog</option>, <option value="classKMail_1_1FilterLogDialog.html">kmail::filterlogdialog</option>, <option value="classKMail_1_1FolderDiaACLTab.html">kmail::folderdiaacltab</option>, <option value="classKMail_1_1FolderDiaGeneralTab.html">kmail::folderdiageneraltab</option>, <option value="classKMail_1_1FolderDiaQuotaTab.html">kmail::folderdiaquotatab</option>, <option value="classKMail_1_1FolderDiaTab.html">kmail::folderdiatab</option>, <option value="classKMail_1_1FolderDiaTemplatesTab.html">kmail::folderdiatemplatestab</option>, <option value="classKMail_1_1FolderRequester.html">kmail::folderrequester</option>, <option value="classKMail_1_1HeaderItem.html">kmail::headeritem</option>, <option value="classKMail_1_1HeaderStyle.html">kmail::headerstyle</option>, <option value="classKMail_1_1HtmlStatusBar.html">kmail::htmlstatusbar</option>, <option value="classKMail_1_1HtmlWriter.html">kmail::htmlwriter</option>, <option value="classKMail_1_1IdentityDrag.html">kmail::identitydrag</option>, <option value="classKMail_1_1IdentityListView.html">kmail::identitylistview</option>, <option value="classKMail_1_1IdentityListViewItem.html">kmail::identitylistviewitem</option>, <option value="classKMail_1_1Interface_1_1BodyPart.html">kmail::interface::bodypart</option>, <option value="classKMail_1_1Interface_1_1BodyPartFormatterPlugin.html">kmail::interface::bodypartformatterplugin</option>, <option value="classKMail_1_1Interface_1_1BodyPartMemento.html">kmail::interface::bodypartmemento</option>, <option value="classKMail_1_1Interface_1_1BodyPartURLHandler.html">kmail::interface::bodyparturlhandler</option>, <option value="classKMail_1_1Interface_1_1Observable.html">kmail::interface::observable</option>, <option value="classKMail_1_1Interface_1_1Observer.html">kmail::interface::observer</option>, <option value="classKMail_1_1JobScheduler.html">kmail::jobscheduler</option>, <option value="classKMail_1_1ListJob.html">kmail::listjob</option>, <option value="classKMail_1_1MaildirCompactionJob.html">kmail::maildircompactionjob</option>, <option value="classKMail_1_1MailingList.html">kmail::mailinglist</option>, <option value="classKMail_1_1MboxCompactionJob.html">kmail::mboxcompactionjob</option>, <option value="classKMail_1_1MessageActions.html">kmail::messageactions</option>, <option value="classKMail_1_1MessageCopyHelper.html">kmail::messagecopyhelper</option>, <option value="classKMail_1_1PartNodeBodyPart.html">kmail::partnodebodypart</option>, <option value="classKMail_1_1PopAccount.html">kmail::popaccount</option>, <option value="classKMail_1_1QuotaJobs_1_1GetQuotarootJob.html">kmail::quotajobs::getquotarootjob</option>, <option value="classKMail_1_1QuotaJobs_1_1GetStorageQuotaJob.html">kmail::quotajobs::getstoragequotajob</option>, <option value="classKMail_1_1RedirectDialog.html">kmail::redirectdialog</option>, <option value="classKMail_1_1RenameJob.html">kmail::renamejob</option>, <option value="classKMail_1_1RuleWidgetHandler.html">kmail::rulewidgethandler</option>, <option value="classKMail_1_1RuleWidgetHandlerManager.html">kmail::rulewidgethandlermanager</option>, <option value="classKMail_1_1ScheduledCompactionTask.html">kmail::scheduledcompactiontask</option>, <option value="classKMail_1_1ScheduledExpireTask.html">kmail::scheduledexpiretask</option>, <option value="classKMail_1_1ScheduledJob.html">kmail::scheduledjob</option>, <option value="classKMail_1_1ScheduledTask.html">kmail::scheduledtask</option>, <option value="classKMail_1_1SearchJob.html">kmail::searchjob</option>, <option value="classKMail_1_1SearchWindow.html">kmail::searchwindow</option>, <option value="classKMail_1_1SecondaryWindow.html">kmail::secondarywindow</option>, <option value="classKMail_1_1SieveDebugDialog.html">kmail::sievedebugdialog</option>, <option value="classKMail_1_1SortCacheItem.html">kmail::sortcacheitem</option>, <option value="classKMail_1_1SpamHeaderAnalyzer.html">kmail::spamheaderanalyzer</option>, <option value="classKMail_1_1SpamScore.html">kmail::spamscore</option>, <option value="classKMail_1_1TeeHtmlWriter.html">kmail::teehtmlwriter</option>, <option value="classKMail_1_1TransportManager.html">kmail::transportmanager</option>, <option value="classKMail_1_1UndoInfo.html">kmail::undoinfo</option>, <option value="classKMail_1_1URLHandler.html">kmail::urlhandler</option>, <option value="classKMail_1_1URLHandlerManager.html">kmail::urlhandlermanager</option>, <option value="classKMail_1_1Util_1_1LaterDeleter.html">kmail::util::laterdeleter</option>, <option value="classKMailICalIfaceImpl.html">kmailicalifaceimpl</option>, <option value="classKMailIface.html">kmailiface</option>, <option value="classKMDict.html">kmdict</option>, <option value="classKMDictItem.html">kmdictitem</option>, <option value="classKMFilterAction.html">kmfilteraction</option>, <option value="classKMFilterActionDict.html">kmfilteractiondict</option>, <option value="classKMFilterActionWidget.html">kmfilteractionwidget</option>, <option value="classKMFilterActionWithAddress.html">kmfilteractionwithaddress</option>, <option value="classKMFilterActionWithFolder.html">kmfilteractionwithfolder</option>, <option value="classKMFilterActionWithNone.html">kmfilteractionwithnone</option>, <option value="classKMFilterActionWithString.html">kmfilteractionwithstring</option>, <option value="classKMFilterActionWithStringList.html">kmfilteractionwithstringlist</option>, <option value="classKMFilterActionWithUOID.html">kmfilteractionwithuoid</option>, <option value="classKMFilterActionWithUrl.html">kmfilteractionwithurl</option>, <option value="classKMFilterDlg.html">kmfilterdlg</option>, <option value="classKMFilterListBox.html">kmfilterlistbox</option>, <option value="classKMFolder.html">kmfolder</option>, <option value="classKMFolderDialog.html">kmfolderdialog</option>, <option value="classKMFolderDir.html">kmfolderdir</option>, <option value="classKMFolderIndex.html">kmfolderindex</option>, <option value="classKMFolderOpener.html">kmfolderopener</option>, <option value="classKMHeaders.html">kmheaders</option>, <option value="classKMKernel.html">kmkernel</option>, <option value="classKMMenuCommand.html">kmmenucommand</option>, <option value="classKMMessage.html">kmmessage</option>, <option value="classKMMsgDict.html">kmmsgdict</option>, <option value="classKMMsgList.html">kmmsglist</option>, <option value="classKMMsgPartDialog.html">kmmsgpartdialog</option>, <option value="classKMMsgPartDialogCompat.html">kmmsgpartdialogcompat</option>, <option value="classKMPopHeadersView.html">kmpopheadersview</option>, <option value="classKMReaderWin.html">kmreaderwin</option>, <option value="classKMSearchPattern.html">kmsearchpattern</option>, <option value="classKMSearchPatternEdit.html">kmsearchpatternedit</option>, <option value="classKMSearchRule.html">kmsearchrule</option>, <option value="classKMSearchRuleNumerical.html">kmsearchrulenumerical</option>, <option value="classKMSearchRuleStatus.html">kmsearchrulestatus</option>, <option value="classKMSearchRuleString.html">kmsearchrulestring</option>, <option value="classKMSearchRuleWidget.html">kmsearchrulewidget</option>, <option value="classKMSystemTray.html">kmsystemtray</option>, <option value="classMailComposerIface.html">mailcomposeriface</option>, <option value="classScalix_1_1FolderAttributeParser.html">scalix::folderattributeparser</option>, <option value="classSnippetConfig.html">snippetconfig</option>, <option value="classSnippetGroup.html">snippetgroup</option>, <option value="classSnippetItem.html">snippetitem</option>, <option value="classSnippetSettings.html">snippetsettings</option>, <option value="classSnippetWidget.html">snippetwidget</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</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>
