global.h

00001 /*
00002  * This file is part of the syndication library
00003  *
00004  * Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
00005  *
00006  * This library is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU Library General Public
00008  * License as published by the Free Software Foundation; either
00009  * version 2 of the License, or (at your option) any later version.
00010  *
00011  * This library is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  * Library General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU Library General Public License
00017  * along with this library; see the file COPYING.LIB.  If not, write to
00018  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00019  * Boston, MA 02110-1301, USA.
00020  *
00021  */
00022 #ifndef SYNDICATION_GLOBAL_H
00023 #define SYNDICATION_GLOBAL_H
00024 
00025 #include <syndication/feed.h>
00026 
00027 #include "ksyndication_export.h"
00028 
00029 #include <QtCore/QString>
00030 
00031 #define SYNDICATION_VERSION "0.1"
00032 
00033 namespace Syndication {
00034 
00035 class DocumentSource;
00036 template <class T> class ParserCollection;
00037 
00067 SYNDICATION_EXPORT
00068 ParserCollection<Feed>* parserCollection();
00069 
00079 SYNDICATION_EXPORT
00080 FeedPtr parse(const DocumentSource& src, const QString& formatHint=QString());
00081 
00085 enum ErrorCode
00086 {
00087     Success = 0, 
00090     Aborted = 1, 
00091     Timeout = 2, 
00093     UnknownHost = 3, 
00095     FileNotFound = 4, 
00098     OtherRetrieverError = 5, 
00103     InvalidXml = 6, 
00108     XmlNotAccepted = 7, 
00111     InvalidFormat = 8 
00116 };
00117 
00118 
00119 } // namespace Syndication
00120 
00121 #endif // SYNDICATION_GLOBAL_H

Syndication Library

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys