1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
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 Qt, and distribute the resulting executable,
without including the source code for Qt in the source distribution.
*/
#ifndef AKREGATOR_FOLDER_H
#define AKREGATOR_FOLDER_H
#include "treenode.h"
class QDomDocument;
class QDomElement;
class QStringList;
template <class T> class QValueList;
namespace Akregator
{
class Article;
class FetchQueue;
class TreeNodeVisitor;
/** Represents a folder (containing feeds and/or other folders)
*/
class Folder : public TreeNode
{
Q_OBJECT
public:
/** creates a feed group parsed from a XML dom element.
Child nodes are not inserted or parsed.
@param e the element representing the feed group
@return a freshly created feed group */
static Folder* fromOPML(TQDomElement e);
/** Creates a new folder with a given title
@param title The title of the feed group
*/
Folder(const TQString& title = TQString::null);
virtual ~Folder();
virtual bool accept(TreeNodeVisitor* visitor);
/** returns recursively concatenated articles of children
@return an article sequence containing articles of children */
virtual TQValueList<Article> articles(const TQString& tag=TQString::null);
/** returns a list of all tags occurring in the subtree of this folder */
virtual TQStringList tags() const;
/** returns the number of unread articles in all children
@return number of unread articles */
virtual int unread() const;
/** returns the number of articles in all children
@return number of articles */
virtual int totalCount() const;
/** Helps the rest of the app to decide if node should be handled as group or not. Use only where necessary, use polymorphism where possible. */
virtual bool isGroup() const { return true; }
/** converts the feed group into OPML format for save and export and appends it to node @c parent in document @document.
Children are processed and appended recursively.
@param parent The parent element
@param document The DOM document
@return The newly created element representing this feed group */
virtual TQDomElement toOPML( TQDomElement parent, TQDomDocument document ) const;
/** returns the (direct) children of this node.
@return a list of pointers to the child nodes
*/
virtual TQValueList<TreeNode*> children() const;
/** inserts @c node as child after child node @c after.
if @c after is not a child of this group, @c node will be inserted as first child
@param node the tree node to insert
@param after the node after which @c node will be inserted */
virtual void insertChild(TreeNode* node, TreeNode* after);
/** inserts @c node as first child
@param node the tree node to insert */
virtual void prependChild(TreeNode* node);
/** inserts @c node as last child
@param node the tree node to insert */
virtual void appendChild(TreeNode* node);
/** remove @c node from children. Note that @c node will not be deleted
@param node the child node to remove */
virtual void removeChild(TreeNode* node);
/** returns the first child of the group, 0 if none exist */
virtual TreeNode* firstChild();
/** returns the last child of the group, 0 if none exist */
virtual TreeNode* lastChild();
/** returns whether the feed group is opened or not..
Use only in \ref FolderItem. */
virtual bool isOpen() const;
/** open/close the feed group (display it as expanded/collapsed in the tree view). Use only in \ref FolderItem. */
virtual void setOpen(bool open);
signals:
/** emitted when a child was added */
void signalChildAdded(TreeNode*);
/** emitted when a child was removed */
void signalChildRemoved(Folder*, TreeNode*);
public slots:
/** Delete expired articles recursively. */
virtual void slotDeleteExpiredArticles();
/** Mark articles of children recursively as read. */
virtual void slotMarkAllArticlesAsRead();
/** Called when a child was modified.
@param node the child that was changed
*/
virtual void slotChildChanged(TreeNode* node);
/** Called when a child was destroyed.
@param node the child that was destroyed
*/
virtual void slotChildDestroyed(TreeNode* node);
/** enqueues children recursively for fetching
@param queue a fetch queue
@param internvalFetchesOnly */
virtual void slotAddToFetchQueue(FetchQueue* queue, bool intervalFetchesOnly=false);
/** returns the next node in the tree.
Calling next() unless it returns 0 iterates through the tree in pre-order
*/
virtual TreeNode* next();
protected:
/** inserts @c node as child on position @c index
@param index the position where to insert
@param node the tree node to insert */
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
|
