/usr/include/KF5/AkonadiXml/xmldocument.h is in libkf5akonadi-dev 4:16.04.3-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | /*
Copyright (c) 2009 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_XMLDOCUMENT_H
#define AKONADI_XMLDOCUMENT_H
#include "akonadi-xml_export.h"
#include "collection.h"
#include <item.h>
#include <QtXml/QDomDocument>
namespace Akonadi
{
class XmlDocumentPrivate;
/**
Represents a document of the KNUT XML serialization format for Akonadi objects.
*/
class AKONADI_XML_EXPORT XmlDocument
{
public:
/**
Creates an empty document.
*/
XmlDocument();
/**
Creates a new XmlDocument object and calls loadFile().
@see loadFile()
*/
XmlDocument(const QString &fileName);
~XmlDocument();
/**
Parses the given XML file and validates it.
In case of an error, isValid() will return @c false and
lastError() will return an error message.
@see isValid(), lastError()
*/
bool loadFile(const QString &fileName);
/**
Writes the current document into the given file.
*/
bool writeToFile(const QString &fileName) const;
/**
Returns true if the document could be parsed successfully.
@see lastError()
*/
bool isValid() const;
/**
Returns the last error occurred during file loading/parsing.
Empty if isValid() returns @c true.
@see isValid()
*/
QString lastError() const;
/**
Returns the DOM document for this XML document.
*/
QDomDocument &document() const;
/**
Returns the DOM element representing @p collection.
*/
QDomElement collectionElement(const Collection &collection) const;
/**
Returns the DOM element representing the item with the given remote id
*/
QDomElement itemElementByRemoteId(const QString &rid) const;
/**
Returns the collection with the given remote id.
*/
Collection collectionByRemoteId(const QString &rid) const;
/**
Returns the item with the given remote id.
*/
Item itemByRemoteId(const QString &rid, bool includePayload = true) const;
/**
Returns the collections defined in this document.
*/
Collection::List collections() const;
/**
Returns the tags defined in this document.
*/
Tag::List tags() const;
/**
Returns the immediate child collections of @p parentCollection.
*/
Collection::List childCollections(const Collection &parentCollection) const;
/**
Returns the items in the given collection.
*/
Item::List items(const Collection &collection, bool includePayload = true) const;
private:
Q_DISABLE_COPY(XmlDocument)
XmlDocumentPrivate *const d;
};
}
#endif
|