Akonadi::IndexPolicyAttribute Class
class Akonadi::IndexPolicyAttributeAn attribute to specify how a collection should be indexed for searching. More...
| Header: | #include <Akonadi/IndexPolicyAttribute> |
| CMake: | find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore) |
| Inherits: | Akonadi::Attribute |
Public Functions
| IndexPolicyAttribute() | |
| virtual | ~IndexPolicyAttribute() override |
| bool | indexingEnabled() const |
| void | setIndexingEnabled(bool enable) |
Detailed Description
This attribute can be attached to any collection and should be honored by indexing agents.
Member Function Documentation
IndexPolicyAttribute::IndexPolicyAttribute()
Creates a new index policy attribute.
[override virtual noexcept] IndexPolicyAttribute::~IndexPolicyAttribute()
Destroys the index policy attribute.
bool IndexPolicyAttribute::indexingEnabled() const
Returns whether this collection is supposed to be indexed at all.
See also setIndexingEnabled().
void IndexPolicyAttribute::setIndexingEnabled(bool enable)
Sets whether this collection should be indexed at all. enable \ true to enable indexing, \ false to exclude this collection from indexing
See also indexingEnabled().