• Skip to content
  • Skip to link menu
KDE 4.4 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

Syndication Library

Syndication::Image

Syndication::Image Class Reference

This class represents an image file on the web. More...

#include <image.h>

List of all members.

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 44 of file image.h.


Constructor & Destructor Documentation

Syndication::Image::~Image (  )  [virtual]

destructor

Definition at line 29 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 33 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.)
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.
virtual bool Syndication::Image::isNull (  )  const [pure virtual]

returns whether this image is a null object.

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.
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
virtual QString Syndication::Image::url (  )  const [pure virtual]

the URL of a GIF, JPEG or PNG image

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.

The documentation for this class was generated from the following files:
  • image.h
  • image.cpp

Syndication Library

Skip menu "Syndication Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.2-20100208
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal