Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 110492f5122731329f0db69a1df590c3 > files > 5644

kdepimlibs-apidocs-4.10.5-1.fc18.noarch.rpm

<?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::Atom::FeedDocument 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">&nbsp;</div>
<h2><a name="content"></a>syndication/atom</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>Syndication</b></li><li class="navelem"><a class="el" href="namespaceSyndication_1_1Atom.html">Atom</a></li><li class="navelem"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html">FeedDocument</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classSyndication_1_1Atom_1_1FeedDocument-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Syndication::Atom::FeedDocument Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="document_8h_source.html">document.h</a>&gt;</code></p>

<p>Inherits SpecificDocument, and ElementWrapper.</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:aa43e41152c9341162063e132d6eb80cb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aa43e41152c9341162063e132d6eb80cb">FeedDocument</a> ()</td></tr>
<tr class="separator:aa43e41152c9341162063e132d6eb80cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a110f197f8da78dafb27c2d87376ce8f6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a110f197f8da78dafb27c2d87376ce8f6">FeedDocument</a> (const QDomElement &amp;element)</td></tr>
<tr class="separator:a110f197f8da78dafb27c2d87376ce8f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa995d588efb72d3c9079f3e774137081"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aa995d588efb72d3c9079f3e774137081">accept</a> (DocumentVisitor *visitor)</td></tr>
<tr class="separator:aa995d588efb72d3c9079f3e774137081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f0ccfbfc6bf537c6210b9a962c7d4b9"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Person.html">Person</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a2f0ccfbfc6bf537c6210b9a962c7d4b9">authors</a> () const </td></tr>
<tr class="separator:a2f0ccfbfc6bf537c6210b9a962c7d4b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7abb80992b15bac23c11e14436ed5d4"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Category.html">Category</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#ab7abb80992b15bac23c11e14436ed5d4">categories</a> () const </td></tr>
<tr class="separator:ab7abb80992b15bac23c11e14436ed5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9342db2524a832c077bc41f615d8901"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Person.html">Person</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aa9342db2524a832c077bc41f615d8901">contributors</a> () const </td></tr>
<tr class="separator:aa9342db2524a832c077bc41f615d8901"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ceb4c72d5b52c3ce13d0dec9d28dd97"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a8ceb4c72d5b52c3ce13d0dec9d28dd97">debugInfo</a> () const </td></tr>
<tr class="separator:a8ceb4c72d5b52c3ce13d0dec9d28dd97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafdb342452c33049d617373a8b53a551"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Entry.html">Entry</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aafdb342452c33049d617373a8b53a551">entries</a> () const </td></tr>
<tr class="separator:aafdb342452c33049d617373a8b53a551"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacb8ca8e6562beaf8b2007c5693f863d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSyndication_1_1Atom_1_1Generator.html">Generator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aacb8ca8e6562beaf8b2007c5693f863d">generator</a> () const </td></tr>
<tr class="separator:aacb8ca8e6562beaf8b2007c5693f863d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8dab1c2cb34bae9b269d1ef6d67c139"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aa8dab1c2cb34bae9b269d1ef6d67c139">icon</a> () const </td></tr>
<tr class="separator:aa8dab1c2cb34bae9b269d1ef6d67c139"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b052e405d60d9efb5e26d8848c72f34"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a7b052e405d60d9efb5e26d8848c72f34">id</a> () const </td></tr>
<tr class="separator:a7b052e405d60d9efb5e26d8848c72f34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb0169fafe2709759c5287df5b6222c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aebb0169fafe2709759c5287df5b6222c">isValid</a> () const </td></tr>
<tr class="separator:aebb0169fafe2709759c5287df5b6222c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4634f58034da4363283b0f230c95115e"><td class="memItemLeft" align="right" valign="top">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Link.html">Link</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a4634f58034da4363283b0f230c95115e">links</a> () const </td></tr>
<tr class="separator:a4634f58034da4363283b0f230c95115e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00f2162d95debffaa685ee18e9f5c9a2"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a00f2162d95debffaa685ee18e9f5c9a2">logo</a> () const </td></tr>
<tr class="separator:a00f2162d95debffaa685ee18e9f5c9a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dbcbfc182c352c63b05c4f3625d43a2"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a0dbcbfc182c352c63b05c4f3625d43a2">rights</a> () const </td></tr>
<tr class="separator:a0dbcbfc182c352c63b05c4f3625d43a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c54363847bd1bc943ea6c026f92d58e"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a7c54363847bd1bc943ea6c026f92d58e">subtitle</a> () const </td></tr>
<tr class="separator:a7c54363847bd1bc943ea6c026f92d58e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28b6db6a6cb57bdb260cd8eb1c648044"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a28b6db6a6cb57bdb260cd8eb1c648044">title</a> () const </td></tr>
<tr class="separator:a28b6db6a6cb57bdb260cd8eb1c648044"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8828ab95ae6365a98ac359b0620c3810"><td class="memItemLeft" align="right" valign="top">QList&lt; QDomElement &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#a8828ab95ae6365a98ac359b0620c3810">unhandledElements</a> () const </td></tr>
<tr class="separator:a8828ab95ae6365a98ac359b0620c3810"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf4f805e809a099ba3dba85f4193c043"><td class="memItemLeft" align="right" valign="top">time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#adf4f805e809a099ba3dba85f4193c043">updated</a> () const </td></tr>
<tr class="separator:adf4f805e809a099ba3dba85f4193c043"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An <a class="el" href="namespaceSyndication_1_1Atom.html" title="Atom parser and model classes, representing Atom 1.0 documents (Atom 0.3 documents are converted by t...">Atom</a> 1.0 Feed Document, containing metadata describing the feed and a number of entries. </p>
<dl class="section author"><dt>Author</dt><dd>Frank Osterfeld </dd></dl>

