Syndication

global.h
1 /*
2  * This file is part of the syndication library
3  *
4  * Copyright (C) 2006 Frank Osterfeld <[email protected]>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
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  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB. If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22 #ifndef SYNDICATION_GLOBAL_H
23 #define SYNDICATION_GLOBAL_H
24 
25 #include <feed.h>
26 
27 #include "syndication_export.h"
28 
29 #include <QString>
30 
31 namespace Syndication
32 {
33 
34 class DocumentSource;
35 template <class T> class ParserCollection;
36 
66 SYNDICATION_EXPORT
68 
78 SYNDICATION_EXPORT
79 FeedPtr parse(const DocumentSource &src, const QString &formatHint = QString());
80 
84 enum ErrorCode {
85  Success = 0,
88  Aborted = 1,
89  Timeout = 2,
114 };
115 
116 } // namespace Syndication
117 
118 #endif // SYNDICATION_GLOBAL_H
FeedPtr parse(const DocumentSource &src, const QString &formatHint)
parses a document from a source and returns a new Feed object wrapping the feed content.
Definition: global.cpp:71
the host was contacted successfully, but reported a 404 error
Definition: global.h:93
the source was accepted by a parser, but the actual parsing failed.
Definition: global.h:109
Represents the source of a syndication document, as read from the downloaded file.
The source is valid XML, but no parser accepted it.
Definition: global.h:106
No error occurred, feed was fetched and parsed successfully.
Definition: global.h:85
file download timed out
Definition: global.h:89
ErrorCode
error code indicating fetching or parsing errors
Definition: global.h:84
retriever error not covered by the error codes above.
Definition: global.h:96
A collection of format-specific parser implementations.
Definition: global.h:35
file downloading/parsing was aborted by the user
Definition: global.h:88
The hostname couldn&#39;t get resolved to an IP address.
Definition: global.h:91
The XML is invalid.
Definition: global.h:101
ParserCollection< Feed > * parserCollection()
The default ParserCollection instance parsing a DocumentSource into a Feed object.
Definition: global.cpp:58
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jun 6 2020 22:53:16 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.