mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-23 18:32:51 +00:00
104 lines
3.5 KiB
C++
104 lines
3.5 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_CATEGORY_H
|
|
#define SYNDICATION_CATEGORY_H
|
|
|
|
#include <QtCore/QString>
|
|
#include <boost/shared_ptr.hpp>
|
|
|
|
#include "ksyndication_export.h"
|
|
|
|
namespace Syndication {
|
|
|
|
class Category;
|
|
typedef boost::shared_ptr<Category> CategoryPtr;
|
|
|
|
/**
|
|
* A category for categorizing items or whole feeds.
|
|
* A category can be an informal string set by the feed author ("General",
|
|
* "Stuff I like"), a tag assigned by readers, as known from flickr.com
|
|
* or de.licio.us ("KDE", "funny"), or a term from a formally defined ontology.
|
|
*
|
|
* To represent the category in a user interface, use label() (or term() as
|
|
* fallback). To create a key for e.g. storage purposes, use scheme() + term().
|
|
*
|
|
* @author Frank Osterfeld
|
|
*/
|
|
class SYNDICATION_EXPORT Category
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* destructor
|
|
*/
|
|
virtual ~Category();
|
|
|
|
/**
|
|
* returns whether this object is a null category
|
|
*/
|
|
virtual bool isNull() const = 0;
|
|
|
|
|
|
/**
|
|
* A term identifying the category, e.g. "general", "life", "books"
|
|
* or "Basketball & other sport I like".
|
|
* The term must be unique in its scheme (see scheme()).
|
|
*
|
|
* In user interfaces, use it only if there is no label() available.
|
|
* TODO: specify format (HTML, plain text?) and enforce it in the impl
|
|
* @return category term. This string is never empty.
|
|
*/
|
|
virtual QString term() const = 0;
|
|
|
|
/**
|
|
* An optional scheme the term is part of. This can be some
|
|
* vocabulary/ontology such as Dublin Core.
|
|
* Think of it as the term's namespace, grouping a set of categories.
|
|
* When managing categories, scheme() + term() identifies a category
|
|
* unambigously and can be used as key.
|
|
*
|
|
* @return the scheme this category is part of, or a null string
|
|
* if not specified
|
|
*/
|
|
virtual QString scheme() const = 0;
|
|
|
|
/**
|
|
* An optional human-readable label of the category. If specified, this
|
|
* string should be used to represent this category in a user interface.
|
|
* If not specified, use term() instead.
|
|
* TODO: specify format (HTML, plain text?) and enforce it in the impl
|
|
* @return the label of this category, or a null string if not specified
|
|
*/
|
|
virtual QString label() const = 0;
|
|
|
|
/**
|
|
* Description of the category for debugging purposes.
|
|
*
|
|
* @return debug string
|
|
*/
|
|
virtual QString debugInfo() const;
|
|
};
|
|
|
|
} // namespace Syndication
|
|
|
|
#endif // SYNDICATION_CATEGORY_H
|