Akonadi::TagFetchScope Class Reference

#include <tagfetchscope.h>

Public Member Functions
	TagFetchScope ()
	TagFetchScope (const TagFetchScope &other)
	~TagFetchScope ()
QSet< QByteArray >	attributes () const
void	fetchAttribute (const QByteArray &type, bool fetch=true)
template<typename T >
void	fetchAttribute (bool fetch=true)
bool	fetchIdOnly () const
TagFetchScope &	operator= (const TagFetchScope &other)
void	setFetchIdOnly (bool fetchIdOnly)

Detailed Description

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

Since

4.13

Definition at line 33 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 36 of file tagfetchscope.cpp.

TagFetchScope::TagFetchScope

(

const TagFetchScope &

other

)

Creates a new tag fetch scope from an other.

Definition at line 46 of file tagfetchscope.cpp.

TagFetchScope::~TagFetchScope

(

)

Destroys the tag fetch scope.

Definition at line 42 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 59 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

type	The attribute type to fetch.
fetch	true if the attribute should be fetched, false otherwise.

Definition at line 64 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

fetch

true if the attribute should be fetched, false otherwise.

Definition at line 82 of file tagfetchscope.h.

bool TagFetchScope::fetchIdOnly

(

)

const

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

See also

tagFetchScope()

Since

4.15

Definition at line 79 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 52 of file tagfetchscope.cpp.

void TagFetchScope::setFetchIdOnly

(

bool

fetchIdOnly

)

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

The default is false.

Since

4.15

Definition at line 73 of file tagfetchscope.cpp.

---

The documentation for this class was generated from the following files:

• tagfetchscope.h
• tagfetchscope.cpp