Search for usage in LXR

Akonadi::TagFetchScope Class Reference

#include <tagfetchscope.h>

Public Member Functions

 TagFetchScope ()
 TagFetchScope (const TagFetchScope &other)
 ~TagFetchScope ()
QSet< QByteArrayattributes () const
bool fetchAllAttributes () const
template<typename T >
void fetchAttribute (bool fetch=true)
void fetchAttribute (const QByteArray &type, 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.


Definition at line 22 of file tagfetchscope.h.

Constructor & Destructor Documentation

◆ TagFetchScope() [1/2]

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 25 of file tagfetchscope.cpp.

◆ TagFetchScope() [2/2]

TagFetchScope::TagFetchScope ( const TagFetchScope & other)

Creates a new tag fetch scope from an other.

Definition at line 34 of file tagfetchscope.cpp.

◆ ~TagFetchScope()

TagFetchScope::~TagFetchScope ( )

Destroys the tag fetch scope.

Definition at line 30 of file tagfetchscope.cpp.

Member Function Documentation

◆ attributes()

QSet< QByteArray > TagFetchScope::attributes ( ) const

Returns all explicitly fetched attributes.

Undefined if fetchAllAttributes() returns true.

See also

Definition at line 49 of file tagfetchscope.cpp.

◆ fetchAllAttributes()

bool TagFetchScope::fetchAllAttributes ( ) const

Returns whether to fetch all attributes.

Definition at line 89 of file tagfetchscope.cpp.

◆ fetchAttribute() [1/2]

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

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

fetchtrue if the attribute should be fetched, false otherwise.

Definition at line 93 of file tagfetchscope.h.

◆ fetchAttribute() [2/2]

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

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

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

Definition at line 54 of file tagfetchscope.cpp.

◆ fetchIdOnly()

bool TagFetchScope::fetchIdOnly ( ) const

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

See also

Definition at line 69 of file tagfetchscope.cpp.

◆ fetchRemoteId()

bool TagFetchScope::fetchRemoteId ( ) const

Returns whether tag remote ID should be fetched.

Definition at line 79 of file tagfetchscope.cpp.

◆ operator=()

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

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

Definition at line 40 of file tagfetchscope.cpp.

◆ setFetchAllAttributes()

void TagFetchScope::setFetchAllAttributes ( bool fetchAllAttributes)

Sets whether to fetch all attributes.

Definition at line 84 of file tagfetchscope.cpp.

◆ setFetchIdOnly()

void TagFetchScope::setFetchIdOnly ( bool fetchIdOnly)

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

The default is false.


Definition at line 63 of file tagfetchscope.cpp.

◆ setFetchRemoteId()

void TagFetchScope::setFetchRemoteId ( bool fetchRemoteId)

Sets whether to fetch tag remote ID.

This option only has effect for Resources.

Definition at line 74 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-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:58:38 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.