Syndication::Image Class

class Syndication::Image

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

Header: #include <Syndication/Image>
CMake: find_package(KF6 REQUIRED COMPONENTS Syndication)
target_link_libraries(mytarget PRIVATE KF6::Syndication)

Public Functions

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

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

Member Function Documentation

[virtual] QString Image::debugInfo() const

returns a description of the image for debugging purposes

[pure virtual] QString Image::description() const

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

[pure virtual] uint Image::height() const

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

[pure virtual] bool Image::isNull() const

returns whether this image is a null object.

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.

[pure virtual] QString 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.

[pure virtual] QString Image::url() const

the URL of a GIF, JPEG or PNG image

[pure virtual] uint Image::width() const

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