RSSKit  0.6.1
RSSFeedProtocol.h
1 /* -*-objc-*-
2  *
3  * GNUstep RSS Kit
4  * Copyright (C) 2006 Guenther Noack
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation, in version 2.1
9  * of the License
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  */
20 
21 #import <Foundation/Foundation.h>
22 
23 // --- Notifications ---
24 
29 extern NSString *const RSSFeedFetchedNotification;
30 
37 extern NSString *const RSSFeedFetchFailedNotification;
38 
43 extern NSString *const RSSFeedWillFetchNotification;
44 
45 // ---------------------
46 
50 enum RSSFeedError
51  {
52  RSSFeedErrorNoError = 0,
53  RSSFeedErrorNoFetcherError,
54  RSSFeedErrorMalformedURL,
55  RSSFeedErrorDomainNotKnown,
56  RSSFeedErrorServerNotReachable,
57  RSSFeedErrorDocumentNotPresent,
58  RSSFeedErrorMalformedRSS
59  };
60 
61 
66 @protocol RSSFeed
67 
68 // Article access
69 
73 - (NSEnumerator*) articleEnumerator;
74 
78 - (NSSet*) articleSet;
79 
83 - (int) articleCount;
84 
88 - (BOOL)isFetching;
89 
93 - (NSString*) feedName;
94 
99 - (NSURL*) feedURL;
100 
108 - (enum RSSFeedError) fetch;
109 
117 - (void) fetchInBackground;
118 
122 - (enum RSSFeedError) lastError;
123 
128 - (NSMutableDictionary*) plistDictionary;
129 @end
130 
131 @protocol RSSMutableFeed <RSSFeed>
137 - (void) removeArticle: (id) article;
138 
139 
143 - (void) setFeedName: (NSString*) aFeedName;
144 
145 @end
146