Syndication::CategoryAtomImpl

Syndication::CategoryAtomImpl Class Reference

#include <categoryatomimpl.h>

Inheritance diagram for Syndication::CategoryAtomImpl:

Public Member Functions

 CategoryAtomImpl (const Syndication::Atom::Category &category)
 
bool isNull () const override
 
QString label () const override
 
QString scheme () const override
 
QString term () const override
 
- Public Member Functions inherited from Syndication::Category
virtual ~Category ()
 
virtual QString debugInfo () const
 

Detailed Description

Author
Frank Osterfeld

Definition at line 40 of file categoryatomimpl.h.

Member Function Documentation

bool Syndication::CategoryAtomImpl::isNull ( ) const
overridevirtual

returns whether this object is a null category

Implements Syndication::Category.

Definition at line 34 of file categoryatomimpl.cpp.

QString Syndication::CategoryAtomImpl::label ( ) const
overridevirtual

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

Implements Syndication::Category.

Definition at line 49 of file categoryatomimpl.cpp.

QString Syndication::CategoryAtomImpl::scheme ( ) const
overridevirtual

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

Implements Syndication::Category.

Definition at line 44 of file categoryatomimpl.cpp.

QString Syndication::CategoryAtomImpl::term ( ) const
overridevirtual

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.

Implements Syndication::Category.

Definition at line 39 of file categoryatomimpl.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jul 9 2020 23:01:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.