Syndication

global.h
1 /*
2  This file is part of the syndication library
3  SPDX-FileCopyrightText: 2006 Frank Osterfeld <[email protected]>
4 
5  SPDX-License-Identifier: LGPL-2.0-or-later
6 */
7 
8 #ifndef SYNDICATION_GLOBAL_H
9 #define SYNDICATION_GLOBAL_H
10 
11 #include <feed.h>
12 
13 #include "syndication_export.h"
14 
15 #include <QString>
16 
17 namespace Syndication
18 {
19 
20 class DocumentSource;
21 template <class T> class ParserCollection;
22 
52 SYNDICATION_EXPORT
54 
64 SYNDICATION_EXPORT
65 FeedPtr parse(const DocumentSource &src, const QString &formatHint = QString());
66 
70 enum ErrorCode {
71  Success = 0,
74  Aborted = 1,
75  Timeout = 2,
87  InvalidXml = 6,
100 };
101 
102 } // namespace Syndication
103 
104 #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:56
the host was contacted successfully, but reported a 404 error
Definition: global.h:79
the source was accepted by a parser, but the actual parsing failed.
Definition: global.h:95
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:92
No error occurred, feed was fetched and parsed successfully.
Definition: global.h:71
file download timed out
Definition: global.h:75
ErrorCode
error code indicating fetching or parsing errors
Definition: global.h:70
retriever error not covered by the error codes above.
Definition: global.h:82
A collection of format-specific parser implementations.
Definition: global.h:21
file downloading/parsing was aborted by the user
Definition: global.h:74
The hostname couldn&#39;t get resolved to an IP address.
Definition: global.h:77
The XML is invalid.
Definition: global.h:87
ParserCollection< Feed > * parserCollection()
The default ParserCollection instance parsing a DocumentSource into a Feed object.
Definition: global.cpp:43
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Jan 25 2021 23:07:41 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.