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

akonadi

  • akonadi
  • xml
xmldocument.h
1/*
2 Copyright (c) 2009 Volker Krause <vkrause@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef AKONADI_XMLDOCUMENT_H
21#define AKONADI_XMLDOCUMENT_H
22
23#include "akonadi-xml_export.h"
24
25#include <akonadi/collection.h>
26#include <akonadi/item.h>
27
28#include <QtXml/QDomDocument>
29
30namespace Akonadi {
31
32class XmlDocumentPrivate;
33
37class AKONADI_XML_EXPORT XmlDocument
38{
39 public:
43 XmlDocument();
44
50 XmlDocument( const QString &fileName );
51 ~XmlDocument();
52
60 bool loadFile( const QString &fileName );
61
65 bool writeToFile( const QString &fileName ) const;
66
71 bool isValid() const;
72
78 QString lastError() const;
79
83 QDomDocument& document() const;
84
89 KDE_DEPRECATED QDomElement collectionElementByRemoteId( const QString &rid ) const;
90
94 QDomElement collectionElement( const Collection &collection ) const;
95
99 QDomElement itemElementByRemoteId( const QString &rid ) const;
100
104 Collection collectionByRemoteId( const QString &rid ) const;
105
109 Item itemByRemoteId( const QString& rid, bool includePayload = true ) const;
110
114 Collection::List collections() const;
115
119 Tag::List tags() const;
120
125 KDE_DEPRECATED Collection::List childCollections( const QString &parentCollectionRid ) const;
126
130 Collection::List childCollections( const Collection &parentCollection ) const;
131
135 Item::List items( const Collection& collection, bool includePayload = true ) const;
136
137 private:
138 XmlDocumentPrivate * const d;
139};
140
141}
142
143#endif
Akonadi::Collection
Represents a collection of PIM items.
Definition collection.h:76
Akonadi::Collection::List
QList< Collection > List
Describes a list of collections.
Definition collection.h:81
Akonadi::XmlDocument::document
QDomDocument & document() const
Returns the DOM document for this XML document.
Definition xmldocument.cpp:221
Akonadi::XmlDocument::collectionByRemoteId
Collection collectionByRemoteId(const QString &rid) const
Returns the collection with the given remote id.
Definition xmldocument.cpp:258
Akonadi::XmlDocument::items
Item::List items(const Collection &collection, bool includePayload=true) const
Returns the items in the given collection.
Definition xmldocument.cpp:310
Akonadi::XmlDocument::tags
Tag::List tags() const
Returns the tags defined in this document.
Definition xmldocument.cpp:274
Akonadi::XmlDocument::isValid
bool isValid() const
Returns true if the document could be parsed successfully.
Definition xmldocument.cpp:211
Akonadi::XmlDocument::XmlDocument
XmlDocument()
Creates an empty document.
Definition xmldocument.cpp:108
Akonadi::XmlDocument::itemElementByRemoteId
QDomElement itemElementByRemoteId(const QString &rid) const
Returns the DOM element representing the item with the given remote id.
Definition xmldocument.cpp:253
Akonadi::XmlDocument::itemByRemoteId
Item itemByRemoteId(const QString &rid, bool includePayload=true) const
Returns the item with the given remote id.
Definition xmldocument.cpp:264
Akonadi::XmlDocument::collectionElementByRemoteId
QDomElement collectionElementByRemoteId(const QString &rid) const
Returns the DOM element representing the collection with the given remote id.
Definition xmldocument.cpp:226
Akonadi::XmlDocument::loadFile
bool loadFile(const QString &fileName)
Parses the given XML file and validates it.
Definition xmldocument.cpp:126
Akonadi::XmlDocument::collections
Collection::List collections() const
Returns the collections defined in this document.
Definition xmldocument.cpp:269
Akonadi::XmlDocument::writeToFile
bool writeToFile(const QString &fileName) const
Writes the current document into the given file.
Definition xmldocument.cpp:197
Akonadi::XmlDocument::collectionElement
QDomElement collectionElement(const Collection &collection) const
Returns the DOM element representing collection.
Definition xmldocument.cpp:231
Akonadi::XmlDocument::childCollections
Collection::List childCollections(const QString &parentCollectionRid) const
Returns immediate child collections of the specified parent collection.
Definition xmldocument.cpp:279
Akonadi::XmlDocument::lastError
QString lastError() const
Returns the last error occurred during file loading/parsing.
Definition xmldocument.cpp:216
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 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