• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • PersistentSearchAttribute
Public Member Functions
Akonadi::PersistentSearchAttribute Class Reference

#include <persistentsearchattribute.h>

Inheritance diagram for Akonadi::PersistentSearchAttribute:
Akonadi::Attribute

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)
- 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 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 vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g
Since:
4.5

Definition at line 71 of file persistentsearchattribute.h.


Constructor & Destructor Documentation

PersistentSearchAttribute::PersistentSearchAttribute ( )

Creates a new persistent search attribute.

Definition at line 35 of file persistentsearchattribute.cpp.

PersistentSearchAttribute::~PersistentSearchAttribute ( )

Destroys the persistent search attribute.

Definition at line 40 of file persistentsearchattribute.cpp.


Member Function Documentation

QString PersistentSearchAttribute::queryLanguage ( ) const

Returns the query language used for this search.

Definition at line 45 of file persistentsearchattribute.cpp.

QString PersistentSearchAttribute::queryString ( ) const

Returns the query string used for this search.

Definition at line 55 of file persistentsearchattribute.cpp.

void PersistentSearchAttribute::setQueryLanguage ( const QString &  language)

Sets the query language used for this search.

Parameters:
languagethe query language

Definition at line 50 of file persistentsearchattribute.cpp.

void PersistentSearchAttribute::setQueryString ( const QString &  query)

Sets the query string to be used for this search.

Parameters:
queryThe query string.

Definition at line 60 of file persistentsearchattribute.cpp.


The documentation for this class was generated from the following files:
  • persistentsearchattribute.h
  • persistentsearchattribute.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 16 2013 15:06:18 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

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

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal