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

akonadi

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

#include <itemserializer_p.h>

Inheritance diagram for Akonadi::StdStringItemSerializerPlugin:
Inheritance graph
[legend]

Public Member Functions

bool deserialize (Item &, const QByteArray &, QIODevice &, int)
 
void serialize (const Item &, const QByteArray &, QIODevice &, int &)
 
- Public Member Functions inherited from Akonadi::ItemSerializerPlugin
virtual ~ItemSerializerPlugin ()
 
virtual QSet< QByteArray > parts (const Item &item) const
 

Additional Inherited Members

- Static Public Member Functions inherited from Akonadi::ItemSerializerPlugin
static void overridePluginLookup (QObject *plugin)
 

Detailed Description

Serializer plugin implementation for std::string

Definition at line 116 of file itemserializer_p.h.

Member Function Documentation

bool Akonadi::StdStringItemSerializerPlugin::deserialize ( Item &  item,
const QByteArray &  label,
QIODevice &  data,
int  version 
)
virtual

Converts serialized item data provided in data into payload for item.

Parameters
itemThe item to which the payload should be added. It is guaranteed to have a mime type matching one of the supported mime types of this plugin. However it might contain a unsuited payload added manually by the application developer. Verifying the payload type in case a payload is already available is recommended therefore.
labelThe part identifier of the part to deserialize. label might be an unsupported item part, return false if this is the case.
dataA QIODevice providing access to the serialized data. The QIODevice is opened in read-only mode and positioned at the beginning. The QIODevice is guaranteed to be valid.
versionThe version of the data format as set by the user in serialize() or 0 (default).
Returns
false if the specified part is not supported by this plugin, true if the part could be de-serialized successfully.

Implements Akonadi::ItemSerializerPlugin.

Definition at line 62 of file itemserializer.cpp.

void Akonadi::StdStringItemSerializerPlugin::serialize ( const Item &  item,
const QByteArray &  label,
QIODevice &  data,
int &  version 
)
virtual

Convert the payload object provided in item into its serialzed form into data.

Parameters
itemThe item which contains the payload. It is guaranteed to have a mimetype matching one of the supported mimetypes of this plugin as well as the existence of a payload object. However it might contain an unsupported payload added manually by the application developer. Verifying the payload type is recommended therefore.
labelThe part identifier of the part to serialize. label will be one of the item parts returned by parts().
dataThe QIODevice where the serialized data should be written to. The QIODevice is opened in write-only mode and positioned at the beginning. The QIODevice is guaranteed to be valid.
versionThe version of the data format. Can be set by the user to handle different versions.

Implements Akonadi::ItemSerializerPlugin.

Definition at line 75 of file itemserializer.cpp.


The documentation for this class was generated from the following files:
  • itemserializer_p.h
  • itemserializer.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:29 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



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