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_RDF_DOCUMENT_H
#define SYNDICATION_RDF_DOCUMENT_H

#include <syndication/rdf/resourcewrapper.h>

#include <syndication/specificdocument.h>

template <class T> class QList;

namespace Syndication {
namespace RDF {

class Document;
class Model;
class DublinCore;
class Image;
class Item;
class SyndicationInfo;
class TextInput;
//@cond PRIVATE
typedef boost::shared_ptr<Document> DocumentPtr;
//@endcond

class SYNDICATION_EXPORT Document : public Syndication::SpecificDocument, public ResourceWrapper
{
    friend class ::Syndication::RDF::Model;
    public:

        Document();
        
        explicit Document(ResourcePtr resource);
        
        Document(const Document& other);
        
        virtual ~Document();

        bool operator==(const Document& other) const;
        
        Document& operator=(const Document& other);
        
        virtual bool accept(DocumentVisitor* visitor);

        bool isValid() const;

        QString title() const;
        
        QString description() const;

        QString link() const;

        DublinCore dc() const;

        SyndicationInfo syn() const;

        QList<Item> items() const;

        Image image() const;

        TextInput textInput() const;
//@cond PRIVATE
        void getItemTitleFormatInfo(bool* containsMarkup) const;

        void getItemDescriptionFormatInfo(bool* containsMarkup) const;
//@endcond PRIVATE
        
        virtual QString debugInfo() const;

    private:
        class Private;
        Private* const d;
};

} // namespace RDF
} // namespace Syndication

#endif //  SYNDICATION_RDF_DOCUMENT_H