File indexing completed on 2024-12-08 12:27:13

 /*
     This file is part of the syndication library
     SPDX-FileCopyrightText: 2006 Frank Osterfeld <osterfeld@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef SYNDICATION_IMAGE_H
 #define SYNDICATION_IMAGE_H
 
 #include <QSharedPointer>
 #include <QString>
 
 #include "syndication_export.h"
 
 namespace Syndication
 {
 class Image;
 //@cond PRIVATE
 typedef QSharedPointer<Image> ImagePtr;
 //@endcond
 
 /**
  * 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
  */
 class SYNDICATION_EXPORT Image
 {
 public:
     /**
      * destructor
      */
     virtual ~Image();
 
     /**
      * returns whether this image is a null object.
      */
     virtual bool isNull() const = 0;
 
     /**
      * the URL of a GIF, JPEG or PNG image
      */
     virtual QString url() const = 0;
 
     /**
      * Describes the image, can be used in the ALT attribute of the
      * HTML &lt;img> tag when the channel is rendered in HTML.
      *
      * @return TODO: specify format
      */
     virtual QString title() const = 0;
 
     /**
      * 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().
      *
      * @return the url the rendered image should link to, or a null string
      * if not specified in the feed.
      */
     virtual QString link() const = 0;
 
     /**
      * optional text that can be included in the TITLE attribute of the link
      * formed around the image in HTML rendering.
      *
      * @return TODO: specify format (HTML etc.)
      */
     virtual QString description() const = 0;
 
     /**
      * The width of the image in pixels.
      *
      * @return image width in pixels or 0 if not specified in the feed.
      */
     virtual uint width() const = 0;
 
     /**
      * The height of the image in pixels
      *
      * @return image height in pixels or 0 of not specified in the feed.
      */
     virtual uint height() const = 0;
 
     /**
      * returns a description of the image for debugging purposes
      *
      * @return debug string
      */
     virtual QString debugInfo() const;
 };
 
 } // namespace Syndication
 
 #endif // SYNDICATION_IMAGE_H