folder.h

/*
    This file is part of Akregator.
 
    Copyright (C) 2004 Stanislav Karchebny <Stanislav.Karchebny@kdemail.net>
                  2004-2005 Frank Osterfeld <frank.osterfeld@kdemail.net>
                  
    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 TQt, and distribute the resulting executable,
    without including the source code for TQt in the source distribution.
*/
 
#ifndef AKREGATOR_FOLDER_H
#define AKREGATOR_FOLDER_H
 
#include "treenode.h"
 
class TQDomDocument;
class TQDomElement;
class TQStringList;
template <class T> class TQValueList;
 
namespace Akregator
{
    class Article;
    class FetchQueue;
    class TreeNodeVisitor;
        
    class Folder : public TreeNode
    {
        TQ_OBJECT
  
        public:
            static Folder* fromOPML(TQDomElement e);
            
            Folder(const TQString& title = TQString());
            
            virtual ~Folder();
 
            virtual bool accept(TreeNodeVisitor* visitor);
            
            virtual TQValueList<Article> articles(const TQString& tag=TQString());
 
            virtual TQStringList tags() const;
            
            virtual int unread() const;
            
            virtual int totalCount() const;
            
            virtual bool isGroup() const { return true; }
 
            virtual TQDomElement toOPML( TQDomElement parent, TQDomDocument document ) const;
            
            virtual TQValueList<TreeNode*> children() const;
            
            virtual void insertChild(TreeNode* node, TreeNode* after);
            
            virtual void prependChild(TreeNode* node);
 
            virtual void appendChild(TreeNode* node);
 
            virtual void removeChild(TreeNode* node);
 
            virtual TreeNode* firstChild();
            
            virtual TreeNode* lastChild();
            
            virtual bool isOpen() const;
            
            virtual void setOpen(bool open);
            
        signals:
            void signalChildAdded(TreeNode*);
 
            void signalChildRemoved(Folder*, TreeNode*);
                       
        public slots:
            
            virtual void slotDeleteExpiredArticles();
            
            virtual void slotMarkAllArticlesAsRead();
 
            virtual void slotChildChanged(TreeNode* node);
            
            virtual void slotChildDestroyed(TreeNode* node);
 
            virtual void slotAddToFetchQueue(FetchQueue* queue, bool intervalFetchesOnly=false);
 
            virtual TreeNode* next();
 
        protected:
        
            virtual void insertChild(uint index, TreeNode* node);
 
            virtual void doArticleNotification();
        private:
 
            void connectToNode(TreeNode* child);
            void disconnectFromNode(TreeNode* child);
            
            virtual void updateUnreadCount();
            
            class FolderPrivate;
            FolderPrivate* d;
    };
}
 
#endif // AKREGATOR_FOLDER_H