Syndication::Category Class Reference
A category for categorizing items or whole feeds. More...
#include <category.h>
Public Member Functions | |
| virtual | ~Category () |
| virtual QString | debugInfo () const |
| virtual bool | isNull () const =0 |
| virtual QString | label () const =0 |
| virtual QString | scheme () const =0 |
| virtual QString | term () const =0 |
Detailed Description
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().
Definition at line 46 of file category.h.
Constructor & Destructor Documentation
| Syndication::Category::~Category | ( | ) | [virtual] |
destructor
Definition at line 29 of file category.cpp.
Member Function Documentation
| QString Syndication::Category::debugInfo | ( | ) | const [virtual] |
Description of the category for debugging purposes.
- Returns:
- debug string
Definition at line 33 of file category.cpp.
| virtual bool Syndication::Category::isNull | ( | ) | const [pure virtual] |
returns whether this object is a null category
| virtual QString Syndication::Category::label | ( | ) | const [pure virtual] |
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
- Returns:
- the label of this category, or a null string if not specified
| virtual QString Syndication::Category::scheme | ( | ) | const [pure virtual] |
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.
- Returns:
- the scheme this category is part of, or a null string if not specified
| virtual QString Syndication::Category::term | ( | ) | const [pure virtual] |
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
- Returns:
- category term. This string is never empty.
The documentation for this class was generated from the following files:
