Syndication::RSS2::Image Class Reference

#include <image.h>

Inherits Syndication::ElementWrapper.

Public Member Functions
	Image ()
	Image (const QDomElement &element)
QString	debugInfo () const
QString	description () const
uint	height () const
QString	link () const
QString	title () const
QString	url () const
uint	width () const

Detailed Description

An RSS2 image, used to describe feed logos.

Definition at line 23 of file rss2/image.h.

Constructor & Destructor Documentation

Image() [1/2]

Syndication::RSS2::Image::Image

(

)

Default constructor, creates a null object, for which isNull() is true.

Definition at line 16 of file rss2/image.cpp.

Image() [2/2]

Syndication::RSS2::Image::Image ( const QDomElement & element )

explicit

Creates an Image object wrapping an <image> XML element.

Parameters

element

The <image> element to wrap

Definition at line 21 of file rss2/image.cpp.

Member Function Documentation

debugInfo()

QString Syndication::RSS2::Image::debugInfo

(

)

const

Returns a description of the object for debugging purposes.

Returns

debug string

Definition at line 68 of file rss2/image.cpp.

description()

QString Syndication::RSS2::Image::description

(

)

const

optional text that can be included in the TITLE attribute of the link formed around the image in HTML rendering.

Returns

TODO: specify format (HTML etc.)

Definition at line 63 of file rss2/image.cpp.

height()

uint Syndication::RSS2::Image::height

(

)

const

The height of the image.

If the feed itself doesn't specify a height, this method returns 31, the default value.

Returns

image height in pixels.

Definition at line 52 of file rss2/image.cpp.

link()

QString Syndication::RSS2::Image::link

(

)

const

The URL of the site, when the channel is rendered, the image should be a link to the site.

Definition at line 36 of file rss2/image.cpp.

title()

QString Syndication::RSS2::Image::title

(

)

const

Describes the image, can be used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.

Returns

TODO: specify format

Definition at line 31 of file rss2/image.cpp.

url()

QString Syndication::RSS2::Image::url

(

)

const

the URL of a GIF, JPEG or PNG image

Definition at line 26 of file rss2/image.cpp.

width()

uint Syndication::RSS2::Image::width

(

)

const

The width of the image.

If the feed itself doesn't specify a width, this method returns 88, the default value.

Returns

image width in pixels.

Definition at line 41 of file rss2/image.cpp.

---

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

• rss2/image.h
• rss2/image.cpp