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

akonadi

  • akonadi
persistentsearchattribute.h
1/*
2 Copyright (c) 2010 Volker Krause <vkrause@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_PERSISTENTSEARCHATTRIBUTE_H
21#define AKONADI_PERSISTENTSEARCHATTRIBUTE_H
22
23#include <akonadi/attribute.h>
24
25namespace Akonadi {
26
27class Collection;
28
73class AKONADI_EXPORT PersistentSearchAttribute : public Akonadi::Attribute
74{
75public:
79 PersistentSearchAttribute();
80
84 ~PersistentSearchAttribute();
85
92 AKONADI_DEPRECATED QString queryLanguage() const;
93
100 AKONADI_DEPRECATED void setQueryLanguage(const QString &language);
101
105 QString queryString() const;
106
111 void setQueryString(const QString &query);
112
117 QList<qint64> queryCollections() const;
118
124 void setQueryCollections(const QList<Collection> &collections);
125
131 void setQueryCollections(const QList<qint64> &collectionsIds);
132
151 void setRemoteSearchEnabled(bool enabled);
152
158 bool isRemoteSearchEnabled() const;
159
169 void setRecursive(bool recursive);
170
176 bool isRecursive() const;
177
178 //@cond PRIVATE
179 virtual QByteArray type() const;
180 virtual Attribute *clone() const;
181 virtual QByteArray serialized() const;
182 virtual void deserialize(const QByteArray &data);
183 //@endcond
184
185private:
186 //@cond PRIVATE
187 class Private;
188 Private *const d;
189 //@endcond
190};
191
192}
193
194#endif
Akonadi::Attribute
Provides interface for custom attributes for Entity.
Definition attribute.h:139
Akonadi::Attribute::deserialize
virtual void deserialize(const QByteArray &data)=0
Sets the data of this attribute, using the same encoding as returned by toByteArray().
Akonadi::Attribute::serialized
virtual QByteArray serialized() const =0
Returns a QByteArray representation of the attribute which will be storaged.
Akonadi::Attribute::clone
virtual Attribute * clone() const =0
Creates a copy of this attribute.
Akonadi::Attribute::type
virtual QByteArray type() const =0
Returns the type of the attribute.
Akonadi::Collection
Represents a collection of PIM items.
Definition collection.h:76
Akonadi::PersistentSearchAttribute::isRecursive
bool isRecursive() const
Returns whether the search is recursive.
Definition persistentsearchattribute.cpp:93
Akonadi::PersistentSearchAttribute::PersistentSearchAttribute
PersistentSearchAttribute()
Creates a new persistent search attribute.
Definition persistentsearchattribute.cpp:45
Akonadi::PersistentSearchAttribute::setRecursive
void setRecursive(bool recursive)
Sets whether the search should recurse into collections.
Definition persistentsearchattribute.cpp:98
Akonadi::PersistentSearchAttribute::queryCollections
QList< qint64 > queryCollections() const
Returns IDs of collections that will be queried.
Definition persistentsearchattribute.cpp:75
Akonadi::PersistentSearchAttribute::setQueryCollections
void setQueryCollections(const QList< Collection > &collections)
Sets collections to be queried.
Definition persistentsearchattribute.cpp:80
Akonadi::PersistentSearchAttribute::isRemoteSearchEnabled
bool isRemoteSearchEnabled() const
Returns whether remote search is enabled.
Definition persistentsearchattribute.cpp:103
Akonadi::PersistentSearchAttribute::setQueryLanguage
AKONADI_DEPRECATED void setQueryLanguage(const QString &language)
Sets the query language used for this search.
Definition persistentsearchattribute.cpp:60
Akonadi::PersistentSearchAttribute::queryString
QString queryString() const
Returns the query string used for this search.
Definition persistentsearchattribute.cpp:65
Akonadi::PersistentSearchAttribute::setQueryString
void setQueryString(const QString &query)
Sets the query string to be used for this search.
Definition persistentsearchattribute.cpp:70
Akonadi::PersistentSearchAttribute::queryLanguage
AKONADI_DEPRECATED QString queryLanguage() const
Returns the query language used for this search.
Definition persistentsearchattribute.cpp:55
Akonadi::PersistentSearchAttribute::setRemoteSearchEnabled
void setRemoteSearchEnabled(bool enabled)
Sets whether resources should be queried too.
Definition persistentsearchattribute.cpp:108
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 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
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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