kmail
KMFolderSearch Class Reference
Inheritance diagram for KMFolderSearch:

Detailed Description
Definition at line 107 of file kmfoldersearch.h.
Public Slots | |
void | addSerNum (Q_UINT32 serNum) |
void | removeSerNum (Q_UINT32 serNum) |
virtual int | updateIndex () |
void | slotSearchExamineMsgDone (KMFolder *, Q_UINT32 serNum, const KMSearchPattern *, bool) |
Public Member Functions | |
KMFolderSearch (KMFolder *folder, const char *name=0) | |
virtual | ~KMFolderSearch () |
virtual KMFolderType | folderType () const |
void | setSearch (KMSearch *search) |
const KMSearch * | search () const |
void | stopSearch () |
virtual KMMessage * | getMsg (int idx) |
virtual void | ignoreJobsForMessage (KMMessage *) |
virtual void | tryReleasingFolder (KMFolder *folder) |
virtual bool | isMoveable () const |
virtual QCString & | getMsgString (int idx, QCString &mDest) |
virtual int | addMsg (KMMessage *msg, int *index_return=0) |
virtual int | open () |
virtual int | canAccess () |
virtual void | sync () |
virtual void | close (bool force=FALSE) |
virtual int | create () |
virtual int | compact (bool) |
virtual bool | isReadOnly () const |
virtual const KMMsgBase * | getMsgBase (int idx) const |
virtual KMMsgBase * | getMsgBase (int idx) |
virtual int | find (const KMMsgBase *msg) const |
virtual QString | indexLocation () const |
virtual int | writeIndex (bool createEmptyIndex=false) |
DwString | getDwString (int idx) |
Q_UINT32 | serNum (int idx) |
Protected Slots | |
bool | readSearch () |
void | executeSearch () |
void | searchFinished (bool success) |
void | examineAddedMessage (KMFolder *folder, Q_UINT32 serNum) |
void | examineRemovedMessage (KMFolder *folder, Q_UINT32 serNum) |
void | examineChangedMessage (KMFolder *folder, Q_UINT32 serNum, int delta) |
void | examineInvalidatedFolder (KMFolder *folder) |
void | examineRemovedFolder (KMFolder *folder) |
void | propagateHeaderChanged (KMFolder *folder, int idx) |
Protected Member Functions | |
virtual FolderJob * | doCreateJob (KMMessage *msg, FolderJob::JobType jt, KMFolder *folder, QString partSpecifier, const AttachmentStrategy *as) const |
virtual FolderJob * | doCreateJob (QPtrList< KMMessage > &msgList, const QString &sets, FolderJob::JobType jt, KMFolder *folder) const |
virtual KMMessage * | readMsg (int idx) |
virtual bool | readIndex () |
virtual int | removeContents () |
virtual int | expungeContents () |
virtual int | count (bool cache=false) const |
virtual KMMsgBase * | takeIndexEntry (int idx) |
virtual KMMsgInfo * | setIndexEntry (int idx, KMMessage *msg) |
virtual void | clearIndex (bool autoDelete=true, bool syncDict=false) |
virtual void | truncateIndex () |
Friends | |
class | ::KMFolderSearchJob |
Member Function Documentation
|
Add the given message to the folder. Usually the message is added at the end of the folder. Returns zero on success and an errno error code on failure. The index of the new message is stored in index_return if given. Please note that the message is added as is to the folder and the folder takes ownership of the message (deleting it in the destructor). Implements FolderStorage. Definition at line 483 of file kmfoldersearch.cpp. |
|
Check folder for permissions Returns zero if readable and writable.
Implements FolderStorage. Definition at line 518 of file kmfoldersearch.cpp. |
|
Close folder. If force is TRUE the files are closed even if others still use it (e.g. other mail reader windows). Implements FolderStorage. Definition at line 536 of file kmfoldersearch.cpp. |
|
Remove deleted messages from the folder.
Returns zero on success and an errno on failure. A statusbar message will inform the user that the compaction worked, unless Implements FolderStorage. Definition at line 608 of file kmfoldersearch.cpp. |
|
Number of messages in this folder.
Reimplemented from FolderStorage. Definition at line 885 of file kmfoldersearch.cpp. |
|
Create a new folder with the name of this object and open it. Returns zero on success and an error code equal to the c-library fopen call otherwise. Implements FolderStorage. Definition at line 570 of file kmfoldersearch.cpp. |
|
These two methods actually create the jobs. They have to be implemented in all folders.
Implements FolderStorage. |
|
Called by KMFolder::expunge() to delete the actual contents. At the time of the call the folder has already been closed, and the various index files deleted. Returns 0 on success. Implements FolderStorage. Definition at line 879 of file kmfoldersearch.cpp. |
|
Returns the index of the given message or -1 if not found.
Implements FolderStorage. Definition at line 692 of file kmfoldersearch.cpp. |
|
Returns the type of this folder.
Reimplemented from FolderStorage. Definition at line 116 of file kmfoldersearch.h. |
|
Read a message and returns a DwString.
Implements FolderStorage. Definition at line 779 of file kmfoldersearch.cpp. |
|
Read message at given index. Indexing starts at zero Reimplemented from FolderStorage. Definition at line 659 of file kmfoldersearch.cpp. |
|
Provides access to the basic message fields that are also stored in the index. Whenever you only need subject, from, date, status you should use this method instead of getMsg() because getMsg() will load the message if necessary and this method does not. Implements FolderStorage. Definition at line 635 of file kmfoldersearch.cpp. |
|
Read a message and return a referece to a string.
Implements FolderStorage. Definition at line 476 of file kmfoldersearch.cpp. |
|
Removes and deletes all jobs associated with the particular message.
Reimplemented from FolderStorage. Definition at line 673 of file kmfoldersearch.cpp. |
|
Returns full path to index file.
Implements FolderStorage. Definition at line 705 of file kmfoldersearch.cpp. |
|
Returns true if this folder can be moved.
Reimplemented from FolderStorage. Definition at line 131 of file kmfoldersearch.h. |
|
Is the folder read-only?
Implements FolderStorage. Definition at line 614 of file kmfoldersearch.cpp. |
|
Open folder for access. Does nothing if the folder is already opened. To reopen a folder call close() first. Returns zero on success and an error code equal to the c-library fopen call otherwise (errno). Implements FolderStorage. Definition at line 498 of file kmfoldersearch.cpp. |
|
Read index file and fill the message-info list mMsgList.
Implements FolderStorage. Definition at line 793 of file kmfoldersearch.cpp. |
|
Load message from file and store it at given index. Returns 0 on failure. Implements FolderStorage. Definition at line 784 of file kmfoldersearch.cpp. |
|
Called by KMFolder::remove() to delete the actual contents. At the time of the call the folder has already been closed, and the various index files deleted. Returns 0 on success. Implements FolderStorage. Definition at line 871 of file kmfoldersearch.cpp. |
|
fsync buffers to disk
Implements FolderStorage. Definition at line 527 of file kmfoldersearch.cpp. |
|
Try releasing Currently used for KMFolderSearch and the background tasks like expiry. Reimplemented from FolderStorage. Definition at line 1116 of file kmfoldersearch.cpp. |
|
Incrementally update the index if possible else call writeIndex.
Implements FolderStorage. Definition at line 718 of file kmfoldersearch.cpp. |
|
Write index to index-file. Returns 0 on success and errno error on failure. Implements FolderStorage. Definition at line 728 of file kmfoldersearch.cpp. |
The documentation for this class was generated from the following files: