/usr/include/syndication/documentvisitor.h is in kdepimlibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | /*
* This file is part of the syndication library
*
* Copyright (C) 2005 Frank Osterfeld <osterfeld@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You must have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#ifndef SYNDICATION_DOCUMENTVISITOR_H
#define SYNDICATION_DOCUMENTVISITOR_H
#include "ksyndication_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
|