← Back to branch summary

~ubuntu-branches/ubuntu/trusty/kdepimlibs/trusty

« back to all changes in this revision

Viewing changes to akonadi/xml/xmlwriter.h

  • Committer: Package Import Robot
  • Author(s): Rohan Garg, Rohan Garg, Philip Muškovac
  • Date: 2013-11-23 17:36:44 UTC
  • mfrom: (1.1.102)
  • Revision ID: package-import@ubuntu.com-20131123173644-p5ow94192ezsny8g
Tags: 4:4.11.80-0ubuntu1
[ Rohan Garg ]
* New upstream beta release
  - Bump akonadi requirement to 1.10.45
  - Update install files
  - Update symbols

[ Philip Muškovac ]
* kdepimlibs-dev/-dbg breaks/replaces kdepim-runtime/-dbg (<< 4:4.11.80)

Show diffs side-by-side

added added

removed removed

Lines of Context:
akonadi/xml/xmlwriter.h
 
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
#ifndef AKONADI_XMLWRITER_H
 
22
#define AKONADI_XMLWRITER_H
 
23
 
 
24
#include "akonadi-xml_export.h"
 
25
 
 
26
#include <QtXml/QDomElement>
 
27
 
 
28
namespace Akonadi {
 
29
 
 
30
class Attribute;
 
31
class Collection;
 
32
class Entity;
 
33
class Item;
 
34
 
 
35
/**
 
36
  Low-level methods to serialize Akonadi objects into XML.
 
37
  @see Akonadi::XmlDocument
 
38
*/
 
39
namespace XmlWriter
 
40
{
 
41
  /**
 
42
    Creates an attribute element for the given document.
 
43
  */
 
44
  AKONADI_XML_EXPORT QDomElement attributeToElement( Attribute* attr, QDomDocument &document );
 
45
 
 
46
  /**
 
47
    Serializes all attributes of the given Akonadi object into the given parent element.
 
48
  */
 
49
  AKONADI_XML_EXPORT void writeAttributes( const Entity &entity, QDomElement &parentElem );
 
50
 
 
51
  /**
 
52
    Creates a collection element for the given document, not yet attached to the DOM tree.
 
53
  */
 
54
  AKONADI_XML_EXPORT QDomElement collectionToElement( const Collection &collection, QDomDocument &document );
 
55
 
 
56
  /**
 
57
    Serializes the given collection into a DOM element with the given parent.
 
58
  */
 
59
  AKONADI_XML_EXPORT QDomElement writeCollection( const Collection &collection, QDomElement &parentElem );
 
60
 
 
61
  /**
 
62
    Creates an item element for the given document, not yet attached to the DOM tree
 
63
  */
 
64
  AKONADI_XML_EXPORT QDomElement itemToElement( const Item &item, QDomDocument &document );
 
65
 
 
66
  /**
 
67
    Serializes the given item into a DOM element and attaches it to the given item.
 
68
  */
 
69
  AKONADI_XML_EXPORT QDomElement writeItem( const Akonadi::Item& item, QDomElement& parentElem );
 
70
}
 
71
 
 
72
}
 
73
 
 
74
#endif