Akonadi::TagFetchScope

Akonadi::TagFetchScope Class Reference

#include <tagfetchscope.h>

Public Member Functions

 TagFetchScope ()
 
 TagFetchScope (const TagFetchScope &other)
 
 ~TagFetchScope ()
 
QSet< QByteArrayattributes () const
 
bool fetchAllAttributes () const
 
void fetchAttribute (const QByteArray &type, bool fetch=true)
 
template<typename T >
void fetchAttribute (bool fetch=true)
 
bool fetchIdOnly () const
 
bool fetchRemoteId () const
 
TagFetchScopeoperator= (const TagFetchScope &other)
 
void setFetchAllAttributes (bool fetchAllAttributes)
 
void setFetchIdOnly (bool fetchIdOnly)
 
void setFetchRemoteId (bool fetchRemoteId)
 

Detailed Description

Specifies which parts of a tag should be fetched from the Akonadi storage.

Since
4.13

Definition at line 22 of file tagfetchscope.h.

Constructor & Destructor Documentation

TagFetchScope::TagFetchScope ( )

Creates an empty tag fetch scope.

Using an empty scope will only fetch the very basic meta data of tags, e.g. local id, remote id and mime type

Definition at line 23 of file tagfetchscope.cpp.

TagFetchScope::TagFetchScope ( const TagFetchScope other)

Creates a new tag fetch scope from an other.

Definition at line 33 of file tagfetchscope.cpp.

TagFetchScope::~TagFetchScope ( )

Destroys the tag fetch scope.

Definition at line 29 of file tagfetchscope.cpp.

Member Function Documentation

QSet< QByteArray > TagFetchScope::attributes ( ) const

Returns all explicitly fetched attributes.

Undefined if fetchAllAttributes() returns true.

See also
fetchAttribute()

Definition at line 48 of file tagfetchscope.cpp.

bool TagFetchScope::fetchAllAttributes ( ) const

Returns whether to fetch all attributes.

Definition at line 88 of file tagfetchscope.cpp.

void TagFetchScope::fetchAttribute ( const QByteArray type,
bool  fetch = true 
)

Sets whether the attribute of the given type should be fetched.

Parameters
typeThe attribute type to fetch.
fetchtrue if the attribute should be fetched, false otherwise.

Definition at line 53 of file tagfetchscope.cpp.

template<typename T >
void Akonadi::TagFetchScope::fetchAttribute ( bool  fetch = true)
inline

Sets whether the attribute of the requested type should be fetched.

Parameters
fetchtrue if the attribute should be fetched, false otherwise.

Definition at line 93 of file tagfetchscope.h.

bool TagFetchScope::fetchIdOnly ( ) const

Sets whether only the id of the tags should be retieved or the complete tag.

See also
tagFetchScope()
Since
4.15

Definition at line 68 of file tagfetchscope.cpp.

bool TagFetchScope::fetchRemoteId ( ) const

Returns whether tag remote ID should be fetched.

Definition at line 78 of file tagfetchscope.cpp.

TagFetchScope & TagFetchScope::operator= ( const TagFetchScope other)

Assigns the other to this scope and returns a reference to this scope.

Definition at line 39 of file tagfetchscope.cpp.

void TagFetchScope::setFetchAllAttributes ( bool  fetchAllAttributes)

Sets whether to fetch all attributes.

Definition at line 83 of file tagfetchscope.cpp.

void TagFetchScope::setFetchIdOnly ( bool  fetchIdOnly)

Sets whether only the id or the complete tag should be fetched.

The default is false.

Since
4.15

Definition at line 62 of file tagfetchscope.cpp.

void TagFetchScope::setFetchRemoteId ( bool  fetchRemoteId)

Sets whether to fetch tag remote ID.

This option only has effect for Resources.

Definition at line 73 of file tagfetchscope.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Sep 23 2020 23:17:34 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.