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

akonadi

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

#include <entityannotationsattribute.h>

Inheritance diagram for Akonadi::EntityAnnotationsAttribute:
Akonadi::Attribute

Public Member Functions

 EntityAnnotationsAttribute (const QMap< QByteArray, QByteArray > &annotations)
 
QMap< QByteArray, QByteArray > annotations () const
 
Attribute * clone () const
 
bool contains (const QByteArray &key) const
 
void deserialize (const QByteArray &data)
 
void insert (const QByteArray &key, const QString &value)
 
QByteArray serialized () const
 
void setAnnotations (const QMap< QByteArray, QByteArray > &annotations)
 
QByteArray type () const
 
QString value (const QByteArray &key)
 
- Public Member Functions inherited from Akonadi::Attribute
virtual ~Attribute ()
 
virtual Attribute * clone () const =0
 
virtual void deserialize (const QByteArray &data)=0
 
virtual QByteArray serialized () const =0
 
virtual QByteArray type () const =0
 

Additional Inherited Members

- Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * > List
 

Detailed Description

An attribute for annotations.

The attribute is inspired by RFC5257(IMAP ANNOTATION) and RFC5464(IMAP METADATA), but serves the purpose of RFC5257.

For a private note annotation the entry name is: /private/comment for a shared note: /shared/comment

Since
4.13

Definition at line 44 of file entityannotationsattribute.h.

Constructor & Destructor Documentation

◆ EntityAnnotationsAttribute() [1/2]

EntityAnnotationsAttribute::EntityAnnotationsAttribute ( )

Definition at line 28 of file entityannotationsattribute.cpp.

◆ EntityAnnotationsAttribute() [2/2]

EntityAnnotationsAttribute::EntityAnnotationsAttribute ( const QMap< QByteArray, QByteArray > &  annotations)

Definition at line 32 of file entityannotationsattribute.cpp.

Member Function Documentation

◆ annotations()

QMap< QByteArray, QByteArray > EntityAnnotationsAttribute::annotations ( ) const

Definition at line 42 of file entityannotationsattribute.cpp.

◆ clone()

Akonadi::Attribute * EntityAnnotationsAttribute::clone ( ) const
virtual

Creates a copy of this attribute.

Implements Akonadi::Attribute.

Definition at line 68 of file entityannotationsattribute.cpp.

◆ contains()

bool EntityAnnotationsAttribute::contains ( const QByteArray &  key) const

Definition at line 57 of file entityannotationsattribute.cpp.

◆ deserialize()

void EntityAnnotationsAttribute::deserialize ( const QByteArray &  data)
virtual

Sets the data of this attribute, using the same encoding as returned by toByteArray().

Parameters
dataThe encoded attribute data.

Implements Akonadi::Attribute.

Definition at line 88 of file entityannotationsattribute.cpp.

◆ insert()

void EntityAnnotationsAttribute::insert ( const QByteArray &  key,
const QString &  value 
)

Definition at line 47 of file entityannotationsattribute.cpp.

◆ serialized()

QByteArray EntityAnnotationsAttribute::serialized ( ) const
virtual

Returns a QByteArray representation of the attribute which will be storaged.

This can be raw binary data, no encoding needs to be applied.

Implements Akonadi::Attribute.

Definition at line 73 of file entityannotationsattribute.cpp.

◆ setAnnotations()

void EntityAnnotationsAttribute::setAnnotations ( const QMap< QByteArray, QByteArray > &  annotations)

Definition at line 37 of file entityannotationsattribute.cpp.

◆ type()

QByteArray EntityAnnotationsAttribute::type ( ) const
virtual

Returns the type of the attribute.

Implements Akonadi::Attribute.

Definition at line 62 of file entityannotationsattribute.cpp.

◆ value()

QString EntityAnnotationsAttribute::value ( const QByteArray &  key)

Definition at line 52 of file entityannotationsattribute.cpp.


The documentation for this class was generated from the following files:
  • entityannotationsattribute.h
  • entityannotationsattribute.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