kde-playground/kdepimlibs/syndication/specificitem.h
2015-04-14 21:49:29 +00:00

75 lines
2 KiB
C++

/*
* This file is part of the syndication library
*
* Copyright (C) 2006 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 should 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_SPECIFICITEM_H
#define SYNDICATION_SPECIFICITEM_H
#include "ksyndication_export.h"
#include <boost/shared_ptr.hpp>
namespace Syndication {
class SpecificItemVisitor;
class SpecificItem;
//@cond PRIVATE
typedef boost::shared_ptr<SpecificItem> SpecificItemPtr;
//@endcond
/**
* Interface for all format-specific item-like classes, such as
* RSS2/RDF items, and Atom entries. To process items based on their
* format, use a SpecificItemVisitor.
*
* @author Frank Osterfeld
*/
class SYNDICATION_EXPORT SpecificItem
{
public:
/**
* virtual dtor
*/
virtual ~SpecificItem();
/**
* This must be implemented for the double dispatch
* technique (Visitor pattern).
*
* The usual implementation is
* @code
* return visitor->visit(this);
* @endcode
*
* See also SpecificItemVisitor.
*
* @param visitor the visitor "visiting" this object
*/
virtual bool accept(SpecificItemVisitor* visitor) = 0;
};
} // namespace Syndication
#endif // SYNDICATION_SPECIFICITEM_H