akonadi
Akonadi::IndexPolicyAttribute Class Reference
An attribute to specify how a collection should be indexed for searching. More...
#include <indexpolicyattribute.h>
Inheritance diagram for Akonadi::IndexPolicyAttribute:

Public Member Functions | |
IndexPolicyAttribute () | |
~IndexPolicyAttribute () | |
bool | indexingEnabled () const |
void | setIndexingEnabled (bool enable) |
Detailed Description
An attribute to specify how a collection should be indexed for searching.
This attribute can be attached to any collection and should be honored by indexing agents.
- Since:
- 4.6
Definition at line 35 of file indexpolicyattribute.h.
Constructor & Destructor Documentation
Akonadi::IndexPolicyAttribute::IndexPolicyAttribute | ( | ) |
Creates a new index policy attribute.
Akonadi::IndexPolicyAttribute::~IndexPolicyAttribute | ( | ) |
Destroys the index policy attribute.
Member Function Documentation
bool Akonadi::IndexPolicyAttribute::indexingEnabled | ( | ) | const |
Returns whether this collection is supposed to be indexed at all.
void Akonadi::IndexPolicyAttribute::setIndexingEnabled | ( | bool | enable | ) |
Sets whether this collection should be indexed at all.
- Parameters:
-
enable true
to enable indexing,false
to exclude this collection from indexing
The documentation for this class was generated from the following file: