xmldocument.h

/*
    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 <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