treenode.h

Go to the documentation of this file.

/*
    This file is part of Akregator.

    Copyright (C) 2004 Frank Osterfeld <osterfeld@kde.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

    As a special exception, permission is given to link this program
    with any edition of Qt, and distribute the resulting executable,
    without including the source code for Qt in the source distribution.
*/

#ifndef AKREGATOR_TREENODE_H
#define AKREGATOR_TREENODE_H

#include "akregator_export.h"
#include <QObject>
#include <QVector>

class KJob;

class QDomDocument;
class QDomElement;
class QIcon;
class QPoint;
class QString;
class QStringList;
template <class T> class QList;

namespace Akregator
{

class ArticleDeleteJob;
class ArticleListJob;
class TreeNodeVisitor;
class Article;
class Feed;
class Folder;
class FetchQueue;


class AKREGATOR_EXPORT TreeNode : public QObject
{
    friend class ::Akregator::ArticleListJob;
    friend class ::Akregator::Folder;

Q_OBJECT

public:

    TreeNode();

    virtual ~TreeNode();

    virtual bool accept(TreeNodeVisitor* visitor) = 0;

    virtual int unread() const = 0;


    virtual int totalCount() const = 0;


    QString title() const;


    void setTitle(const QString& title);


    virtual const TreeNode* nextSibling() const;
    virtual TreeNode* nextSibling();

    virtual const TreeNode* prevSibling() const;
    virtual TreeNode* prevSibling();



    virtual const Folder* parent() const;
    virtual Folder* parent();


    virtual QList<const TreeNode*> children() const;
    virtual QList<TreeNode*> children();

    virtual QVector<const Feed*> feeds() const = 0;
    virtual QVector<Feed*> feeds() = 0;

    virtual QVector<const Folder*> folders() const = 0;
    virtual QVector<Folder*> folders() = 0;

    virtual TreeNode* childAt( int pos );
    virtual const TreeNode* childAt( int pos ) const;

    virtual void setParent(Folder* parent);

    virtual QIcon icon() const = 0;

    ArticleListJob* createListJob();

    virtual bool isGroup() const = 0;

    virtual bool isAggregation() const = 0;

    virtual QDomElement toOPML( QDomElement parent, QDomDocument document ) const = 0;

    virtual void setNotificationMode(bool doNotify);

    virtual const TreeNode* next() const = 0;
    virtual TreeNode* next() = 0;

    virtual uint id() const;

    virtual void setId(uint id);

    QPoint listViewScrollBarPositions() const;
    void setListViewScrollBarPositions( const QPoint& pos );

    virtual KJob* createMarkAsReadJob() = 0;

public slots:

    virtual void slotAddToFetchQueue(Akregator::FetchQueue* queue, bool intervalFetchesOnly=false) = 0;

signals:

     void signalDestroyed(Akregator::TreeNode*);

    void signalChanged(Akregator::TreeNode*);

    void signalArticlesAdded(Akregator::TreeNode*, const QList<Akregator::Article>& guids);

    void signalArticlesUpdated(Akregator::TreeNode*, const QList<Akregator::Article>& guids);

    void signalArticlesRemoved(Akregator::TreeNode*, const QList<Akregator::Article>& guids);

protected:

    virtual void nodeModified();

    virtual void articlesModified();

    virtual void doArticleNotification();

    void emitSignalDestroyed();

private:
    virtual QList<Article> articles() = 0;

private:
    class TreeNodePrivate;
    TreeNodePrivate* d;
};

} // namespace Akregator

#endif // AKREGATOR_TREENODE_H