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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>RSSKit: RSSFeed.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<h1>RSSFeed.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*-objc-*-</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * GNUstep RSS Kit</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2006 Guenther Noack</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> * it under the terms of the GNU General Public License version 2 as</span>
<a name="l00008"></a>00008 <span class="comment"> * published by the Free Software Foundation.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00013"></a>00013 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00018"></a>00018 <span class="comment"> */</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#import <objc/objc.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#import <Foundation/Foundation.h></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 @<span class="keyword">class </span><a class="code" href="classRSSFeed.html">RSSFeed</a>;
<a name="l00024"></a>00024
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#import "RSSArticle.h"</span>
<a name="l00027"></a>00027
<a name="l00031"></a>00031 <span class="keyword">enum</span> RSSFeedError
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 RSSFeedErrorNoError = 0,
<a name="l00034"></a>00034 RSSFeedErrorNoFetcherError,
<a name="l00035"></a>00035 RSSFeedErrorMalformedURL,
<a name="l00036"></a>00036 RSSFeedErrorDomainNotKnown,
<a name="l00037"></a>00037 RSSFeedErrorServerNotReachable,
<a name="l00038"></a>00038 RSSFeedErrorDocumentNotPresent,
<a name="l00039"></a>00039 RSSFeedErrorMalformedRSS
<a name="l00040"></a>00040 };
<a name="l00041"></a>00041
<a name="l00045"></a>00045 <span class="keyword">enum</span> RSSFeedStatus
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 RSSFeedIsFetching,
<a name="l00048"></a>00048 RSSFeedIsIdle
<a name="l00049"></a>00049 };
<a name="l00050"></a>00050
<a name="l00054"></a>00054 <span class="keyword">@protocol </span>RSSFeedDelegate;
<a name="l00055"></a>00055
<a name="l00107"></a>00107 <span class="keyword">@interface </span><a class="code" href="classRSSFeed.html">RSSFeed</a> : NSObject <NSCoding>
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109 @<span class="keyword">protected</span>
<a name="l00110"></a>00110 NSDate* <a class="code" href="classRSSFeed.html#190fafaff71f21de561ba30be376d223">lastRetrieval</a>;
<a name="l00111"></a>00111 BOOL clearFeedBeforeFetching;
<a name="l00112"></a>00112 NSArray* articles;
<a name="l00113"></a><a class="code" href="classRSSFeed.html#461f168ad127ec8e2b27daa991fcad41">00113</a> <span class="keyword">enum</span> RSSFeedError <a class="code" href="categoryRSSFeed(Fetching).html#bc5932a5df8233857ffb8f3f802792b6">lastError</a>;
<a name="l00114"></a>00114 NSString* <a class="code" href="classRSSFeed.html#b633045a0af241daedc5fc5c1aab72ea">feedName</a>;
<a name="l00115"></a>00115 NSURL* <a class="code" href="classRSSFeed.html#7faf1b2a0a0a5c4c6baad94f2e394834">feedURL</a>;
<a name="l00116"></a><a class="code" href="classRSSFeed.html#46d6ffae81a000ce1751557cec10a1d1">00116</a> Class <a class="code" href="classRSSFeed.html#2dae4f34cd0cf9880881daa45cec641b">articleClass</a>;
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">enum</span> RSSFeedStatus <a class="code" href="classRSSFeed.html#c44486e9314ab95c8d6b7a139df1cf24">status</a>;
<a name="l00119"></a>00119 NSRecursiveLock* lock;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 id<RSSFeedDelegate> _delegate;
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123
<a name="l00124"></a>00124
<a name="l00125"></a>00125 +feed;
<a name="l00126"></a>00126 +feedWithURL: (NSURL*) aURL;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 -init;
<a name="l00129"></a>00129
<a name="l00135"></a>00135 -initWithURL: (NSURL*) aURL;
<a name="l00136"></a>00136
<a name="l00137"></a>00137
<a name="l00141"></a>00141 -(NSString*) description;
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00144"></a>00144 <span class="comment">// The RSSFeed's delegate</span>
<a name="l00145"></a>00145 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00146"></a>00146
<a name="l00147"></a>00147 -(<span class="keywordtype">void</span>)setDelegate: (<span class="keywordtype">id</span><RSSFeedDelegate>)aDelegate;
<a name="l00148"></a>00148 -(<span class="keywordtype">id</span><RSSFeedDelegate>)delegate;
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00151"></a>00151 <span class="comment">// NSCoding methods</span>
<a name="l00152"></a>00152 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00153"></a>00153
<a name="l00154"></a>00154 -(<span class="keywordtype">id</span>)initWithCoder: (NSCoder*)coder;
<a name="l00155"></a>00155 -(<span class="keywordtype">void</span>)encodeWithCoder: (NSCoder*)coder;
<a name="l00156"></a>00156
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00159"></a>00159 <span class="comment">// Status access</span>
<a name="l00160"></a>00160 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00161"></a>00161
<a name="l00169"></a>00169 - (enum RSSFeedStatus) status;
<a name="l00170"></a>00170
<a name="l00171"></a>00171
<a name="l00172"></a>00172 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00173"></a>00173 <span class="comment">// Access to the articles</span>
<a name="l00174"></a>00174 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00175"></a>00175
<a name="l00188"></a>00188 - (RSSArticle*) articleAtIndex: (<span class="keywordtype">int</span>) index;
<a name="l00189"></a>00189
<a name="l00193"></a>00193 - (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) count;
<a name="l00194"></a>00194
<a name="l00198"></a>00198 - (NSEnumerator*) articleEnumerator;
<a name="l00199"></a>00199
<a name="l00205"></a>00205 - (<span class="keywordtype">void</span>) removeArticle: (RSSArticle*) article;
<a name="l00206"></a>00206
<a name="l00207"></a>00207
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00210"></a>00210 <span class="comment">// Access to the preferences</span>
<a name="l00211"></a>00211 <span class="comment">// ----------------------------------------------------------------------</span>
<a name="l00212"></a>00212
<a name="l00216"></a>00216 - (NSString*) feedName;
<a name="l00217"></a>00217
<a name="l00222"></a>00222 - (NSURL*) feedURL;
<a name="l00223"></a>00223
<a name="l00224"></a>00224
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="comment">// --------------------------------------------------------------------</span>
<a name="l00227"></a>00227 <span class="comment">// Equality and hash codes</span>
<a name="l00228"></a>00228 <span class="comment">// --------------------------------------------------------------------</span>
<a name="l00229"></a>00229 - (<span class="keywordtype">unsigned</span>) hash;
<a name="l00230"></a>00230 - (BOOL) isEqual: (<span class="keywordtype">id</span>)anObject;
<a name="l00231"></a>00231
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="comment">// --------------------------------------------------------------------</span>
<a name="l00234"></a>00234 <span class="comment">// Accessor and Mutator for the automatic clearing</span>
<a name="l00235"></a>00235 <span class="comment">// --------------------------------------------------------------------</span>
<a name="l00236"></a>00236
<a name="l00244"></a>00244 - (<span class="keywordtype">void</span>) setAutoClear: (BOOL) autoClear;
<a name="l00245"></a>00245
<a name="l00246"></a>00246
<a name="l00251"></a>00251 - (BOOL) autoClear;
<a name="l00252"></a>00252
<a name="l00253"></a>00253
<a name="l00257"></a>00257 - (<span class="keywordtype">void</span>) clearArticles;
<a name="l00258"></a>00258
<a name="l00259"></a>00259
<a name="l00260"></a>00260
<a name="l00261"></a>00261 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00262"></a>00262 <span class="comment">// Extensions that make subclassing RSSFeed and RSSArticle easier.</span>
<a name="l00263"></a>00263 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00264"></a>00264
<a name="l00271"></a>00271 -(<span class="keywordtype">void</span>) setArticleClass:(Class)aClass;
<a name="l00272"></a>00272
<a name="l00279"></a>00279 -(Class) articleClass;
<a name="l00280"></a>00280
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00283"></a>00283 <span class="comment">// Dirtyness, now implemented via the date of last retrieval</span>
<a name="l00284"></a>00284 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00285"></a>00285
<a name="l00292"></a>00292 -(NSDate*) lastRetrieval;
<a name="l00293"></a>00293
<a name="l00294"></a>00294
<a name="l00298"></a>00298 -(<span class="keywordtype">void</span>) newArticleFound: (RSSArticle*) anArticle;
<a name="l00299"></a>00299
<a name="l00300"></a>00300 <span class="keyword">@end</span>
<a name="l00301"></a>00301
<a name="l00302"></a>00302
<a name="l00303"></a>00303
<a name="l00304"></a>00304 <span class="comment">/*</span>
<a name="l00305"></a>00305 <span class="comment"> * FIXME: Hide this interface in some other header file</span>
<a name="l00306"></a>00306 <span class="comment"> * so that programmers don't get confused.</span>
<a name="l00307"></a>00307 <span class="comment"> */</span>
<a name="l00308"></a>00308
<a name="l00309"></a>00309 <span class="keyword">@interface </span><a class="code" href="classRSSFeed.html">RSSFeed</a> (Private)
<a name="l00310"></a>00310
<a name="l00317"></a>00317 -(BOOL) _submitArticles: (NSArray*) newArticles;
<a name="l00318"></a>00318
<a name="l00319"></a>00319 <span class="keyword">@end</span>
<a name="l00320"></a>00320
<a name="l00321"></a>00321
<a name="l00327"></a><a class="code" href="protocolRSSFeedDelegate-p.html">00327</a> <span class="keyword">@protocol </span>RSSFeedDelegate <NSObject>
<a name="l00328"></a>00328
<a name="l00332"></a>00332 - (<span class="keywordtype">void</span>) feed: (RSSFeed*) aFeed
<a name="l00333"></a>00333 addedArticle: (RSSArticle*) anArticle;
<a name="l00334"></a>00334
<a name="l00335"></a>00335 <span class="keyword">@end</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Thu Aug 3 00:51:27 2006 for RSSKit by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
|
