File indexing completed on 2024-04-14 03:58:29

 /*
     This file is part of the syndication library
     SPDX-FileCopyrightText: 2005 Frank Osterfeld <osterfeld@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef SYNDICATION_DOCUMENTVISITOR_H
 #define SYNDICATION_DOCUMENTVISITOR_H
 
 #include "syndication_export.h"
 
 namespace Syndication
 {
 class SpecificDocument;
 
 namespace Atom
 {
 class EntryDocument;
 class FeedDocument;
 }
 
 namespace RDF
 {
 class Document;
 }
 
 namespace RSS2
 {
 class Document;
 }
 
 /**
  * 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
  */
 class SYNDICATION_EXPORT DocumentVisitor // krazy:exclude=dpointer
 {
 public:
     /**
      * destructor
      */
     virtual ~DocumentVisitor();
 
     /**
      * call this method to handle a document. Depending on the concrete type
      * of the document, a specialized visit method is called.
      *
      * @param document the document to process
      * @return whether this visitor handles the type of the document.
      */
     virtual bool visit(SpecificDocument *document);
 
     /**
      * reimplement this method to handle RSS2-like (RSS 0.9x, 2.0) documents.
      *
      * @param document the RSS2 document to visit
      * @return whether the visitor handled the document.
      * Reimplementations of this method must return @c true.
      */
     virtual bool visitRSS2Document(Syndication::RSS2::Document *document);
 
     /**
      * reimplement this method to handle RDF (i.e. RSS 1.0) documents.
      *
      * @param document the RDF document to visit
      * @return whether the visitor handled the document.
      * Reimplementations of this method must return @c true.
      */
     virtual bool visitRDFDocument(Syndication::RDF::Document *document);
 
     /**
      * reimplement this method to handle Atom feed documents (most Atom
      * feeds are of this type).
      *
      * @param document the atom feed document to visit
      * @return whether the visitor handled the document.
      * Reimplementations of this method must return @c true.
      */
     virtual bool visitAtomFeedDocument(Syndication::Atom::FeedDocument *document);
 
     /**
      * reimplement this method to handle Atom entry documents.
      *
      * @param document the atom entry document to visit
      * @return whether the visitor handled the document.
      * Reimplementations of this method must return @c true.
      */
     virtual bool visitAtomEntryDocument(Syndication::Atom::EntryDocument *document);
 };
 
 } // namespace Syndication
 
 #endif // SYNDICATION_DOCUMENTVISITOR_H