Akonadi

xmlwriter.h
1 /*
2  Copyright (c) 2009 Volker Krause <[email protected]>
3  Copyright (c) 2009 Igor Trindade Oliveira <[email protected]>
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 #ifndef AKONADI_XMLWRITER_H
22 #define AKONADI_XMLWRITER_H
23 
24 #include "akonadi-xml_export.h"
25 
26 #include <QDomElement>
27 
28 namespace Akonadi
29 {
30 
31 class Attribute;
32 class Collection;
33 class Item;
34 
39 namespace XmlWriter
40 {
44 Q_REQUIRED_RESULT AKONADI_XML_EXPORT QDomElement attributeToElement(Attribute *attr, QDomDocument &document);
45 
49 AKONADI_XML_EXPORT void writeAttributes(const Item &entity, QDomElement &parentElem);
50 
54 AKONADI_XML_EXPORT void writeAttributes(const Collection &entity, QDomElement &parentElem);
55 
59 Q_REQUIRED_RESULT AKONADI_XML_EXPORT QDomElement collectionToElement(const Collection &collection, QDomDocument &document);
60 
64 AKONADI_XML_EXPORT QDomElement writeCollection(const Collection &collection, QDomElement &parentElem);
65 
69 Q_REQUIRED_RESULT AKONADI_XML_EXPORT QDomElement itemToElement(const Item &item, QDomDocument &document);
70 
74 AKONADI_XML_EXPORT QDomElement writeItem(const Item &item, QDomElement &parentElem);
75 }
76 
77 }
78 
79 #endif
AKONADI_XML_EXPORT void writeAttributes(const Item &entity, QDomElement &parentElem)
Serializes all attributes of the given Akonadi object into the given parent element.
Definition: xmlwriter.cpp:57
Represents a collection of PIM items.
Definition: collection.h:76
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:82
Provides interface for custom attributes for Entity.
Definition: attribute.h:139
AKONADI_XML_EXPORT QDomElement attributeToElement(Attribute *attr, QDomDocument &document)
Creates an attribute element for the given document.
Definition: xmlwriter.cpp:30
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_XML_EXPORT QDomElement writeItem(const Item &item, QDomElement &parentElem)
Serializes the given item into a DOM element and attaches it to the given item.
Definition: xmlwriter.cpp:123
Helper integration between Akonadi and Qt.
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:67
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon May 25 2020 22:46:12 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.