• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

syndication/atom

Syndication::Atom::Category

Syndication::Atom::Category Class Reference

A category for categorizing items or whole feeds. More...

#include <category.h>

Inherits Syndication::ElementWrapper.

List of all members.


Public Member Functions

 Category (const QDomElement &element)
 Category ()
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 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 45 of file category.h.


Constructor & Destructor Documentation

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

creates a null category object.

Definition at line 32 of file category.cpp.

Syndication::Atom::Category::Category ( const QDomElement &  element  )  [explicit]

creates a Category object wrapping an atom:category element.

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

Definition at line 36 of file 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 58 of file 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 53 of file 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 45 of file 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 40 of file category.cpp.


The documentation for this class was generated from the following files:
  • category.h
  • category.cpp

syndication/atom

Skip menu "syndication/atom"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.7.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal