feed.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_FEED_H
#define SYNDICATION_FEED_H

#include <boost/shared_ptr.hpp>

#include "ksyndication_export.h"

class QDomElement;

template <class T> class QList;
template <class K, class T> class QMultiMap;
class QString;

namespace Syndication {

//@cond PRIVATE
class SpecificDocument;
typedef boost::shared_ptr<SpecificDocument> SpecificDocumentPtr;
class Category;
typedef boost::shared_ptr<Category> CategoryPtr;
class Feed;
typedef boost::shared_ptr<Feed> FeedPtr;
class Image;
typedef boost::shared_ptr<Image> ImagePtr;
class Item;
typedef boost::shared_ptr<Item> ItemPtr;
class Person;
typedef boost::shared_ptr<Person> PersonPtr;
//@endcond

class SYNDICATION_EXPORT Feed
{
    public:

        virtual ~Feed();

        virtual SpecificDocumentPtr specificDocument() const = 0;

        virtual QList<ItemPtr> items() const = 0;

        virtual QList<CategoryPtr> categories() const = 0;

        virtual QString title() const = 0;

        virtual QString link() const = 0;

        virtual QString description() const = 0;

        virtual ImagePtr image() const = 0;

        virtual QList<PersonPtr> authors() const = 0;

        virtual QString language() const = 0;

        virtual QString copyright() const = 0;

        virtual QMultiMap<QString, QDomElement> additionalProperties() const = 0;

        virtual QString debugInfo() const;
};

} // namespace Syndication

#endif // SYNDICATION_FEED_H