• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • TagFetchScope
Public Member Functions | List of all members
Akonadi::TagFetchScope Class Reference

#include <tagfetchscope.h>

Public Member Functions

 TagFetchScope ()
 
 TagFetchScope (const TagFetchScope &other)
 
 ~TagFetchScope ()
 
QSet< QByteArray > attributes () const
 
template<typename T >
void fetchAttribute (bool fetch=true)
 
void fetchAttribute (const QByteArray &type, 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() [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 36 of file tagfetchscope.cpp.

◆ TagFetchScope() [2/2]

TagFetchScope::TagFetchScope ( const TagFetchScope &  other)

Creates a new tag fetch scope from an other.

Definition at line 46 of file tagfetchscope.cpp.

◆ ~TagFetchScope()

TagFetchScope::~TagFetchScope ( )

Destroys the tag fetch scope.

Definition at line 42 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
fetchAttribute()

Definition at line 59 of file tagfetchscope.cpp.

◆ fetchAttribute() [1/2]

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 82 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.

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

Definition at line 64 of file tagfetchscope.cpp.

◆ fetchIdOnly()

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.

◆ operator=()

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.

◆ setFetchIdOnly()

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal