Akonadi::IndexPolicyAttribute Class Reference

#include <indexpolicyattribute.h>

Inheritance diagram for Akonadi::IndexPolicyAttribute:

Public Member Functions
	IndexPolicyAttribute ()
	~IndexPolicyAttribute () override
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
using	List = QList<Attribute *>
Protected Member Functions inherited from Akonadi::Attribute
	Attribute (const Attribute &)=default

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 26 of file indexpolicyattribute.h.

Constructor & Destructor Documentation

IndexPolicyAttribute()

IndexPolicyAttribute::IndexPolicyAttribute

(

)

Creates a new index policy attribute.

Definition at line 19 of file indexpolicyattribute.cpp.

~IndexPolicyAttribute()

IndexPolicyAttribute::~IndexPolicyAttribute ( )

overridedefault

Destroys the index policy attribute.

Member Function Documentation

indexingEnabled()

bool IndexPolicyAttribute::indexingEnabled ( ) const

nodiscard

Returns whether this collection is supposed to be indexed at all.

Definition at line 26 of file indexpolicyattribute.cpp.

setIndexingEnabled()

void 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

Definition at line 31 of file indexpolicyattribute.cpp.

---

The documentation for this class was generated from the following files:

• indexpolicyattribute.h
• indexpolicyattribute.cpp