akonadi
#include <indexpolicyattribute.h>

Public Member Functions | |
| IndexPolicyAttribute () | |
| ~IndexPolicyAttribute () | |
| bool | indexingEnabled () const |
| void | setIndexingEnabled (bool enable) |
Public Member Functions inherited from Akonadi::Attribute | |
| virtual | ~Attribute () |
| virtual Attribute * | clone () const =0 |
| virtual void | deserialize (const QByteArray &data)=0 |
| virtual QByteArray | serialized () const =0 |
| virtual QByteArray | type () const =0 |
Additional Inherited Members | |
Public Types inherited from Akonadi::Attribute | |
| typedef QList< Attribute * > | List |
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
| IndexPolicyAttribute::IndexPolicyAttribute | ( | ) |
Creates a new index policy attribute.
Definition at line 38 of file indexpolicyattribute.cpp.
| IndexPolicyAttribute::~IndexPolicyAttribute | ( | ) |
Destroys the index policy attribute.
Definition at line 43 of file indexpolicyattribute.cpp.
Member Function Documentation
| bool IndexPolicyAttribute::indexingEnabled | ( | ) | const |
Returns whether this collection is supposed to be indexed at all.
Definition at line 48 of file indexpolicyattribute.cpp.
| void IndexPolicyAttribute::setIndexingEnabled | ( | bool | enable | ) |
Sets whether this collection should be indexed at all.
- Parameters
-
enable trueto enable indexing,falseto exclude this collection from indexing
Definition at line 53 of file indexpolicyattribute.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:05 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
KDE API Reference
Public Member Functions inherited from