• Skip to content
  • Skip to link menu
KDE 4.5 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

  • Akonadi
  • Akonadi::PersistentSearchAttribute
Public Member Functions

Akonadi::PersistentSearchAttribute Class Reference

An attribute to store query properties of persistent search collections. More...

#include <persistentsearchattribute.h>

Inheritance diagram for Akonadi::PersistentSearchAttribute:
Inheritance graph
[legend]

List of all members.

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* ) ) );
   }
   ...
 }
Author:
Volker Krause <vkrause@kde.org>
Since:
4.5

Definition at line 71 of file persistentsearchattribute.h.


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:
  • persistentsearchattribute.h

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal