Syndication::Image

Syndication::Image Class Referenceabstract

#include <image.h>

Inheritance diagram for Syndication::Image:

Public Member Functions

virtual ~Image ()
 
virtual QString debugInfo () const
 
virtual QString description () const =0
 
virtual uint height () const =0
 
virtual bool isNull () const =0
 
virtual QString link () const =0
 
virtual QString title () const =0
 
virtual QString url () const =0
 
virtual uint width () const =0
 

Detailed Description

This class represents an image file on the web.

It is usually some kind of feed logo which can be displayed when showing the feed description.

Author
Frank Osterfeld

Definition at line 46 of file image.h.

Constructor & Destructor Documentation

Syndication::Image::~Image ( )
virtual

destructor

Definition at line 30 of file image.cpp.

Member Function Documentation

QString Syndication::Image::debugInfo ( ) const
virtual

returns a description of the image for debugging purposes

Returns
debug string

Definition at line 34 of file image.cpp.

virtual QString Syndication::Image::description ( ) const
pure virtual

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.)

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.

virtual uint Syndication::Image::height ( ) const
pure virtual

The height of the image in pixels.

Returns
image height in pixels or 0 of not specified in the feed.

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.

virtual bool Syndication::Image::isNull ( ) const
pure virtual

returns whether this image is a null object.

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.

virtual QString Syndication::Image::link ( ) const
pure virtual

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

If not set, use Feed::link().

Returns
the url the rendered image should link to, or a null string if not specified in the feed.

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.

virtual QString Syndication::Image::title ( ) const
pure virtual

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

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.

virtual QString Syndication::Image::url ( ) const
pure virtual

the URL of a GIF, JPEG or PNG image

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.

virtual uint Syndication::Image::width ( ) const
pure virtual

The width of the image in pixels.

Returns
image width in pixels or 0 if not specified in the feed.

Implemented in Syndication::ImageAtomImpl, Syndication::ImageRDFImpl, and Syndication::ImageRSS2Impl.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jul 9 2020 23:01:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.