<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Syndication::Category Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>Syndication Library</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceSyndication.html">Syndication</a></li><li class="navelem"><a class="el" href="classSyndication_1_1Category.html">Category</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classSyndication_1_1Category-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Syndication::Category Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="category_8h_source.html">category.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5b1a72d47cb6f74a9aa9badf4baf95dc"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Category.html#a5b1a72d47cb6f74a9aa9badf4baf95dc">~Category</a> ()</td></tr>
<tr class="separator:a5b1a72d47cb6f74a9aa9badf4baf95dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a943223ed79a4d8d7820b1e4eeed0c966"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Category.html#a943223ed79a4d8d7820b1e4eeed0c966">debugInfo</a> () const </td></tr>
<tr class="separator:a943223ed79a4d8d7820b1e4eeed0c966"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c882b029c9c95ac9a2a2c0694fb25b0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Category.html#a2c882b029c9c95ac9a2a2c0694fb25b0">isNull</a> () const =0</td></tr>
<tr class="separator:a2c882b029c9c95ac9a2a2c0694fb25b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b385f2185113be10f02874ebeeee360"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Category.html#a6b385f2185113be10f02874ebeeee360">label</a> () const =0</td></tr>
<tr class="separator:a6b385f2185113be10f02874ebeeee360"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7030b08a0b04ed77c8f189c723b42ea"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Category.html#ab7030b08a0b04ed77c8f189c723b42ea">scheme</a> () const =0</td></tr>
<tr class="separator:ab7030b08a0b04ed77c8f189c723b42ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab71e908a3bb138b2530a12ad89c27fde"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Category.html#ab71e908a3bb138b2530a12ad89c27fde">term</a> () const =0</td></tr>
<tr class="separator:ab71e908a3bb138b2530a12ad89c27fde"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A category for categorizing items or whole feeds. </p>
<p>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.</p>
<p>To represent the category in a user interface, use <a class="el" href="classSyndication_1_1Category.html#a6b385f2185113be10f02874ebeeee360" title="An optional human-readable label of the category.">label()</a> (or <a class="el" href="classSyndication_1_1Category.html#ab71e908a3bb138b2530a12ad89c27fde" title="A term identifying the category, e.g.">term()</a> as fallback). To create a key for e.g. storage purposes, use <a class="el" href="classSyndication_1_1Category.html#ab7030b08a0b04ed77c8f189c723b42ea" title="An optional scheme the term is part of.">scheme()</a> + <a class="el" href="classSyndication_1_1Category.html#ab71e908a3bb138b2530a12ad89c27fde" title="A term identifying the category, e.g.">term()</a>.</p>
<dl class="section author"><dt>Author</dt><dd>Frank Osterfeld </dd></dl>
<p>Definition at line <a class="el" href="category_8h_source.html#l00047">47</a> of file <a class="el" href="category_8h_source.html">category.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5b1a72d47cb6f74a9aa9badf4baf95dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Syndication::Category::~Category </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor </p>
<p>Definition at line <a class="el" href="category_8cpp_source.html#l00029">29</a> of file <a class="el" href="category_8cpp_source.html">category.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a943223ed79a4d8d7820b1e4eeed0c966"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString Syndication::Category::debugInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Description of the category for debugging purposes. </p>
<dl class="section return"><dt>Returns</dt><dd>debug string </dd></dl>
<p>Definition at line <a class="el" href="category_8cpp_source.html#l00033">33</a> of file <a class="el" href="category_8cpp_source.html">category.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2c882b029c9c95ac9a2a2c0694fb25b0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool Syndication::Category::isNull </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns whether this object is a null category </p>
</div>
</div>
<a class="anchor" id="a6b385f2185113be10f02874ebeeee360"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QString Syndication::Category::label </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An optional human-readable label of the category. </p>
<p>If specified, this string should be used to represent this category in a user interface. If not specified, use <a class="el" href="classSyndication_1_1Category.html#ab71e908a3bb138b2530a12ad89c27fde" title="A term identifying the category, e.g.">term()</a> instead. TODO: specify format (HTML, plain text?) and enforce it in the impl </p>
<dl class="section return"><dt>Returns</dt><dd>the label of this category, or a null string if not specified </dd></dl>
</div>
</div>
<a class="anchor" id="ab7030b08a0b04ed77c8f189c723b42ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QString Syndication::Category::scheme </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An optional scheme the term is part of. </p>
<p>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, <a class="el" href="classSyndication_1_1Category.html#ab7030b08a0b04ed77c8f189c723b42ea" title="An optional scheme the term is part of.">scheme()</a> + <a class="el" href="classSyndication_1_1Category.html#ab71e908a3bb138b2530a12ad89c27fde" title="A term identifying the category, e.g.">term()</a> identifies a category unambigously and can be used as key.</p>
<dl class="section return"><dt>Returns</dt><dd>the scheme this category is part of, or a null string if not specified </dd></dl>
</div>
</div>
<a class="anchor" id="ab71e908a3bb138b2530a12ad89c27fde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual QString Syndication::Category::term </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A term identifying the category, e.g. </p>
<p>"general", "life", "books" or "Basketball & other sport I like". The term must be unique in its scheme (see <a class="el" href="classSyndication_1_1Category.html#ab7030b08a0b04ed77c8f189c723b42ea" title="An optional scheme the term is part of.">scheme()</a>).</p>
<p>In user interfaces, use it only if there is no <a class="el" href="classSyndication_1_1Category.html#a6b385f2185113be10f02874ebeeee360" title="An optional human-readable label of the category.">label()</a> available. TODO: specify format (HTML, plain text?) and enforce it in the impl </p>
<dl class="section return"><dt>Returns</dt><dd>category term. This string is never empty. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="category_8h_source.html">category.h</a></li>
<li><a class="el" href="category_8cpp_source.html">category.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:30 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Syndication Library</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "Syndication Library"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classSyndication_1_1AbstractParser.html">syndication::abstractparser</option>, <option value="classSyndication_1_1Category.html">syndication::category</option>, <option value="classSyndication_1_1DataRetriever.html">syndication::dataretriever</option>, <option value="classSyndication_1_1DocumentSource.html">syndication::documentsource</option>, <option value="classSyndication_1_1DocumentVisitor.html">syndication::documentvisitor</option>, <option value="classSyndication_1_1ElementWrapper.html">syndication::elementwrapper</option>, <option value="classSyndication_1_1Enclosure.html">syndication::enclosure</option>, <option value="classSyndication_1_1Feed.html">syndication::feed</option>, <option value="classSyndication_1_1FileRetriever.html">syndication::fileretriever</option>, <option value="classSyndication_1_1Image.html">syndication::image</option>, <option value="classSyndication_1_1Item.html">syndication::item</option>, <option value="classSyndication_1_1Loader.html">syndication::loader</option>, <option value="classSyndication_1_1Mapper.html">syndication::mapper</option>, <option value="classSyndication_1_1OutputRetriever.html">syndication::outputretriever</option>, <option value="classSyndication_1_1ParserCollection.html">syndication::parsercollection</option>, <option value="classSyndication_1_1Person.html">syndication::person</option>, <option value="classSyndication_1_1SpecificDocument.html">syndication::specificdocument</option>, <option value="classSyndication_1_1SpecificItem.html">syndication::specificitem</option>, <option value="classSyndication_1_1SpecificItemVisitor.html">syndication::specificitemvisitor</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
