<?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::Enclosure 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_1Enclosure.html">Enclosure</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classSyndication_1_1Enclosure-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Syndication::Enclosure 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="enclosure_8h_source.html">enclosure.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:a34b31383444e097e18a5bf2f2db3e71b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#a34b31383444e097e18a5bf2f2db3e71b">~Enclosure</a> ()</td></tr>
<tr class="separator:a34b31383444e097e18a5bf2f2db3e71b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a260f514932c2110a893bdfdbf5fda028"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#a260f514932c2110a893bdfdbf5fda028">debugInfo</a> () const </td></tr>
<tr class="separator:a260f514932c2110a893bdfdbf5fda028"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad91270ff3944f17efe86d21a69be4c6c"><td class="memItemLeft" align="right" valign="top">virtual uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#ad91270ff3944f17efe86d21a69be4c6c">duration</a> () const =0</td></tr>
<tr class="separator:ad91270ff3944f17efe86d21a69be4c6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b85533b19568fd6b2e946130adfeb40"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#a8b85533b19568fd6b2e946130adfeb40">isNull</a> () const =0</td></tr>
<tr class="separator:a8b85533b19568fd6b2e946130adfeb40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8943f04eb4457ed6e283112aebb6e99b"><td class="memItemLeft" align="right" valign="top">virtual uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#a8943f04eb4457ed6e283112aebb6e99b">length</a> () const =0</td></tr>
<tr class="separator:a8943f04eb4457ed6e283112aebb6e99b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf35346d42f01c23d04c211ba0bbba9f"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#acf35346d42f01c23d04c211ba0bbba9f">title</a> () const =0</td></tr>
<tr class="separator:acf35346d42f01c23d04c211ba0bbba9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ce52a32bf16167f680646db039264d5"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#a5ce52a32bf16167f680646db039264d5">type</a> () const =0</td></tr>
<tr class="separator:a5ce52a32bf16167f680646db039264d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab2f5292afaafaed4c21910f16e983940"><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Enclosure.html#ab2f5292afaafaed4c21910f16e983940">url</a> () const =0</td></tr>
<tr class="separator:ab2f5292afaafaed4c21910f16e983940"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An enclosure describes a (media) file available on the net. </p>
<p>Most of the time, enclosures are used for "podcasts", i.e. audio files announced and distributed via syndication.</p>
<dl class="section author"><dt>Author</dt><dd>Frank Osterfeld </dd></dl>
<p>Definition at line <a class="el" href="enclosure_8h_source.html#l00047">47</a> of file <a class="el" href="enclosure_8h_source.html">enclosure.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a34b31383444e097e18a5bf2f2db3e71b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Syndication::Enclosure::~Enclosure </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="enclosure_8cpp_source.html#l00029">29</a> of file <a class="el" href="enclosure_8cpp_source.html">enclosure.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a260f514932c2110a893bdfdbf5fda028"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString Syndication::Enclosure::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 this enclosure for debugging purposes </p>
<dl class="section return"><dt>Returns</dt><dd>debug string </dd></dl>
<p>Definition at line <a class="el" href="enclosure_8cpp_source.html#l00033">33</a> of file <a class="el" href="enclosure_8cpp_source.html">enclosure.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad91270ff3944f17efe86d21a69be4c6c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint Syndication::Enclosure::duration </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>for audio/video files, the duration of the file in seconds </p>
<dl class="section return"><dt>Returns</dt><dd>the duration of the file in seconds, or 0 if not specified </dd></dl>
</div>
</div>
<a class="anchor" id="a8b85533b19568fd6b2e946130adfeb40"></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::Enclosure::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 enclosure is a null object. </p>
</div>
</div>
<a class="anchor" id="a8943f04eb4457ed6e283112aebb6e99b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint Syndication::Enclosure::length </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 the length of the linked file in bytes </p>
<dl class="section return"><dt>Returns</dt><dd>the length of the file in bytes, 0 if not specified </dd></dl>
</div>
</div>
<a class="anchor" id="acf35346d42f01c23d04c211ba0bbba9f"></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::Enclosure::title </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>title of the enclosure. </p>
<p>This is a human-readable description of the linked file. If available, the title should be used in user interfaces instead of the URL. If no title is set (e.g., RSS2 enclosures don't have titles), use <a class="el" href="classSyndication_1_1Enclosure.html#ab2f5292afaafaed4c21910f16e983940" title="The URL of the linked resource (required).">url()</a> as fallback.</p>
<dl class="section return"><dt>Returns</dt><dd>title describing the enclosure, or a null string if not specified. </dd></dl>
</div>
</div>
<a class="anchor" id="a5ce52a32bf16167f680646db039264d5"></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::Enclosure::type </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>mimetype of the enclosure. </p>
<p>TODO: link mimetype specs</p>
<p>Examples are <code>"audio/mpeg"</code> for MP3, or <code>"application/pdf"</code> for PDF.</p>
<dl class="section return"><dt>Returns</dt><dd>the mimetype of the file, or a null string if not specified </dd></dl>
</div>
</div>
<a class="anchor" id="ab2f5292afaafaed4c21910f16e983940"></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::Enclosure::url </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>The URL of the linked resource (required). </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="enclosure_8h_source.html">enclosure.h</a></li>
<li><a class="el" href="enclosure_8cpp_source.html">enclosure.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>
