Syndication Namespace

Function Documentation

QString Syndication::commentApiNamespace()

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

QString Syndication::contentNameSpace()

QString Syndication::convertNewlines(const QString &str)

replaces newlines ("\n") by <br/>

str string to convert

QString Syndication::dublinCoreNamespace()

QString Syndication::escapeSpecialCharacters(const QString &str)

replaces the characters <, >, &, ", ' with &lt; &gt; &amp;, &quot; &apos;.

str the string to escape

QString Syndication::htmlToPlainText(const QString &html)

converts a HTML string to plain text

html string in HTML format

Returns stripped text

bool Syndication::isHtml(const QString &str)

guesses whether a string contains plain text or HTML

str the string in unknown format

Returns true if the heuristic thinks it's HTML, false if thinks it is plain text

QString Syndication::itunesNamespace()

QString Syndication::normalize(const QString &str)

Ensures HTML formatting for a string.

guesses via isHtml() if str contains HTML or plain text, and returns plainTextToHtml(str) if it thinks it is plain text, or the unmodified str otherwise.

str a string with unknown content Returns string as HTML (as long as the heuristics work)

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

normalizes a string based on feed-wide properties of tag content. It is based on the assumption that all items in a feed encode their title/description content in the same way (CDATA or not, plain text vs. HTML). isCDATA and containsMarkup are determined once by the feed, and then passed to this method.

The returned string contains HTML, with special characters <, >, &, ", and ' escaped, and all other entities resolved. Whitespace is collapsed, relevant whitespace is replaced by respective HTML tags (<br/>).

str a string

isCDATA whether the feed uses CDATA for the tag str was read from

containsMarkup whether the feed uses HTML markup in the tag str was read from.

Returns string as HTML (as long as the heuristics work)

Syndication::FeedPtr Syndication::parse(const Syndication::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.

src the document source to parse

formatHint an optional hint which format to test first

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

parses a date string in ISO (see parseISODate()) or RFC 822 (see parseRFCDate()) format.

It tries both parsers and returns the first valid parsing result found (or 0 otherwise).

To speed up parsing, you can give a hint which format you expect. The method will try the corresponding parser first then.

str a date string

hint the expected format

Returns parsed date in seconds since epoch, 0 if no date could be parsed from the string.

uint Syndication::parseISODate(const QString &str)

parses a date string in ISO 8601 extended format. (date: "2003-12-13",datetime: "2003-12-13T18:30:02.25", datetime with timezone: "2003-12-13T18:30:02.25+01:00")

str a string in ISO 8601 format

Returns parsed date in seconds since epoch, 0 if no date could be parsed from the string.

uint Syndication::parseRFCDate(const QString &str)

parses a date string as defined in RFC 822. (Sat, 07 Sep 2002 00:00:01 GMT)

str a string in RFC 822 format

Returns parsed date in seconds since epoch, 0 if no date could be parsed from the string.

Syndication::ParserCollection<Syndication::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();
    ...
}

Syndication::PersonPtr Syndication::personFromString(const QString &str)

Parses a person object from a string by identifying name and email address in the string. Currently detected variants are: "foo@bar.com", "Foo", "Foo <foo@bar.com>", "foo@bar.com (Foo)".

str the string to parse the person from.

Returns a Person object containing the parsed information.

QString Syndication::plainTextToHtml(const QString &plainText)

converts a plain text string to HTML

plainText a string in plain text.

QString Syndication::resolveEntities(const QString &str)

resolves entities to respective unicode chars.

str a string

QString Syndication::slashNamespace()

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

bool Syndication::stringContainsMarkup(const QString &str)

guesses whether a string contains (HTML) markup or not. This implements not an exact check for valid HTML markup, but a simple (and relatively fast) heuristic.

str the string that might or might not contain markup

Returns true if the heuristic thinks it contains markup, false if thinks it is markup-free plain text

QString Syndication::xhtmlNamespace()

QString Syndication::xmlNamespace()