• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

syndication/rdf

  • Syndication
  • RDF
  • Document
Public Member Functions
Syndication::RDF::Document Class Reference

#include <document.h>

Inheritance diagram for Syndication::RDF::Document:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Document ()
 Document (ResourcePtr resource)
 Document (const Document &other)
virtual ~Document ()
virtual bool accept (DocumentVisitor *visitor)
DublinCore dc () const
virtual PRIVATE QString debugInfo () const
QString description () const
Image image () const
bool isValid () const
QList< Item > items () const
QString link () const
Document & operator= (const Document &other)
bool operator== (const Document &other) const
SyndicationInfo syn () const
TextInput textInput () const
QString title () const

Detailed Description

Document implementation for RDF, representing an RSS 1.0 feed.

Author:
Frank Osterfeld

Definition at line 51 of file document.h.


Constructor & Destructor Documentation

Syndication::RDF::Document::Document ( )

creates a wrapper wrapping a null resource

Definition at line 62 of file document.cpp.

Syndication::RDF::Document::Document ( ResourcePtr  resource) [explicit]

creates a document by wrapping a channel resource

Parameters:
resourcethe channel resource to wrap

Definition at line 69 of file document.cpp.

Syndication::RDF::Document::Document ( const Document &  other)

creates a copy of another document

Parameters:
otherthe document to copy

Definition at line 76 of file document.cpp.

Syndication::RDF::Document::~Document ( ) [virtual]

destructor

Definition at line 82 of file document.cpp.


Member Function Documentation

bool Syndication::RDF::Document::accept ( DocumentVisitor *  visitor) [virtual]

Used by visitors for double dispatch.

See DocumentVisitor for more information.

Parameters:
visitorthe visitor calling the method

Definition at line 103 of file document.cpp.

DublinCore Syndication::RDF::Document::dc ( ) const

returns a dublin core description of the document.

Definition at line 131 of file document.cpp.

QString Syndication::RDF::Document::debugInfo ( ) const [virtual]

Returns a description of the document for debugging purposes.

Returns:
debug string

Definition at line 255 of file document.cpp.

QString Syndication::RDF::Document::description ( ) const

A brief description of the channel's content, function, source, etc.

Returns:
TODO: define format etc.

Definition at line 120 of file document.cpp.

Image Syndication::RDF::Document::image ( ) const

An image to be associated with an HTML rendering of the channel.

Definition at line 175 of file document.cpp.

bool Syndication::RDF::Document::isValid ( ) const

returns whether this document is valid or not.

Invalid documents do not contain any useful information.

Definition at line 108 of file document.cpp.

QList< Item > Syndication::RDF::Document::items ( ) const

list of items contained in this feed

Definition at line 141 of file document.cpp.

QString Syndication::RDF::Document::link ( ) const

The URL to which an HTML rendering of the channel title will link, commonly the parent site's home or news page.

Definition at line 126 of file document.cpp.

Document & Syndication::RDF::Document::operator= ( const Document &  other)

assigns another document

Parameters:
otherthe document to assign

Definition at line 94 of file document.cpp.

bool Syndication::RDF::Document::operator== ( const Document &  other) const

compares two documents.

Two documents are equal if they wrap the same resource. See ResourceWrapper::operator==()

Parameters:
otherthe document to compare to

Definition at line 88 of file document.cpp.

SyndicationInfo Syndication::RDF::Document::syn ( ) const

returns syndication information describing how often this feed is updated.

Definition at line 136 of file document.cpp.

TextInput Syndication::RDF::Document::textInput ( ) const

An optional text input element associated with the channel.

Definition at line 182 of file document.cpp.

QString Syndication::RDF::Document::title ( ) const

title of the feed (required)

Returns:
feed title as TODO: define format

Definition at line 113 of file document.cpp.


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

syndication/rdf

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.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