Syndication::Atom::Category

Syndication::Atom::Category Class Reference

#include <category.h>

Inheritance diagram for Syndication::Atom::Category:

Public Member Functions

 Category ()
 
 Category (const QDomElement &element)
 
QString debugInfo () const
 
QString label () const
 
QString scheme () const
 
QString term () const
 
- Public Member Functions inherited from Syndication::ElementWrapper
 ElementWrapper ()
 
 ElementWrapper (const ElementWrapper &other)
 
 ElementWrapper (const QDomElement &element)
 
virtual ~ElementWrapper ()
 
QString attribute (const QString &name, const QString &defValue=QString()) const
 
QString attributeNS (const QString &nsURI, const QString &localName, const QString &defValue=QString()) const
 
QString childNodesAsXML () const
 
QString completeURI (const QString &uri) const
 
const QDomElementelement () const
 
QList< QDomElementelementsByTagName (const QString &tagName) const
 
QList< QDomElementelementsByTagNameNS (const QString &nsURI, const QString &tagName) const
 
QString extractElementText (const QString &tagName) const
 
QString extractElementTextNS (const QString &namespaceURI, const QString &localName) const
 
QDomElement firstElementByTagNameNS (const QString &nsURI, const QString &tagName) const
 
bool hasAttribute (const QString &name) const
 
bool hasAttributeNS (const QString &nsURI, const QString &localName) const
 
bool isNull () const
 
ElementWrapperoperator= (const ElementWrapper &other)
 
bool operator== (const ElementWrapper &other) const
 
QString text () const
 
QString xmlBase () const
 
QString xmlLang () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Syndication::ElementWrapper
static QString childNodesAsXML (const QDomElement &parent)
 

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

Author
Frank Osterfeld

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

Constructor & Destructor Documentation

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

creates a null category object.

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

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

creates a Category object wrapping an atom:category element.

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

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

Member Function Documentation

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

description of this category object for debugging purposes

Returns
debug string

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

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.

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

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

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)

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

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

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

a term describing the category.

(required)

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

Definition at line 42 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-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.