<p>Definition at line <a class="el" href="document_8h_source.html#l00057">57</a> of file <a class="el" href="document_8h_source.html">document.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa43e41152c9341162063e132d6eb80cb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Syndication::Atom::FeedDocument::FeedDocument </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>default constructor, creates a null feed, which is invalid. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html#aebb0169fafe2709759c5287df5b6222c" title="returns whether this document is valid or not.">isValid()</a> </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00042">42</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a110f197f8da78dafb27c2d87376ce8f6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Syndication::Atom::FeedDocument::FeedDocument </td>
          <td>(</td>
          <td class="paramtype">const QDomElement &amp;&#160;</td>
          <td class="paramname"><em>element</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>creates a <a class="el" href="classSyndication_1_1Atom_1_1FeedDocument.html" title="An Atom 1.0 Feed Document, containing metadata describing the feed and a number of entries...">FeedDocument</a> wrapping an atom:feed element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">element</td><td>a DOM element, should be a atom:feed document (although not enforced), otherwise this object will not parse anything useful </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00046">46</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa995d588efb72d3c9079f3e774137081"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Syndication::Atom::FeedDocument::accept </td>
          <td>(</td>
          <td class="paramtype">DocumentVisitor *&#160;</td>
          <td class="paramname"><em>visitor</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Used by visitors for double dispatch. </p>
<p>See DocumentVisitor for more information. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">visitor</td><td>the visitor calling the method </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00050">50</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a2f0ccfbfc6bf537c6210b9a962c7d4b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Person.html">Person</a> &gt; Syndication::Atom::FeedDocument::authors </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a list of persons who are the authors of this feed. </p>
<p>According to the <a class="el" href="namespaceSyndication_1_1Atom.html" title="Atom parser and model classes, representing Atom 1.0 documents (Atom 0.3 documents are converted by t...">Atom</a> 1.0 spec, a feed must have an author unless all entries in it have one. </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00055">55</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab7abb80992b15bac23c11e14436ed5d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Category.html">Category</a> &gt; Syndication::Atom::FeedDocument::categories </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a list of categories this feed is assigned to (optional) </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00093">93</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa9342db2524a832c077bc41f615d8901"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Person.html">Person</a> &gt; Syndication::Atom::FeedDocument::contributors </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a list of persons who contribute to this feed. </p>
<p>(optional) </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00074">74</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8ceb4c72d5b52c3ce13d0dec9d28dd97"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::debugInfo </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>returns a description of this feed document for debugging purposes. </p>
<dl class="section return"><dt>Returns</dt><dd>debug string </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00237">237</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aafdb342452c33049d617373a8b53a551"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Entry.html">Entry</a> &gt; Syndication::Atom::FeedDocument::entries </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a list of the entries (items) in this feed. </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00179">179</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aacb8ca8e6562beaf8b2007c5693f863d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSyndication_1_1Atom_1_1Generator.html">Generator</a> Syndication::Atom::FeedDocument::generator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>description of the agent used to generate the feed. </p>
<p>See <a class="el" href="classSyndication_1_1Atom_1_1Generator.html" title="Description of the agent used to generate the feed.">Generator</a> for more information (optional).</p>
<dl class="section return"><dt>Returns</dt><dd>description of the generator, or a null <a class="el" href="classSyndication_1_1Atom_1_1Generator.html" title="Description of the agent used to generate the feed.">Generator</a> object if not specified in the feed. </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00112">112</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa8dab1c2cb34bae9b269d1ef6d67c139"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::icon </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>URL of an image serving as a feed icon (optional) </p>
<dl class="section return"><dt>Returns</dt><dd>icon URL, or a null string if not specified in the feed. </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00118">118</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a7b052e405d60d9efb5e26d8848c72f34"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::id </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a string that unambigously identifies the feed (required) </p>
<dl class="section return"><dt>Returns</dt><dd>the ID of the feed. As defined in the <a class="el" href="namespaceSyndication_1_1Atom.html" title="Atom parser and model classes, representing Atom 1.0 documents (Atom 0.3 documents are converted by t...">Atom</a> spec it must be a valid URI (which is neither checked nor enforced by this parser) </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00131">131</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aebb0169fafe2709759c5287df5b6222c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Syndication::Atom::FeedDocument::isValid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>returns whether this document is valid or not. </p>
<p>Invalid documents do not contain any useful information. </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00232">232</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4634f58034da4363283b0f230c95115e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; <a class="el" href="classSyndication_1_1Atom_1_1Link.html">Link</a> &gt; Syndication::Atom::FeedDocument::links </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a list of links. </p>
<p>See <a class="el" href="classSyndication_1_1Atom_1_1Link.html" title="A link, pointing to webpages, media files on the web (&quot;podcast&quot;), related content, etc.">Link</a> for more information on link types. </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00160">160</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a00f2162d95debffaa685ee18e9f5c9a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::logo </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>URL of an image serving as a feed logo (optional) </p>
<dl class="section return"><dt>Returns</dt><dd>image URL, or a null string if not specified in the feed. </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00125">125</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a0dbcbfc182c352c63b05c4f3625d43a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::rights </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>copyright information (optional) </p>
<dl class="section return"><dt>Returns</dt><dd>copyright information for the feed (intended for human readers), or a null string if not specified </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00137">137</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a7c54363847bd1bc943ea6c026f92d58e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::subtitle </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>description or subtitle of the feed (optional). </p>
<dl class="section return"><dt>Returns</dt><dd>subtitle string as HTML, or a null string if not specified in the feed. </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00148">148</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a28b6db6a6cb57bdb260cd8eb1c648044"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Atom::FeedDocument::title </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>feed title (required). </p>
<dl class="section return"><dt>Returns</dt><dd>title string as HTML. </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00143">143</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8828ab95ae6365a98ac359b0620c3810"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QList&lt; QDomElement &gt; Syndication::Atom::FeedDocument::unhandledElements </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>returns all child elements of this feed not covered by this class. </p>
<p>This can be used to access additional metadata from <a class="el" href="namespaceSyndication_1_1Atom.html" title="Atom parser and model classes, representing Atom 1.0 documents (Atom 0.3 documents are converted by t...">Atom</a> extensions. </p>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00198">198</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="adf4f805e809a099ba3dba85f4193c043"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">time_t Syndication::Atom::FeedDocument::updated </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The datetime of the last modification of the feed content. </p>
<dl class="section return"><dt>Returns</dt><dd>the modification date in seconds since epoch </dd></dl>

<p>Definition at line <a class="el" href="document_8cpp_source.html#l00153">153</a> of file <a class="el" href="document_8cpp_source.html">document.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="document_8h_source.html">document.h</a></li>
<li><a class="el" href="document_8cpp_source.html">document.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright &copy; 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:32 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>, &copy;&nbsp;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/atom</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "syndication/atom"</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="functions.html">Class Members</a></li><li><a href="files.html">File List</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_1Atom_1_1Category.html">syndication::atom::category</option>,  <option value="classSyndication_1_1Atom_1_1Content.html">syndication::atom::content</option>,  <option value="classSyndication_1_1Atom_1_1Entry.html">syndication::atom::entry</option>,  <option value="classSyndication_1_1Atom_1_1EntryDocument.html">syndication::atom::entrydocument</option>,  <option value="classSyndication_1_1Atom_1_1FeedDocument.html">syndication::atom::feeddocument</option>,  <option value="classSyndication_1_1Atom_1_1Generator.html">syndication::atom::generator</option>,  <option value="classSyndication_1_1Atom_1_1Link.html">syndication::atom::link</option>,  <option value="classSyndication_1_1Atom_1_1Parser.html">syndication::atom::parser</option>,  <option value="classSyndication_1_1Atom_1_1Person.html">syndication::atom::person</option>,  <option value="classSyndication_1_1Atom_1_1Source.html">syndication::atom::source</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>&nbsp;&nbsp;<a href="../../../akonadi/contact/html/index.html">contact</a></li><li>&nbsp;&nbsp;<a href="../../../akonadi/kmime/html/index.html">kmime</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../../kioslave/imap4/html/index.html">imap4</a></li><li>&nbsp;&nbsp;<a href="../../../kioslave/mbox/html/index.html">mbox</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../../syndication/atom/html/index.html">atom</a></li><li>&nbsp;&nbsp;<a href="../../../syndication/rdf/html/index.html">rdf</a></li><li>&nbsp;&nbsp;<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>&#174;</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>