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

Syndication Library

  • Syndication
  • SpecificDocument
Public Member Functions
Syndication::SpecificDocument Class Reference

#include <specificdocument.h>

List of all members.

Public Member Functions

virtual ~SpecificDocument ()
virtual bool accept (DocumentVisitor *visitor)=0
virtual QString debugInfo () const =0
virtual bool isValid () const =0

Detailed Description

Document interface for format-specific feed documents as parsed from a document source (see DocumentSource).

The Document classes from the several syndication formats must implement this interface. It's main purpose is to provide access for document visitors (see DocumentVisitor). Usually it is not necessary to access the format-specific document at all, use Feed for a format-agnostic interface to all feed documents supported by the library.

Author:
Frank Osterfeld

Constructor & Destructor Documentation

Syndication::SpecificDocument::~SpecificDocument ( ) [virtual]

virtual dtor

Definition at line 27 of file specificdocument.cpp.


Member Function Documentation

virtual bool Syndication::SpecificDocument::accept ( DocumentVisitor *  visitor) [pure virtual]

This must be implemented for the double dispatch technique (Visitor pattern).

The usual implementation is

 return visitor->visit(this);

See also DocumentVisitor.

Parameters:
visitorthe visitor "visiting" this object
virtual QString Syndication::SpecificDocument::debugInfo ( ) const [pure virtual]

Returns a description of the document for debugging purposes.

Returns:
debug string
virtual bool Syndication::SpecificDocument::isValid ( ) const [pure virtual]

Returns whether this document is valid or not.

Invalid documents do not contain any useful information.


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

Syndication Library

Skip menu "Syndication Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • 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.5
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