Search for usage in LXR

Syndication::Atom::Category Class Reference

#include <category.h>

Inherits Syndication::ElementWrapper.

Public Member Functions

 Category ()
 Category (const QDomElement &element)
QString debugInfo () const
QString label () const
QString scheme () const
QString term () const

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 or ("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().

Frank Osterfeld

Definition at line 31 of file atom/category.h.

Constructor & Destructor Documentation

◆ Category() [1/2]

Syndication::Atom::Category::Category ( )

creates a null category object.

Definition at line 18 of file atom/category.cpp.

◆ Category() [2/2]

Syndication::Atom::Category::Category ( const QDomElement & element)

creates a Category object wrapping an atom:category element.

elementa DOM element, should be a atom:category element (although not enforced), otherwise this object will not parse anything useful

Definition at line 23 of file atom/category.cpp.

Member Function Documentation

◆ debugInfo()

QString Syndication::Atom::Category::debugInfo ( ) const

description of this category object for debugging purposes

debug string

Definition at line 46 of file atom/category.cpp.

◆ label()

QString Syndication::Atom::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.

the label as plain text (no HTML, "&", "<" etc. are unescaped!), or a null string if not specified

Definition at line 41 of file atom/category.cpp.

◆ scheme()

QString Syndication::Atom::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)

a URI representing the scheme, or a null string if not specified

Definition at line 33 of file atom/category.cpp.

◆ term()

QString Syndication::Atom::Category::term ( ) const

a term describing the category.


the category term as plain text (no HTML, "&", "<" etc. are unescaped!)

Definition at line 28 of file atom/category.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:14:15 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.