Akonadi
collectionfetchscope.cpp
Specifies which parts of a collection should be fetched from the Akonadi storage.
Definition collectionfetchscope.h:56
bool isEmpty() const
Returns true if there is nothing to fetch.
Definition collectionfetchscope.cpp:78
@ Enabled
Only retrieve enabled collections, ignoring the local preference.
Definition collectionfetchscope.h:100
QSet< QByteArray > attributes() const
Returns all explicitly fetched attributes.
Definition collectionfetchscope.cpp:133
void setIncludeStatistics(bool include)
Sets whether collection statistics should be included in the retrieved results.
Definition collectionfetchscope.cpp:88
void setResource(const QString &resource)
Sets a resource filter, that is only collections owned by the specified resource are retrieved.
Definition collectionfetchscope.cpp:98
CollectionFetchScope & operator=(const CollectionFetchScope &other)
Assigns the other to this scope and returns a reference to this scope.
Definition collectionfetchscope.cpp:69
void setIgnoreRetrievalErrors(bool enabled)
Ignore retrieval errors while fetching collections, and always deliver what is available.
Definition collectionfetchscope.cpp:158
void fetchAttribute(const QByteArray &type, bool fetch=true)
Sets whether the attribute of the given type should be fetched.
Definition collectionfetchscope.cpp:138
void setFetchIdOnly(bool fetchIdOnly)
Sets whether only the id or the complete tag should be fetched.
Definition collectionfetchscope.cpp:148
void setContentMimeTypes(const QStringList &mimeTypes)
Sets a content mimetypes filter, that is only collections that contain at least one of the given mime...
Definition collectionfetchscope.cpp:108
void setAncestorFetchScope(const CollectionFetchScope &scope)
Sets the fetch scope for ancestor retrieval.
Definition collectionfetchscope.cpp:168
CollectionFetchScope ancestorFetchScope() const
Returns the fetch scope for ancestor retrieval.
Definition collectionfetchscope.cpp:173
QStringList contentMimeTypes() const
Returns the content mimetypes filter.
Definition collectionfetchscope.cpp:103
void setAncestorRetrieval(AncestorRetrieval ancestorDepth)
Sets how many levels of ancestor collections should be included in the retrieval.
Definition collectionfetchscope.cpp:118
bool includeStatistics() const
Returns whether collection statistics should be included in the retrieved results.
Definition collectionfetchscope.cpp:83
QString resource() const
Returns the resource identifier that is used as filter.
Definition collectionfetchscope.cpp:93
bool ignoreRetrievalErrors() const
Returns whether retrieval errors should be ignored.
Definition collectionfetchscope.cpp:163
void setListFilter(ListFilter)
Sets a filter for the collections to be listed.
Definition collectionfetchscope.cpp:128
AncestorRetrieval ancestorRetrieval() const
Returns the ancestor retrieval depth.
Definition collectionfetchscope.cpp:113
CollectionFetchScope()
Creates an empty collection fetch scope.
Definition collectionfetchscope.cpp:55
bool fetchIdOnly() const
Sets whether only the id of the tags should be retrieved or the complete tag.
Definition collectionfetchscope.cpp:153
Helper integration between Akonadi and Qt.
None
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:00:59 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:00:59 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.