Syndication::Atom::Link Class Reference

#include <link.h>

Inherits ElementWrapper.

Public Member Functions
	Link ()
	Link (const QDomElement &element)
QString	debugInfo () const
QString	href () const
QString	hrefLanguage () const
uint	length () const
QString	rel () const
QString	title () const
QString	type () const

Detailed Description

A link, pointing to webpages, media files on the web ("podcast"), related content, etc.

See rel() for details.

Author

Frank Osterfeld

Definition at line 39 of file link.h.

Constructor & Destructor Documentation

Syndication::Atom::Link::Link

(

)

creates a null link object.

Definition at line 31 of file link.cpp.

Syndication::Atom::Link::Link ( const QDomElement &  element )

explicit

creates a Link object wrapping an atom:link element.

Parameters

element

a DOM element, should be a atom:link element (although not enforced), otherwise this object will not parse anything useful

Definition at line 35 of file link.cpp.

Member Function Documentation

QString Syndication::Atom::Link::debugInfo

(

)

const

description of the link object for debugging purposes

Returns

debug string

Definition at line 74 of file link.cpp.

QString Syndication::Atom::Link::href

(

)

const

URL of the referenced resource (required)

Definition at line 39 of file link.cpp.

QString Syndication::Atom::Link::hrefLanguage

(

)

const

the language of the linked resource.

(optional) If used together with a rel() value of "alternate", it implies a translated version of the entry.

Returns

a language tag as defined in RFC 3066, or a null string if not specified

Definition at line 55 of file link.cpp.

uint Syndication::Atom::Link::length

(

)

const

size of the linked resource in bytes.

(optional)

Returns

file size in bytes, or 0 if not specified

Definition at line 65 of file link.cpp.

QString Syndication::Atom::Link::rel

(

)

const

the relation between the feed/entry and the linked resource.

The value of rel() is usually one of the following:

"alternate": The URL points to an alternate version of the feed/entry. In practice, this is the article described in an entry, or the homepage of the feed.

"enclosure": The link describes an Enclosure. See Syndication::Enclosure for more information.

"related": links to web resources with related content. E.g., an article discussing KDE might link to the KDE homepage.

"self": "identifies a resource equivalent to the containing element". This is usually the URL of the feed source itself.

"via": The link points to the source of the information contained in the feed/entry

Returns

the rel value specified in the feed. Default value is "alternate"

Definition at line 44 of file link.cpp.

QString Syndication::Atom::Link::title

(

)

const

human-readable information about the link.

(optional)

Returns

the link title as plain text ("<", "&" are text, not markup!), or a null string if not specified

Definition at line 60 of file link.cpp.

QString Syndication::Atom::Link::type

(

)

const

MIME type of the linked resource.

(optional)

Returns

MIME type following (e.g., "text/html", "audio/mpeg"), or a null string if not set

Definition at line 50 of file link.cpp.

---

The documentation for this class was generated from the following files:

• link.h
• link.cpp