• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

Syndication Library

  • syndication
global.h
1/*
2 * This file is part of the syndication library
3 *
4 * Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
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 <syndication/feed.h>
26
27#include "ksyndication_export.h"
28
29#include <QtCore/QString>
30
31#define SYNDICATION_VERSION "0.1"
32
33namespace Syndication {
34
35class DocumentSource;
36template <class T> class ParserCollection;
37
67SYNDICATION_EXPORT
68ParserCollection<Feed>* parserCollection();
69
79SYNDICATION_EXPORT
80FeedPtr parse(const DocumentSource& src, const QString& formatHint=QString());
81
85enum ErrorCode
86{
87 Success = 0,
90 Aborted = 1,
91 Timeout = 2,
93 UnknownHost = 3,
95 FileNotFound = 4,
98 OtherRetrieverError = 5,
103 InvalidXml = 6,
108 XmlNotAccepted = 7,
111 InvalidFormat = 8
116};
117
118
119} // namespace Syndication
120
121#endif // SYNDICATION_GLOBAL_H
Syndication
TODO.
Definition: abstractparser.cpp:25
Syndication::ErrorCode
ErrorCode
error code indicating fetching or parsing errors
Definition: global.h:86
Syndication::Timeout
@ Timeout
file download timed out
Definition: global.h:91
Syndication::OtherRetrieverError
@ OtherRetrieverError
retriever error not covered by the error codes above.
Definition: global.h:98
Syndication::FileNotFound
@ FileNotFound
the host was contacted successfully, but reported a 404 error
Definition: global.h:95
Syndication::UnknownHost
@ UnknownHost
The hostname couldn't get resolved to an IP address.
Definition: global.h:93
Syndication::InvalidXml
@ InvalidXml
The XML is invalid.
Definition: global.h:103
Syndication::XmlNotAccepted
@ XmlNotAccepted
The source is valid XML, but no parser accepted it.
Definition: global.h:108
Syndication::InvalidFormat
@ InvalidFormat
the source was accepted by a parser, but the actual parsing failed.
Definition: global.h:111
Syndication::Aborted
@ Aborted
file downloading/parsing was aborted by the user
Definition: global.h:90
Syndication::Success
@ Success
No error occurred, feed was fetched and parsed successfully.
Definition: global.h:87
Syndication::parse
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:69
Syndication::parserCollection
ParserCollection< Feed > * parserCollection()
The default ParserCollection instance parsing a DocumentSource into a Feed object.
Definition: global.cpp:55
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Syndication Library

Skip menu "Syndication Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal