Syndication::Atom::Category Class
class Syndication::Atom::CategoryA category for categorizing items or whole feeds. More...
| Header: | #include <Syndication/Atom/Category> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS Syndication)target_link_libraries(mytarget PRIVATE KF6::Syndication) |
| Inherits: | Syndication::ElementWrapper |
Public Functions
| Category() | |
| Category(const QDomElement &element) | |
| QString | debugInfo() const |
| QString | label() const |
| QString | scheme() const |
| QString | term() const |
Detailed Description
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().
Member Function Documentation
Category::Category()
creates a null category object.
[explicit] Category::Category(const QDomElement &element)
creates a Category object wrapping an atom:category element.
element a DOM element, should be a atom:category element (although not enforced), otherwise this object will not parse anything useful
QString Category::debugInfo() const
description of this category object for debugging purposes
QString Category::label() const
Label of the category (optional).
If specified, this string should be used to represent this category in a user interface.
If not specified, use term() instead.
Returns the label as plain text (no HTML, "&", "<" etc. are unescaped!), or a null string if not specified
QString Category::scheme() const
naming scheme the category term is part of. (optional)
A term is unique in its scheme (like in C++ identifiers are unique in their namespaces)
Returns a URI representing the scheme, or a null string if not specified
QString Category::term() const
a term describing the category. (required)
Returns the category term as plain text (no HTML, "&", "<" etc. are unescaped!)