Sophie

Sophie

distrib > Fedora > 18 > x86_64 > by-pkgid > 110492f5122731329f0db69a1df590c3 > files > 5749

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::Image 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 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_1Image.html">Image</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_1Image-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Syndication::Image Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="image_8h_source.html">image.h</a>&gt;</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:aaf87facc57b9190538f6ca928cce9c66"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#aaf87facc57b9190538f6ca928cce9c66">~Image</a> ()</td></tr>
<tr class="separator:aaf87facc57b9190538f6ca928cce9c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91e86060ea17c4cb9c1ada03f352d1e2"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#a91e86060ea17c4cb9c1ada03f352d1e2">debugInfo</a> () const </td></tr>
<tr class="separator:a91e86060ea17c4cb9c1ada03f352d1e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addfc66c62a19356cf763b39eea57f09b"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#addfc66c62a19356cf763b39eea57f09b">description</a> () const =0</td></tr>
<tr class="separator:addfc66c62a19356cf763b39eea57f09b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a519573956d1afb318a3ac308522ffa03"><td class="memItemLeft" align="right" valign="top">virtual uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#a519573956d1afb318a3ac308522ffa03">height</a> () const =0</td></tr>
<tr class="separator:a519573956d1afb318a3ac308522ffa03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0ce8f8867d15a215b9ee822225d1d89"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#ae0ce8f8867d15a215b9ee822225d1d89">isNull</a> () const =0</td></tr>
<tr class="separator:ae0ce8f8867d15a215b9ee822225d1d89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65a0c42b658d762636935a0d7a2d1586"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#a65a0c42b658d762636935a0d7a2d1586">link</a> () const =0</td></tr>
<tr class="separator:a65a0c42b658d762636935a0d7a2d1586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8bfe23391cb0a9e8a99c6735da899c4"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#aa8bfe23391cb0a9e8a99c6735da899c4">title</a> () const =0</td></tr>
<tr class="separator:aa8bfe23391cb0a9e8a99c6735da899c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab089525a0f25dcd5c1761e100bf00221"><td class="memItemLeft" align="right" valign="top">virtual QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#ab089525a0f25dcd5c1761e100bf00221">url</a> () const =0</td></tr>
<tr class="separator:ab089525a0f25dcd5c1761e100bf00221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33bce045eab7b592a8d1c79c07a13c86"><td class="memItemLeft" align="right" valign="top">virtual uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSyndication_1_1Image.html#a33bce045eab7b592a8d1c79c07a13c86">width</a> () const =0</td></tr>
<tr class="separator:a33bce045eab7b592a8d1c79c07a13c86"><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>This class represents an image file on the web. </p>
<p>It is usually some kind of feed logo which can be displayed when showing the feed description.</p>
<dl class="section author"><dt>Author</dt><dd>Frank Osterfeld </dd></dl>

<p>Definition at line <a class="el" href="image_8h_source.html#l00045">45</a> of file <a class="el" href="image_8h_source.html">image.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aaf87facc57b9190538f6ca928cce9c66"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Syndication::Image::~Image </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="image_8cpp_source.html#l00029">29</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a91e86060ea17c4cb9c1ada03f352d1e2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">QString Syndication::Image::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>returns a description of the image for debugging purposes </p>
<dl class="section return"><dt>Returns</dt><dd>debug string </dd></dl>

<p>Definition at line <a class="el" href="image_8cpp_source.html#l00033">33</a> of file <a class="el" href="image_8cpp_source.html">image.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="addfc66c62a19356cf763b39eea57f09b"></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::Image::description </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>optional text that can be included in the TITLE attribute of the link formed around the image in HTML rendering. </p>
<dl class="section return"><dt>Returns</dt><dd>TODO: specify format (HTML etc.) </dd></dl>

</div>
</div>
<a class="anchor" id="a519573956d1afb318a3ac308522ffa03"></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::Image::height </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 height of the image in pixels. </p>
<dl class="section return"><dt>Returns</dt><dd>image height in pixels or 0 of not specified in the feed. </dd></dl>

</div>
</div>
<a class="anchor" id="ae0ce8f8867d15a215b9ee822225d1d89"></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::Image::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 image is a null object. </p>

</div>
</div>
<a class="anchor" id="a65a0c42b658d762636935a0d7a2d1586"></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::Image::link </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 site, when the channel is rendered, the image should be a link to the site. </p>
<p>If not set, use <a class="el" href="classSyndication_1_1Feed.html#ab715c2dad2adcacc871741d09c2512b1" title="returns a link pointing to a website associated with this channel.">Feed::link()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>the url the rendered image should link to, or a null string if not specified in the feed. </dd></dl>

</div>
</div>
<a class="anchor" id="aa8bfe23391cb0a9e8a99c6735da899c4"></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::Image::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>Describes the image, can be used in the ALT attribute of the HTML &lt;img&gt; tag when the channel is rendered in HTML. </p>
<dl class="section return"><dt>Returns</dt><dd>TODO: specify format </dd></dl>

</div>
</div>
<a class="anchor" id="ab089525a0f25dcd5c1761e100bf00221"></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::Image::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 a GIF, JPEG or PNG image </p>

</div>
</div>
<a class="anchor" id="a33bce045eab7b592a8d1c79c07a13c86"></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::Image::width </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 width of the image in pixels. </p>
<dl class="section return"><dt>Returns</dt><dd>image width in pixels or 0 if not specified in the feed. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="image_8h_source.html">image.h</a></li>
<li><a class="el" href="image_8cpp_source.html">image.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: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>, &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 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>&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>