Syndication Namespace Reference

Classes
class	AbstractParser
class	Category
class	DataRetriever
class	DocumentSource
class	DocumentVisitor
class	ElementWrapper
class	Enclosure
class	Feed
class	FileRetriever
class	Image
class	Item
class	Loader
class	Mapper
class	OutputRetriever
class	ParserCollection
class	Person
class	SpecificDocument
class	SpecificItem
class	SpecificItemVisitor

Typedefs
typedef boost::shared_ptr < Category >	CategoryPtr

Enumerations
enum	ErrorCode {   Success = 0, Aborted = 1, Timeout = 2, UnknownHost = 3,   FileNotFound = 4, OtherRetrieverError = 5, InvalidXml = 6, XmlNotAccepted = 7,   InvalidFormat = 8 }

Functions
unsigned int	calcHash (const QString &str)
unsigned int	calcHash (const QByteArray &array)
QString	calcMD5Sum (const QString &str)
QString	commentApiNamespace ()
QString	contentNameSpace ()
QString	convertNewlines (const QString &strp)
QString	dateTimeToString (time_t date)
QString	dublinCoreNamespace ()
QString	escapeSpecialCharacters (const QString &strp)
QString	htmlToPlainText (const QString &html)
bool	isHtml (const QString &str)
QString	itunesNamespace ()
QString	normalize (const QString &str)
QString	normalize (const QString &strp, bool isCDATA, bool containsMarkup)
FeedPtr	parse (const DocumentSource &src, const QString &formatHint=QString())
time_t	parseDate (const QString &str, DateFormat hint)
time_t	parseISODate (const QString &str)
ParserCollection< Feed > *	parserCollection ()
time_t	parseRFCDate (const QString &str)
PersonPtr	personFromString (const QString &strp)
QString	plainTextToHtml (const QString &plainText)
QString	resolveEntities (const QString &str)
QString	slashNamespace ()
bool	stringContainsMarkup (const QString &str)
static time_t	toTimeT (KDateTime &kdt)
QString	xhtmlNamespace ()
QString	xmlNamespace ()

Variables
KMD5	md5Machine
static ParserCollectionImpl < Syndication::Feed > *	parserColl = 0

Detailed Description

TODO.

Enumeration Type Documentation

enum Syndication::ErrorCode

error code indicating fetching or parsing errors

Enumerator
Success	No error occurred, feed was fetched and parsed successfully.
Aborted	file downloading/parsing was aborted by the user
Timeout	file download timed out
UnknownHost	The hostname couldn't get resolved to an IP address.
FileNotFound	the host was contacted successfully, but reported a 404 error
OtherRetrieverError	retriever error not covered by the error codes above. This is returned if a custom DataRetriever was used. See the retriever-specific status byte for more information on the occurred error.
InvalidXml	The XML is invalid. This is returned if no parser accepts the source and the DOM document can't be parsed. It is not returned if the source is not valid XML but a (non-XML) parser accepts it.
XmlNotAccepted	The source is valid XML, but no parser accepted it.
InvalidFormat	the source was accepted by a parser, but the actual parsing failed. As our parser implementations currently do not validate the source ("parse what you can get"), this code will be rarely seen.

Definition at line 85 of file global.h.

Function Documentation

QString Syndication::commentApiNamespace

(

)

wellformedweb.org's RSS namespace for comment functionality "http://wellformedweb.org/CommentAPI/"

Definition at line 54 of file constants.cpp.

FeedPtr Syndication::parse	(	const DocumentSource &	src,
		const QString &	formatHint = QString()
	)

parses a document from a source and returns a new Feed object wrapping the feed content.

Shortcut for parserCollection()->parse(). See ParserCollection::parse() for more details.

Parameters

src	the document source to parse
formatHint	an optional hint which format to test first

Definition at line 69 of file global.cpp.

ParserCollection< Feed > * Syndication::parserCollection

(

)

The default ParserCollection instance parsing a DocumentSource into a Feed object.

Use this to parse a local file or a otherwise manually created DocumentSource object.

To retrieve a feed from the web, use Loader instead.

Example code:

...
QFile someFile(somePath);
...
DocumentSource src(someFile.readAll());
someFile.close();

FeedPtr feed = parserCollection()->parse(src);

if (feed)
{
    QString title = feed->title();
    QList<ItemPtr> items = feed->items();
    ...
}

Definition at line 55 of file global.cpp.

QString Syndication::slashNamespace

(

)

"slash" namespace http://purl.org/rss/1.0/modules/slash/

Definition at line 59 of file constants.cpp.