Syndication::DocumentVisitor Class
Visitor interface, following the Visitor design pattern. More...
- Header:
#include <Syndication/DocumentVisitor> - CMake:
find_package(KF6 REQUIRED COMPONENTS Syndication)
target_link_libraries(mytarget PRIVATE KF6::Syndication)
List of all members, including inherited members
Public Functions
- bool visit(Syndication::SpecificDocument *document)
- bool visitAtomEntryDocument(Syndication::Atom::EntryDocument *document)
- bool visitAtomFeedDocument(Syndication::Atom::FeedDocument *document)
- bool visitRDFDocument(Syndication::RDF::Document *document)
- bool visitRSS2Document(Syndication::RSS2::Document *document)
Detailed Description
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
Member Function Documentation
[virtual] bool DocumentVisitor::visit(Syndication::SpecificDocument *document)
Call this method to handle a document. Depending on the concrete type of the document, a specialized visit method is called.
document the document to process
Returns whether this visitor handles the type of the document.
[virtual] bool DocumentVisitor::visitAtomEntryDocument(Syndication::Atom::EntryDocument *document)
Reimplement this method to handle Atom entry documents.
document the atom entry document to visit
Returns whether the visitor handled the document.
Reimplementations of this method must return true.
[virtual] bool DocumentVisitor::visitAtomFeedDocument(Syndication::Atom::FeedDocument *document)
Reimplement this method to handle Atom feed documents (most Atom feeds are of this type).
document the atom feed document to visit
Returns whether the visitor handled the document.
Reimplementations of this method must return true.
[virtual] bool DocumentVisitor::visitRDFDocument(Syndication::RDF::Document *document)
Reimplement this method to handle RDF (i.e. RSS 1.0) documents.
document the RDF document to visit
Returns whether the visitor handled the document.
Reimplementations of this method must return true.
[virtual] bool DocumentVisitor::visitRSS2Document(Syndication::RSS2::Document *document)
Reimplement this method to handle RSS2-like (RSS 0.9x, 2.0) documents.
document the RSS2 document to visit
Returns whether the visitor handled the document.
Reimplementations of this method must return true.