Akonadi::PersistentSearchAttribute Class Reference
#include <persistentsearchattribute.h>
Inheritance diagram for Akonadi::PersistentSearchAttribute:

Public Member Functions | |
PersistentSearchAttribute () | |
~PersistentSearchAttribute () | |
QString | queryLanguage () const |
QString | queryString () const |
void | setQueryLanguage (const QString &language) |
void | setQueryString (const QString &query) |
Detailed Description
An attribute to store query properties of persistent search collections.
This attribute is attached to persistent search collections automatically when creating a new persistent search with SearchCreateJob. Later on the search query can be changed by modifying this attribute of the persistent search collection with an CollectionModifyJob.
Example:
const QString name = "My search folder"; const QString query = "..."; Akonadi::SearchCreateJob *job = new Akonadi::SearchCreateJob( name, query ); connect( job, SIGNAL( result( KJob* ) ), SLOT( jobFinished( KJob* ) ) ); MyClass::jobFinished( KJob *job ) { if ( job->error() ) { qDebug() << "Error occurred"; return; } const Collection searchCollection = job->createdCollection(); ... // now let's change the query if ( searchCollection.hasAttribute<Akonadi::PersistentSearchAttribute>() ) { Akonadi::PersistentSearchAttribute *attribute = searchCollection.attribute<Akonadi::PersistentSearchAttribute>(); attribute->setQueryString( "... another query string ..." ); Akonadi::CollectionModifyJob *modifyJob = new Akonadi::CollectionModifyJob( searchCollection ); connect( modifyJob, SIGNAL( result( KJob* ) ), SLOT( modifyFinished( KJob* ) ) ); } ... }
- Since:
- 4.5
Constructor & Destructor Documentation
Akonadi::PersistentSearchAttribute::PersistentSearchAttribute | ( | ) |
Creates a new persistent search attribute.
Akonadi::PersistentSearchAttribute::~PersistentSearchAttribute | ( | ) |
Destroys the persistent search attribute.
Member Function Documentation
QString Akonadi::PersistentSearchAttribute::queryLanguage | ( | ) | const |
Returns the query language used for this search.
QString Akonadi::PersistentSearchAttribute::queryString | ( | ) | const |
Returns the query string used for this search.
void Akonadi::PersistentSearchAttribute::setQueryLanguage | ( | const QString & | language | ) |
Sets the query language used for this search.
- Parameters:
-
language the query language
void Akonadi::PersistentSearchAttribute::setQueryString | ( | const QString & | query | ) |
Sets the query string to be used for this search.
- Parameters:
-
query The query string.
The documentation for this class was generated from the following file: