Syndication Namespace Reference

Namespaces
namespace	Atom
namespace	RDF
namespace	RSS2

Classes
class	AbstractParser
class	AtomMapper
class	Category
class	CategoryAtomImpl
class	CategoryRSS2Impl
class	DataRetriever
class	DocumentSource
class	DocumentVisitor
class	ElementWrapper
class	Enclosure
class	EnclosureAtomImpl
class	EnclosureRSS2Impl
class	Feed
class	FeedAtomImpl
class	FeedRDFImpl
class	FeedRSS2Impl
class	Image
class	ImageAtomImpl
class	ImageRDFImpl
class	ImageRSS2Impl
class	Item
class	ItemAtomImpl
class	ItemRDFImpl
class	ItemRSS2Impl
class	Loader
class	Mapper
class	ParserCollection
class	Person
class	RDFMapper
class	RSS2Mapper
class	SpecificDocument
class	SpecificItem
class	SpecificItemVisitor

Typedefs
typedef QSharedPointer< CategoryAtomImpl >	CategoryAtomImplPtr
typedef QSharedPointer< Category >	CategoryPtr
typedef QSharedPointer< CategoryRSS2Impl >	CategoryRSS2ImplPtr
typedef QSharedPointer< EnclosureAtomImpl >	EnclosureAtomImplPtr
typedef QSharedPointer< EnclosureRSS2Impl >	EnclosureRSS2ImplPtr
typedef QSharedPointer< FeedAtomImpl >	FeedAtomImplPtr
typedef QSharedPointer< FeedRDFImpl >	FeedRDFImplPtr
typedef QSharedPointer< FeedRSS2Impl >	FeedRSS2ImplPtr
typedef QSharedPointer< ImageAtomImpl >	ImageAtomImplPtr
typedef QSharedPointer< Image >	ImagePtr
typedef QSharedPointer< ImageRDFImpl >	ImageRDFImplPtr
typedef QSharedPointer< ImageRSS2Impl >	ImageRSS2ImplPtr
typedef QSharedPointer< ItemAtomImpl >	ItemAtomImplPtr
typedef QSharedPointer< ItemRDFImpl >	ItemRDFImplPtr
typedef QSharedPointer< ItemRSS2Impl >	ItemRSS2ImplPtr

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 QByteArray &array)
unsigned int	calcHash (const QString &str)
QString	calcMD5Sum (const QString &str)
QString	commentApiNamespace ()
QString	contentNameSpace ()
QString	convertNewlines (const QString &strp)
QString	dateTimeToString (uint 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())
uint	parseDate (const QString &str, DateFormat hint)
uint	parseISODate (const QString &str)
ParserCollection< Feed > *	parserCollection ()
uint	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 QRegularExpression	tagRegExp ()
static uint	toTimeT (QDateTime &kdt)
QString	xhtmlNamespace ()
QString	xmlNamespace ()

Variables
QCryptographicHash	md5Machine (QCryptographicHash::Md5)
static ParserCollectionImpl< Syndication::Feed > *	parserColl = nullptr

Detailed Description

TODO.

Typedef Documentation

CategoryAtomImplPtr

typedef QSharedPointer<CategoryAtomImpl> Syndication::CategoryAtomImplPtr

Definition at line 17 of file categoryatomimpl.h.

CategoryPtr

typedef QSharedPointer<Category> Syndication::CategoryPtr

Definition at line 19 of file category.h.

CategoryRSS2ImplPtr

typedef QSharedPointer<CategoryRSS2Impl> Syndication::CategoryRSS2ImplPtr

Definition at line 17 of file categoryrss2impl.h.

EnclosureAtomImplPtr

typedef QSharedPointer<EnclosureAtomImpl> Syndication::EnclosureAtomImplPtr

Definition at line 17 of file enclosureatomimpl.h.

EnclosureRSS2ImplPtr

typedef QSharedPointer<EnclosureRSS2Impl> Syndication::EnclosureRSS2ImplPtr

Definition at line 18 of file enclosurerss2impl.h.

FeedAtomImplPtr

typedef QSharedPointer<FeedAtomImpl> Syndication::FeedAtomImplPtr

Definition at line 17 of file feedatomimpl.h.

FeedRDFImplPtr

typedef QSharedPointer<FeedRDFImpl> Syndication::FeedRDFImplPtr

Definition at line 17 of file feedrdfimpl.h.

FeedRSS2ImplPtr

typedef QSharedPointer<FeedRSS2Impl> Syndication::FeedRSS2ImplPtr

Definition at line 17 of file feedrss2impl.h.

ImageAtomImplPtr

typedef QSharedPointer<ImageAtomImpl> Syndication::ImageAtomImplPtr

Definition at line 18 of file imageatomimpl.h.

ImagePtr

typedef QSharedPointer< Image > Syndication::ImagePtr

Definition at line 19 of file feedatomimpl.h.

ImageRDFImplPtr

