File indexing completed on 2025-01-05 04:47:12

 /*
     SPDX-FileCopyrightText: 2009 Volker Krause <vkrause@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "akonadi-xml_export.h"
 
 // AkonadiCore
 #include "akonadi/collection.h"
 #include "akonadi/item.h"
 
 #include <QDomDocument>
 
 #include <memory>
 
 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()
     */
     explicit XmlDocument(const QString &fileName, const QString &xsdFile = {});
     ~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, const QString &xsdFile = {});
 
     /**
       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()
     */
     [[nodiscard]] bool isValid() const;
 
     /**
       Returns the last error occurred during file loading/parsing.
       Empty if isValid() returns @c true.
       @see isValid()
     */
     [[nodiscard]] QString lastError() const;
 
     /**
       Returns the DOM document for this XML document.
     */
     QDomDocument &document() const;
 
     /**
       Returns the DOM element representing @p collection.
     */
     [[nodiscard]] QDomElement collectionElement(const Collection &collection) const;
 
     /**
       Returns the DOM element representing the item with the given remote id
     */
     [[nodiscard]] QDomElement itemElementByRemoteId(const QString &rid) const;
 
     /**
      * Returns the DOM element representing the collection with the given remote id
      */
     [[nodiscard]] QDomElement collectionElementByRemoteId(const QString &rid) const;
 
     /**
       Returns the collection with the given remote id.
     */
     [[nodiscard]] Collection collectionByRemoteId(const QString &rid) const;
 
     /**
       Returns the item with the given remote id.
     */
     [[nodiscard]] Item itemByRemoteId(const QString &rid, bool includePayload = true) const;
 
     /**
       Returns the collections defined in this document.
     */
     [[nodiscard]] Collection::List collections() const;
 
     /**
       Returns the tags defined in this document.
     */
     [[nodiscard]] Tag::List tags() const;
 
     /**
       Returns the immediate child collections of @p parentCollection.
     */
     [[nodiscard]] Collection::List childCollections(const Collection &parentCollection) const;
 
     /**
       Returns the items in the given collection.
     */
     [[nodiscard]] Item::List items(const Collection &collection, bool includePayload = true) const;
 
 private:
     Q_DISABLE_COPY(XmlDocument)
     std::unique_ptr<XmlDocumentPrivate> const d;
 };
 
 }