xmldocument.h

/*
    SPDX-FileCopyrightText: 2009 Volker Krause <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef AKONADI_XMLDOCUMENT_H
#define AKONADI_XMLDOCUMENT_H

#include "akonadi-xml_export.h"

#include "collection.h"
#include <item.h>

#include <QDomDocument>

namespace Akonadi
{

class XmlDocumentPrivate;

class AKONADI_XML_EXPORT XmlDocument
{
public:
    XmlDocument();

    explicit XmlDocument(const QString &fileName);
    ~XmlDocument();

    bool loadFile(const QString &fileName);

    bool writeToFile(const QString &fileName) const;

    Q_REQUIRED_RESULT bool isValid() const;

    Q_REQUIRED_RESULT QString lastError() const;

    QDomDocument &document() const;

    Q_REQUIRED_RESULT QDomElement collectionElement(const Collection &collection) const;

    Q_REQUIRED_RESULT QDomElement itemElementByRemoteId(const QString &rid) const;

    Q_REQUIRED_RESULT QDomElement collectionElementByRemoteId(const QString &rid) const;

    Q_REQUIRED_RESULT Collection collectionByRemoteId(const QString &rid) const;

    Q_REQUIRED_RESULT Item itemByRemoteId(const QString &rid, bool includePayload = true) const;

    Q_REQUIRED_RESULT Collection::List collections() const;

    Q_REQUIRED_RESULT Tag::List tags() const;

    Q_REQUIRED_RESULT Collection::List childCollections(const Collection &parentCollection) const;

    Q_REQUIRED_RESULT Item::List items(const Collection &collection, bool includePayload = true) const;

private:
    Q_DISABLE_COPY(XmlDocument)
    XmlDocumentPrivate *const d;
};

}

#endif