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 24 of file categoryatomimpl.h.

Constructor & Destructor Documentation

CategoryAtomImpl()

Syndication::CategoryAtomImpl::CategoryAtomImpl ( const Syndication::Atom::Category & category )

explicit

Definition at line 14 of file categoryatomimpl.cpp.

Member Function Documentation

isNull()

bool Syndication::CategoryAtomImpl::isNull ( ) const

overridevirtual

returns whether this object is a null category

Implements Syndication::Category.

Definition at line 19 of file categoryatomimpl.cpp.

label()

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 34 of file categoryatomimpl.cpp.

scheme()

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 unambiguously 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 29 of file categoryatomimpl.cpp.

term()

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 24 of file categoryatomimpl.cpp.

---

The documentation for this class was generated from the following files:

• categoryatomimpl.h
• categoryatomimpl.cpp