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

syndication/atom

Syndication::Atom::Source

Syndication::Atom::Source Class Reference

If an entry was copied from another feed, this class contains a description of the source feed. More...

#include <source.h>

Inherits ElementWrapper.

List of all members.

Public Member Functions

 Source (const QDomElement &element)
 Source ()
QList< Person > authors () const
QList< Category > categories () const
QList< Person > contributors () const
QString debugInfo () const
Generator generator () const
QString icon () const
QString id () const
QList< Link > links () const
QString logo () const
QString rights () const
QString subtitle () const
QString title () const
time_t updated () const

Detailed Description

If an entry was copied from another feed, this class contains a description of the source feed.

Author:
Frank Osterfeld

Definition at line 49 of file source.h.


Constructor & Destructor Documentation

Syndication::Atom::Source::Source (  ) 

creates a null source object

Definition at line 40 of file source.cpp.

Syndication::Atom::Source::Source ( const QDomElement &  element  )  [explicit]

creates a Source object wrapping a atom:source element.

Parameters:
element a DOM element, should be a atom:source element (although not enforced), otherwise this object will not parse anything useful

Definition at line 44 of file source.cpp.


Member Function Documentation

QList< Person > Syndication::Atom::Source::authors (  )  const

authors of the original content (optional)

Definition at line 48 of file source.cpp.

QList< Category > Syndication::Atom::Source::categories (  )  const

categories the source feed is assigned to (optional)

Definition at line 86 of file source.cpp.

QList< Person > Syndication::Atom::Source::contributors (  )  const

contributors to the original content (optional)

Definition at line 67 of file source.cpp.

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

description of this source object for debugging purposes

Returns:
debug string

Definition at line 170 of file source.cpp.

Generator Syndication::Atom::Source::generator (  )  const

description of the software which generated the source feed (optional)

Definition at line 105 of file source.cpp.

QString Syndication::Atom::Source::icon (  )  const

URL of an image serving as a feed icon (optional).

Returns:
icon URL, or a null string if not specified

Definition at line 111 of file source.cpp.

QString Syndication::Atom::Source::id (  )  const

a string that unambigously identifies the source feed (optional)

Returns:
the ID of the source feed, or a null string if not specified.

Definition at line 117 of file source.cpp.

QList< Link > Syndication::Atom::Source::links (  )  const

a list of links.

See Link for more information on link types.

Definition at line 123 of file source.cpp.

QString Syndication::Atom::Source::logo (  )  const

URL of an image, the logo of the source feed (optional).

Returns:
image URL, or a null string if not specified in the feed.

Definition at line 142 of file source.cpp.

QString Syndication::Atom::Source::rights (  )  const

copyright information (optional)

Returns:
copyright information for the source, or a null string if not specified

Definition at line 148 of file source.cpp.

QString Syndication::Atom::Source::subtitle (  )  const

description or subtitle of the source feed (optional).

Returns:
subtitle string as HTML, or a null string if not specified.

Definition at line 153 of file source.cpp.

QString Syndication::Atom::Source::title (  )  const

source feed title (optional).

Returns:
title string as HTML, or a null string if not specified

Definition at line 158 of file source.cpp.

time_t Syndication::Atom::Source::updated (  )  const

The datetime of the last modification of the source feed content.

(optional)

Returns:
the modification date in seconds since epoch

Definition at line 163 of file source.cpp.


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

syndication/atom

Skip menu "syndication/atom"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

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.1
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