Syndication::RSS2::Source

Search for usage in LXR

Syndication::RSS2::Source Class Reference

#include <source.h>

Inherits Syndication::ElementWrapper.

Public Member Functions

 Source ()
 
 Source (const QDomElement &element)
 
QString debugInfo () const
 
QString source () const
 
QString url () const
 

Detailed Description

Class representing the <source> element in RSS2.

"The purpose of this element is to propagate credit for links, to publicize the sources of news items. It's used in the post command in the Radio UserLand aggregator. It should be generated automatically when forwarding an item from an aggregator to a weblog authoring tool."

Author
Frank Osterfeld

Definition at line 29 of file rss2/source.h.

Constructor & Destructor Documentation

◆ Source() [1/2]

Syndication::RSS2::Source::Source ( )

Default constructor, creates a null object, for which isNull() is true.

Definition at line 17 of file rss2/source.cpp.

◆ Source() [2/2]

Syndication::RSS2::Source::Source ( const QDomElement & element)
explicit

Creates a source object wrapping a <source> XML element.

Parameters
elementThe <source> element to wrap

Definition at line 22 of file rss2/source.cpp.

Member Function Documentation

◆ debugInfo()

QString Syndication::RSS2::Source::debugInfo ( ) const

Returns a description of the object for debugging purposes.

Returns
debug string

Definition at line 37 of file rss2/source.cpp.

◆ source()

QString Syndication::RSS2::Source::source ( ) const

The name of the RSS channel that the item came from, derived from its <title>.

Example: "Tomalak's Realm"

Returns
A string containing the source, or a null string if not set (and for null objects)

Definition at line 27 of file rss2/source.cpp.

◆ url()

QString Syndication::RSS2::Source::url ( ) const

Required attribute, links to the XMLization of the source.

Returns
A URL, or a null string if not set (though required from the spec), and for null objects

Definition at line 32 of file rss2/source.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:39:48 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.