typedef QSharedPointer<ImageRDFImpl> Syndication::ImageRDFImplPtr

Definition at line 18 of file imagerdfimpl.h.

ImageRSS2ImplPtr

typedef QSharedPointer<ImageRSS2Impl> Syndication::ImageRSS2ImplPtr

Definition at line 17 of file imagerss2impl.h.

ItemAtomImplPtr

typedef QSharedPointer<ItemAtomImpl> Syndication::ItemAtomImplPtr

Definition at line 18 of file itematomimpl.h.

ItemRDFImplPtr

typedef QSharedPointer<ItemRDFImpl> Syndication::ItemRDFImplPtr

Definition at line 19 of file itemrdfimpl.h.

ItemRSS2ImplPtr

typedef QSharedPointer<ItemRSS2Impl> Syndication::ItemRSS2ImplPtr

Definition at line 17 of file itemrss2impl.h.

Enumeration Type Documentation

ErrorCode

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 70 of file global.h.

Function Documentation

calcHash() [1/2]

unsigned int Syndication::calcHash

(

const QByteArray &

array

)

Definition at line 30 of file tools.cpp.

calcHash() [2/2]

unsigned int Syndication::calcHash

(

const QString &

str

)

Definition at line 25 of file tools.cpp.

calcMD5Sum()

QString Syndication::calcMD5Sum

(

const QString &

str

)

Definition at line 103 of file tools.cpp.

commentApiNamespace()

SYNDICATION_EXPORT QString Syndication::commentApiNamespace

(

)

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

Definition at line 39 of file constants.cpp.

contentNameSpace()

SYNDICATION_EXPORT QString Syndication::contentNameSpace

(

)

Definition at line 24 of file constants.cpp.

convertNewlines()

QString Syndication::convertNewlines

(

const QString &

strp

)

Definition at line 126 of file tools.cpp.

dateTimeToString()

QString Syndication::dateTimeToString

(

uint

date

)

Definition at line 91 of file tools.cpp.

dublinCoreNamespace()

SYNDICATION_EXPORT QString Syndication::dublinCoreNamespace

(

)

Definition at line 29 of file constants.cpp.

escapeSpecialCharacters()

QString Syndication::escapeSpecialCharacters

(

const QString &

strp

)

Definition at line 115 of file tools.cpp.

htmlToPlainText()

QString Syndication::htmlToPlainText

(

const QString &

html

)

Definition at line 144 of file tools.cpp.

isHtml()

bool Syndication::isHtml

(

const QString &

str

)

Definition at line 174 of file tools.cpp.

itunesNamespace()

SYNDICATION_EXPORT QString Syndication::itunesNamespace

(

)

Definition at line 34 of file constants.cpp.

normalize() [1/2]

QString Syndication::normalize

(

const QString &

str

)

Definition at line 189 of file tools.cpp.

normalize() [2/2]

QString Syndication::normalize	(	const QString &	strp,
		bool	isCDATA,
		bool	containsMarkup )

Definition at line 194 of file tools.cpp.

parse()

SYNDICATION_EXPORT 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 54 of file global.cpp.

parseDate()

uint Syndication::parseDate	(	const QString &	str,
		DateFormat	hint )

Definition at line 76 of file tools.cpp.

parseISODate()

uint Syndication::parseISODate

(

const QString &

str

)

Definition at line 60 of file tools.cpp.

parserCollection()

SYNDICATION_EXPORT 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 41 of file global.cpp.

parseRFCDate()

uint Syndication::parseRFCDate

(

const QString &

str

)

Definition at line 66 of file tools.cpp.

personFromString()

PersonPtr Syndication::personFromString

(

const QString &

strp

)

Definition at line 213 of file tools.cpp.

plainTextToHtml()

QString Syndication::plainTextToHtml

(

const QString &

plainText

)

Definition at line 133 of file tools.cpp.

resolveEntities()

QString Syndication::resolveEntities

(

const QString &

str

)

Definition at line 110 of file tools.cpp.

slashNamespace()

SYNDICATION_EXPORT QString Syndication::slashNamespace

(

)

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

Definition at line 44 of file constants.cpp.

stringContainsMarkup()

bool Syndication::stringContainsMarkup

(

const QString &

str

)

Definition at line 159 of file tools.cpp.

tagRegExp()

static QRegularExpression Syndication::tagRegExp ( )

static

Definition at line 153 of file tools.cpp.

toTimeT()

static uint Syndication::toTimeT ( QDateTime & kdt )

static

Definition at line 45 of file tools.cpp.

xhtmlNamespace()

SYNDICATION_EXPORT QString Syndication::xhtmlNamespace

(

)

Definition at line 19 of file constants.cpp.

xmlNamespace()

SYNDICATION_EXPORT QString Syndication::xmlNamespace

(

)

Definition at line 14 of file constants.cpp.

Variable Documentation

parserColl

ParserCollectionImpl<Syndication::Feed>* Syndication::parserColl = nullptr

static

Definition at line 28 of file global.cpp.