/usr/include/KF5/Syndication/syndication/category.h is in libkf5syndication-dev 15.12.3-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 | /*
* 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/QSharedPointer>
#include <QtCore/QString>
#include "syndication_export.h"
namespace Syndication
{
class Category;
typedef QSharedPointer<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
|