KMMsgIndex Class Reference
#include <index.h>
List of all members.
Detailed Description
Definition at line 52 of file index.h.
Constructor & Destructor Documentation
| KMMsgIndex::KMMsgIndex |
( |
QObject * |
parent |
) |
[explicit] |
| KMMsgIndex::~KMMsgIndex |
( |
|
) |
|
Member Function Documentation
| bool KMMsgIndex::isEnabled |
( |
|
) |
const [inline] |
Returns whether the index is enabled.
Definition at line 99 of file index.h.
| bool KMMsgIndex::isIndexable |
( |
KMFolder * |
folder |
) |
const |
Returns whether the folder is indexable.
Only local and dimap folders are currently indexable.
Note that a folder might be indexable and not indexed if the user has disabled it.
- See also:
- isIndexed
Definition at line 154 of file index.cpp.
| bool KMMsgIndex::isIndexed |
( |
KMFolder * |
folder |
) |
const |
Returns whether the folder has indexing enabled.
This returns true immediatelly after indexing has been enabled even though the folder is probably still being indexed in the background.
Definition at line 160 of file index.cpp.
| void KMMsgIndex::setEnabled |
( |
bool |
e |
) |
[slot] |
Either enable or disable indexing.
Calling setEnabled( true ) will start building the whole index, which is an expensive operation (time and disk-space).
Calling setEnabled( false ) will remove the index immediatelly, freeing up disk-space.
Definition at line 167 of file index.cpp.
| void KMMsgIndex::setIndexingEnabled |
( |
KMFolder * |
folder, |
|
|
bool |
e | |
|
) |
| | [slot] |
Change the indexing override for a given folder.
If called with true, will start indexing all the messages in the folder If called with false will remove all the messages in the folder
Definition at line 193 of file index.cpp.
| std::vector< Q_UINT32 > KMMsgIndex::simpleSearch |
( |
QString |
s, |
|
|
bool * |
ok | |
|
) |
| | const |
Just return all the uids where the pattern exists.
Definition at line 452 of file index.cpp.
| bool KMMsgIndex::startQuery |
( |
KMSearch * |
s |
) |
|
Starts a query.
Results will be returned assyncronously by signals.
- Returns:
- false if the query cannot be handled
Definition at line 400 of file index.cpp.
| bool KMMsgIndex::stopQuery |
( |
KMSearch * |
s |
) |
|
Stops a query.
nop if the query isn't running anymore.
- Returns:
- true if the query was found
Definition at line 440 of file index.cpp.
The documentation for this class was generated from the following files:
