• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.5 API Reference
  • KDE Home
  • Contact Us
 

Syndication Library

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

#include <documentvisitor.h>

List of all members.

Public Member Functions

virtual ~DocumentVisitor ()
virtual bool visit (SpecificDocument *document)
virtual bool visitAtomEntryDocument (Syndication::Atom::EntryDocument *document)
virtual bool visitAtomFeedDocument (Syndication::Atom::FeedDocument *document)
virtual bool visitRDFDocument (Syndication::RDF::Document *document)
virtual bool visitRSS2Document (Syndication::RSS2::Document *document)

Detailed Description

Visitor interface, following the Visitor design pattern.

Use this if you want to process documents and the way how to handle the document depends on it's concrete type (e.g. RSS2::Document, RDF::Document...).

TODO: insert code example

Author:
Frank Osterfeld

Constructor & Destructor Documentation

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

destructor

Definition at line 29 of file documentvisitor.cpp.


Member Function Documentation

bool Syndication::DocumentVisitor::visit ( SpecificDocument *  document) [virtual]

call this method to handle a document.

Depending on the concrete type of the document, a specialized visit method is called.

Parameters:
documentthe document to process
Returns:
whether this visitor handles the type of the document.

Definition at line 33 of file documentvisitor.cpp.

bool Syndication::DocumentVisitor::visitAtomEntryDocument ( Syndication::Atom::EntryDocument *  document) [virtual]

reimplement this method to handle Atom entry documents.

Parameters:
documentthe atom entry document to visit
Returns:
whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 53 of file documentvisitor.cpp.

bool Syndication::DocumentVisitor::visitAtomFeedDocument ( Syndication::Atom::FeedDocument *  document) [virtual]

reimplement this method to handle Atom feed documents (most Atom feeds are of this type).

Parameters:
documentthe atom feed document to visit
Returns:
whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 48 of file documentvisitor.cpp.

bool Syndication::DocumentVisitor::visitRDFDocument ( Syndication::RDF::Document *  document) [virtual]

reimplement this method to handle RDF (i.e.

RSS 1.0) documents.

Parameters:
documentthe RDF document to visit
Returns:
whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 43 of file documentvisitor.cpp.

bool Syndication::DocumentVisitor::visitRSS2Document ( Syndication::RSS2::Document *  document) [virtual]

reimplement this method to handle RSS2-like (RSS 0.9x, 2.0) documents.

Parameters:
documentthe RSS2 document to visit
Returns:
whether the visitor handled the document. Reimplementations of this method must return true.

Definition at line 38 of file documentvisitor.cpp.


The documentation for this class was generated from the following files:
  • documentvisitor.h
  • documentvisitor.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:24:48 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Syndication Library

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

kdepimlibs-4.8.5 API Reference

Skip menu "kdepimlibs-4.8.5 API Reference"
  • 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
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal