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

akonadi

  • akonadi
  • xml
xmlwriter.cpp
1/*
2 Copyright (c) 2009 Volker Krause <vkrause@kde.org>
3 Copyright (c) 2009 Igor Trindade Oliveira <igor_trindade@yahoo.com.br>
4
5 This library is free software; you can redistribute it and/or modify it
6 under the terms of the GNU Library General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or (at your
8 option) any later version.
9
10 This library is distributed in the hope that it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 License for more details.
14
15 You should have received a copy of the GNU Library General Public License
16 along with this library; see the file COPYING.LIB. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 02110-1301, USA.
19*/
20
21#include "xmlwriter.h"
22#include "format_p.h"
23
24#include <akonadi/attribute.h>
25#include <akonadi/collection.h>
26#include <akonadi/item.h>
27
28#include <QStringList>
29
30using namespace Akonadi;
31
32QDomElement XmlWriter::attributeToElement(Attribute* attr, QDomDocument& document)
33{
34 if ( document.isNull() )
35 return QDomElement();
36
37 QDomElement top = document.createElement( Format::Tag::attribute() );
38 top.setAttribute( Format::Attr::attributeType(), QString::fromUtf8( attr->type() ) );
39 QDomText attrText = document.createTextNode( QString::fromUtf8( attr->serialized() ) );
40 top.appendChild( attrText );
41
42 return top;
43}
44
45void XmlWriter::writeAttributes(const Entity& entity, QDomElement& parentElem)
46{
47 if ( parentElem.isNull() )
48 return;
49
50 QDomDocument doc = parentElem.ownerDocument();
51 foreach ( Attribute *attr, entity.attributes() )
52 parentElem.appendChild( attributeToElement( attr, doc ) );
53}
54
55QDomElement XmlWriter::collectionToElement(const Akonadi::Collection& collection, QDomDocument& document)
56{
57 if ( document.isNull() )
58 return QDomElement();
59
60 QDomElement top = document.createElement( Format::Tag::collection() );
61 top.setAttribute( Format::Attr::remoteId(), collection.remoteId() );
62 top.setAttribute( Format::Attr::collectionName(), collection.name() );
63 top.setAttribute( Format::Attr::collectionContentTypes(), collection.contentMimeTypes().join( QLatin1String(",") ) );
64 writeAttributes( collection, top );
65
66 return top;
67}
68
69QDomElement XmlWriter::writeCollection(const Akonadi::Collection& collection, QDomElement& parentElem)
70{
71 if ( parentElem.isNull() )
72 return QDomElement();
73
74 QDomDocument doc = parentElem.ownerDocument();
75 const QDomElement elem = collectionToElement( collection, doc );
76 parentElem.insertBefore( elem, QDomNode() ); // collection need to be before items to pass schema validation
77 return elem;
78}
79
80QDomElement XmlWriter::itemToElement(const Akonadi::Item& item, QDomDocument& document)
81{
82 if ( document.isNull() )
83 return QDomElement();
84
85 QDomElement top = document.createElement( Format::Tag::item() );
86 top.setAttribute( Format::Attr::remoteId(), item.remoteId() );
87 top.setAttribute( Format::Attr::itemMimeType(), item.mimeType() );
88
89 if ( item.hasPayload() ) {
90 QDomElement payloadElem = document.createElement( Format::Tag::payload() );
91 QDomText payloadText = document.createTextNode( QString::fromUtf8( item.payloadData() ) );
92 payloadElem.appendChild( payloadText );
93 top.appendChild( payloadElem );
94 }
95
96 writeAttributes( item, top );
97
98 foreach ( const Item::Flag &flag, item.flags() ) {
99 QDomElement flagElem = document.createElement( Format::Tag::flag() );
100 QDomText flagText = document.createTextNode( QString::fromUtf8( flag ) );
101 flagElem.appendChild( flagText );
102 top.appendChild( flagElem );
103 }
104
105 return top;
106}
107
108QDomElement XmlWriter::writeItem(const Item& item, QDomElement& parentElem)
109{
110 if ( parentElem.isNull() )
111 return QDomElement();
112
113 QDomDocument doc = parentElem.ownerDocument();
114 const QDomElement elem = itemToElement( item, doc );
115 parentElem.appendChild( elem );
116 return elem;
117}
118
Akonadi::Attribute
Provides interface for custom attributes for Entity.
Definition attribute.h:139
Akonadi::Attribute::serialized
virtual QByteArray serialized() const =0
Returns a QByteArray representation of the attribute which will be storaged.
Akonadi::Attribute::type
virtual QByteArray type() const =0
Returns the type of the attribute.
Akonadi::Collection
Represents a collection of PIM items.
Definition collection.h:76
Akonadi::Entity
The base class for Item and Collection.
Definition entity.h:60
Akonadi::Entity::attributes
Attribute::List attributes() const
Returns a list of all attributes of the entity.
Definition entity.cpp:153
Akonadi::XmlWriter::writeItem
AKONADI_XML_EXPORT QDomElement writeItem(const Akonadi::Item &item, QDomElement &parentElem)
Serializes the given item into a DOM element and attaches it to the given item.
Akonadi::XmlWriter::writeAttributes
AKONADI_XML_EXPORT void writeAttributes(const Entity &entity, QDomElement &parentElem)
Serializes all attributes of the given Akonadi object into the given parent element.
Definition xmlwriter.cpp:45
Akonadi::XmlWriter::writeCollection
AKONADI_XML_EXPORT QDomElement writeCollection(const Collection &collection, QDomElement &parentElem)
Serializes the given collection into a DOM element with the given parent.
Definition xmlwriter.cpp:69
Akonadi::XmlWriter::collectionToElement
AKONADI_XML_EXPORT QDomElement collectionToElement(const Collection &collection, QDomDocument &document)
Creates a collection element for the given document, not yet attached to the DOM tree.
Definition xmlwriter.cpp:55
Akonadi::XmlWriter::attributeToElement
AKONADI_XML_EXPORT QDomElement attributeToElement(Attribute *attr, QDomDocument &document)
Creates an attribute element for the given document.
Definition xmlwriter.cpp:32
Akonadi::XmlWriter::itemToElement
AKONADI_XML_EXPORT QDomElement itemToElement(const Item &item, QDomDocument &document)
Creates an item element for the given document, not yet attached to the DOM tree.
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 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
  • 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