Akonadi

persistentsearchattribute.h
1 /*
2  Copyright (c) 2010 Volker Krause <[email protected]>
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 "akonadicore_export.h"
24 #include "attribute.h"
25 
26 namespace Akonadi
27 {
28 
29 class Collection;
30 
75 class AKONADICORE_EXPORT PersistentSearchAttribute : public Akonadi::Attribute
76 {
77 public:
82 
86  ~PersistentSearchAttribute() override;
87 
91  QString queryString() const;
92 
97  void setQueryString(const QString &query);
98 
103  QVector<qint64> queryCollections() const;
104 
110  void setQueryCollections(const QVector<Collection> &collections);
111 
117  void setQueryCollections(const QVector<qint64> &collectionsIds);
118 
137  void setRemoteSearchEnabled(bool enabled);
138 
144  bool isRemoteSearchEnabled() const;
145 
155  void setRecursive(bool recursive);
156 
162  bool isRecursive() const;
163 
164  //@cond PRIVATE
165  QByteArray type() const override;
166  Attribute *clone() const override;
167  QByteArray serialized() const override;
168  void deserialize(const QByteArray &data) override;
169  //@endcond
170 
171 private:
172  //@cond PRIVATE
173  class Private;
174  Private *const d;
175  //@endcond
176 };
177 
178 }
179 
180 #endif
Provides interface for custom attributes for Entity.
Definition: attribute.h:139
An attribute to store query properties of persistent search collections.
Helper integration between Akonadi and Qt.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue May 26 2020 22:46:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.