document.h

/*
 * This file is part of the syndication library
 *
 * Copyright (C) 2006 Frank Osterfeld <osterfeld@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 SYNDICATION_ATOM_DOCUMENT_H
#define SYNDICATION_ATOM_DOCUMENT_H

#include <syndication/specificdocument.h>
#include <syndication/elementwrapper.h>

#include <ctime>

template <class T> class QList;

namespace Syndication {

class DocumentVisitor;

namespace Atom {

class Category;
class Entry;
class EntryDocument;
class FeedDocument;
class Generator;
class Link;
class Person;
//@cond PRIVATE
typedef boost::shared_ptr<EntryDocument> EntryDocumentPtr;
typedef boost::shared_ptr<FeedDocument> FeedDocumentPtr;
//@endcond

class SYNDICATION_EXPORT FeedDocument : public Syndication::SpecificDocument, public ElementWrapper
{
    public:

        FeedDocument();

        explicit FeedDocument(const QDomElement& element);

        bool accept(DocumentVisitor* visitor);

        QList<Person> authors() const;

        QList<Person> contributors() const;

        QList<Category> categories() const;

        QString icon() const;

        QString logo() const;

        QString id() const;

        QString rights() const;

        QString title() const;

        QString subtitle() const;

        Generator generator() const;

        time_t updated() const;

        QList<Link> links() const;

        QList<Entry> entries() const;

        
        QList<QDomElement> unhandledElements() const;

        QString debugInfo() const;

        bool isValid() const;
};

class SYNDICATION_EXPORT EntryDocument : public Syndication::SpecificDocument, public Syndication::ElementWrapper
{
    public:

        EntryDocument();

        explicit EntryDocument(const QDomElement& element);

        bool accept(DocumentVisitor* visitor);

        Entry entry() const;

        QString debugInfo() const;

        bool isValid() const;
};

} // namespace Atom
} // namespace Syndication

#endif // SYNDICATION_ATOM_DOCUMENT_H