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 <akonadi/collection.h>
#include <akonadi/item.h>

#include <QtXml/QDomDocument>

namespace Akonadi {

class XmlDocumentPrivate;

class AKONADI_XML_EXPORT XmlDocument
{
  public:
    XmlDocument();

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

    bool loadFile( const QString &fileName );

    bool writeToFile( const QString &fileName ) const;

    bool isValid() const;

    QString lastError() const;

    QDomDocument& document() const;

    KDE_DEPRECATED QDomElement collectionElementByRemoteId( const QString &rid ) const;

    QDomElement collectionElement( const Collection &collection ) const;

    QDomElement itemElementByRemoteId( const QString &rid ) const;

    Collection collectionByRemoteId( const QString &rid ) const;

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

    Collection::List collections() const;

    KDE_DEPRECATED Collection::List childCollections( const QString &parentCollectionRid ) const;

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

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

  private:
    XmlDocumentPrivate * const d;
};

}

#endif