Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / akregator / src / librss

akregator/src/librss RSS::Image Class Reference #include <image.h> List of all members. Detailed Description Represents an image as stored in a RSS file. You don't have to instantiate one of these yourself, the common way to access instances is via Document::image(). See also: Document::image() Definition at line 34 of file image.h. Signals void  gotPixmap (const QPixmap &pixmap) Public Member Functions   Image ()   Image (const Image &other)   Image (const QDomNode &node) Image &  operator= (const Image &other) bool  operator== (const Image &other) const bool  operator!= (const Image &other) const virtual  ~Image () QString  title () const const KURL &  url () const const KURL &  link () const QString  description () const unsigned int  height () const unsigned int  width () const void  getPixmap () void  abort () Constructor & Destructor Documentation RSS::Image::Image (   )    Default constructor. RSS::Image::Image (  const Image &  other  )    Copy constructor. Parameters: other  The Image object to copy. RSS::Image::Image (  const QDomNode &  node  )    Constructs an Image from a piece of RSS markup. Parameters: node  A QDomNode which references the DOM leaf to be used for constructing the Image. virtual RSS::Image::~Image (   )  [virtual]   Destructor. Member Function Documentation QString RSS::Image::description (   )  const   RSS 0.91 and upwards. Returns: A description of what this picture shows, or QString::null if no description is available. Useful for people who deactivated images but want or need to know what is shown. void RSS::Image::getPixmap (   )    Makes the image download the image data as referenced by the URL returned by url(). You have to connect to the signal gotPixmap() first and then call getPixmap(). void RSS::Image::gotPixmap (  const QPixmap &  pixmap  )  [signal]   Emitted when this Image is done downloading the actual graphics data as referenced by the URL returned by url(). You can trigger this download by calling getPixmap(). Parameters: pixmap  The pixmap as constructed from the data referenced by the URL returned by link(). unsigned int RSS::Image::height (   )  const   RSS 0.91 and upwards. Returns: The height in pixels as reported by the news site, the default value is 31 pixels. The RSS 0.91 Specification requires this value to be between 1 and 400. '0' if this information isn't available. This is merely provided for completeness, you should not rely on this value but rather check what height the QPixmap as returned by gotPixmap() reports. const KURL& RSS::Image::link (   )  const   RSS 0.90 and upwards. Returns: A link to some resource, or an empty KURL of no link is available. Clicking on the image should lead the user to the resource referenced by this URL. Note that the RSS 0.91 Specification dictates that URLs not starting with "http://" or "ftp://" are considered invalid. bool RSS::Image::operator!= (  const Image &  other  )  const [inline]   Convenience method. Simply calls !operator==(). Parameters: other  The image to compared with. Returns: Whether the two images are unequal. Definition at line 77 of file image.h. Image& RSS::Image::operator= (  const Image &  other  )    Assignment operator. Parameters: other  The Image object to clone. Returns: A reference to the cloned Image object. bool RSS::Image::operator== (  const Image &  other  )  const   Compares two images. Two images are considered identical if their properties (title, description, link etc.) are identical. Note that this does not include the actual pixmap data! Parameters: other  The image to compare with. Returns: Whether the two images are equal. QString RSS::Image::title (   )  const   RSS 0.90 and upwards. Returns: The 'caption' of this image, or QString::null if no caption is available. const KURL& RSS::Image::url (   )  const   RSS 0.90 and upwards. Returns: The URL pointing to the file containing the graphic data (GIF, JPEG or PNG format), or an empty KURL if no URL is available. You can use getPixmap() and gotPixmap() to have the Image download the pixmap data itself. Note that the RSS 0.91 Specification dictates that URLs not starting with "http://" or "ftp://" are considered invalid. unsigned int RSS::Image::width (   )  const   RSS 0.91 and upwards. Returns: The width in pixels as reported by the news site, the default value is 88 pixels. The RSS 0.91 Specification requires this value to be between 1 and 144. This is merely provided for completeness, you should not rely on this value but rather check what width the QPixmap as returned by gotPixmap() reports. The documentation for this class was generated from the following file: image.h

akregator/src/librss Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Directories Namespace Members Class Members API Dox akregator   src     librss certmanager   lib kaddressbook kalarm   lib kandy karm kdgantt kgantt kioslaves   imap4   mbox kitchensync kmail knotes konsolekalendar kontact korganizer kpilot   kpilot   lib libemailfunctions libkcal libkdepim libkholidays libkmime libkpgp libkpimidentities

KDE Home | KDE Accessibility Home | Description of Access Keys

Maintained by Adriaan de Groot and Allen Winter.
KDE and K Desktop Environment are trademarks of KDE e.V. | Legal