Akonadi::IndexPolicyAttribute

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 Attributeclone () 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
 
- 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 24 of file indexpolicyattribute.h.

Constructor & Destructor Documentation

IndexPolicyAttribute::IndexPolicyAttribute ( )

Creates a new index policy attribute.

Definition at line 23 of file indexpolicyattribute.cpp.

IndexPolicyAttribute::~IndexPolicyAttribute ( )
override

Destroys the index policy attribute.

Definition at line 28 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 33 of file indexpolicyattribute.cpp.

void IndexPolicyAttribute::setIndexingEnabled ( bool  enable)

Sets whether this collection should be indexed at all.

Parameters
enabletrue to enable indexing, false to exclude this collection from indexing

Definition at line 38 of file indexpolicyattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jul 9 2020 23:15:25 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.