document.h

/*
 * This file is part of the syndication library
 *
 * Copyright (C) 2005 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_RSS2_DOCUMENT_H
#define SYNDICATION_RSS2_DOCUMENT_H

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

#include <ctime>

class QDomDocument;
class QDomElement;
class QString;

template <class T> class QList;
template <class T> class QSet;

namespace Syndication {
namespace RSS2 {

class Category;
class Cloud;
class Document;
class Image;
class Item;
class TextInput;
typedef boost::shared_ptr<Document> DocumentPtr;

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

        static Document fromXML(const QDomDocument& document);

        Document();

        Document(const Document& other);

        virtual ~Document();

        Document& operator=(const Document& other);

        virtual bool accept(DocumentVisitor* visitor);

        bool isValid() const;

        QString title() const;

        QString link() const;

        QString description() const;

        QList<Item> items() const;

        QString language() const;

        QString copyright() const;

        QString managingEditor() const;

        QString webMaster() const;

        time_t pubDate() const;

        time_t lastBuildDate() const;

        QList<Category> categories() const;

        QString generator() const;

        QString docs() const;

        Cloud cloud() const;

        int ttl() const;

        Image image() const;

        TextInput textInput() const;

        QSet<int> skipHours() const;

        enum DayOfWeek
        {

            Monday = 0, 
            Tuesday = 1, 
            Wednesday = 2, 
            Thursday = 3, 
            Friday = 4, 
            Saturday = 5, 
            Sunday = 6 
        };

        QSet<DayOfWeek> skipDays() const;

        QList<QDomElement> unhandledElements() const; 

        QString debugInfo() const;

        //@cond PRIVATE
        void getItemTitleFormatInfo(bool* isCDATA, bool* containsMarkup) const;

        void getItemDescriptionFormatInfo(bool* isCDATA, bool* containsMarkup) const;
        //@endcond
        
    private:
        explicit Document(const QDomElement& element);

        class DocumentPrivate;
        boost::shared_ptr<DocumentPrivate> d;

};

} // namespace RSS2
} // namespace Syndication

#endif // SYNDICATION_RSS2_DOCUMENT_H