Sophie

Sophie

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

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>KABC::FormatFactory 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>kabc</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>KABC</b></li><li class="navelem"><a class="el" href="classKABC_1_1FormatFactory.html">FormatFactory</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classKABC_1_1FormatFactory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">KABC::FormatFactory Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="formatfactory_8h_source.html">formatfactory.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:a189f74b001cfcb795af49d97220a12af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1FormatFactory.html#a189f74b001cfcb795af49d97220a12af">~FormatFactory</a> ()</td></tr>
<tr class="separator:a189f74b001cfcb795af49d97220a12af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a674f1a5d09f890b3e67803dd272070a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKABC_1_1Format.html">Format</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1FormatFactory.html#a674f1a5d09f890b3e67803dd272070a5">format</a> (const QString &amp;type)</td></tr>
<tr class="separator:a674f1a5d09f890b3e67803dd272070a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab56a78b8c087cc39633f74569eebe329"><td class="memItemLeft" align="right" valign="top">QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1FormatFactory.html#ab56a78b8c087cc39633f74569eebe329">formats</a> ()</td></tr>
<tr class="separator:ab56a78b8c087cc39633f74569eebe329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a169523018333c0bb9d47d88cf06f4ab9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structKABC_1_1FormatInfo.html">FormatInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1FormatFactory.html#a169523018333c0bb9d47d88cf06f4ab9">info</a> (const QString &amp;type) const </td></tr>
<tr class="separator:a169523018333c0bb9d47d88cf06f4ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa6c4aef7064e232f0fa96b9c07fd5944"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKABC_1_1FormatFactory.html">FormatFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1FormatFactory.html#aa6c4aef7064e232f0fa96b9c07fd5944">self</a> ()</td></tr>
<tr class="separator:aa6c4aef7064e232f0fa96b9c07fd5944"><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>Class for loading format plugins. </p>
<p>Example:</p>
<div class="fragment"><div class="line"><a class="code" href="classKABC_1_1FormatFactory.html" title="Class for loading format plugins.">KABC::FormatFactory</a> *factory = <a class="code" href="classKABC_1_1FormatFactory.html#aa6c4aef7064e232f0fa96b9c07fd5944" title="Returns the global format factory.">KABC::FormatFactory::self</a>();</div>
<div class="line"></div>
<div class="line">QStringList list = factory-&gt;<a class="code" href="classKABC_1_1FormatFactory.html#ab56a78b8c087cc39633f74569eebe329" title="Returns a list of all available format types.">formats</a>();</div>
<div class="line">QStringList::Iterator it;</div>
<div class="line"><span class="keywordflow">for</span> ( it = list.begin(); it != list.end(); ++it ) {</div>
<div class="line">  <a class="code" href="classKABC_1_1Format.html" title="Base class for address book formats.">KABC::Format</a> *<a class="code" href="classKABC_1_1FormatFactory.html#a674f1a5d09f890b3e67803dd272070a5" title="Returns a pointer to a format object or a null pointer if format type doesn&#39;t exist.">format</a> = factory-&gt;<a class="code" href="classKABC_1_1FormatFactory.html#a674f1a5d09f890b3e67803dd272070a5" title="Returns a pointer to a format object or a null pointer if format type doesn&#39;t exist.">format</a>( (*it) );</div>
<div class="line">  <span class="comment">// do something with format</span></div>
<div class="line">}</div>
</div><!-- fragment --> 
<p>Definition at line <a class="el" href="formatfactory_8h_source.html#l00094">94</a> of file <a class="el" href="formatfactory_8h_source.html">formatfactory.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a189f74b001cfcb795af49d97220a12af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FormatFactory::~FormatFactory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destructor. </p>

<p>Definition at line <a class="el" href="formatfactory_8cpp_source.html#l00113">113</a> of file <a class="el" href="formatfactory_8cpp_source.html">formatfactory.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a674f1a5d09f890b3e67803dd272070a5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKABC_1_1Format.html">Format</a> * FormatFactory::format </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a pointer to a format object or a null pointer if format type doesn't exist. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">type</td><td>The type of the format, returned by <a class="el" href="classKABC_1_1FormatFactory.html#ab56a78b8c087cc39633f74569eebe329" title="Returns a list of all available format types.">formats()</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKABC_1_1FormatFactory.html#a169523018333c0bb9d47d88cf06f4ab9" title="Returns the info structure for a special type.">info()</a> </dd></dl>

<p>Definition at line <a class="el" href="formatfactory_8cpp_source.html#l00145">145</a> of file <a class="el" href="formatfactory_8cpp_source.html">formatfactory.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ab56a78b8c087cc39633f74569eebe329"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QStringList FormatFactory::formats </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a list of all available format types. </p>

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

</div>
</div>
<a class="anchor" id="a169523018333c0bb9d47d88cf06f4ab9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structKABC_1_1FormatInfo.html">FormatInfo</a> FormatFactory::info </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the info structure for a special type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">type</td><td>The type of the format, returned by <a class="el" href="classKABC_1_1FormatFactory.html#ab56a78b8c087cc39633f74569eebe329" title="Returns a list of all available format types.">formats()</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKABC_1_1FormatFactory.html#a674f1a5d09f890b3e67803dd272070a5" title="Returns a pointer to a format object or a null pointer if format type doesn&#39;t exist.">format()</a> </dd></dl>

<p>Definition at line <a class="el" href="formatfactory_8cpp_source.html#l00136">136</a> of file <a class="el" href="formatfactory_8cpp_source.html">formatfactory.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aa6c4aef7064e232f0fa96b9c07fd5944"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKABC_1_1FormatFactory.html">FormatFactory</a> * FormatFactory::self </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the global format factory. </p>

<p>Definition at line <a class="el" href="formatfactory_8cpp_source.html#l00068">68</a> of file <a class="el" href="formatfactory_8cpp_source.html">formatfactory.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="formatfactory_8h_source.html">formatfactory.h</a></li>
<li><a class="el" href="formatfactory_8cpp_source.html">formatfactory.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:49:41 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">kabc</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kabc"</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="classKABC_1_1Address.html">kabc::address</option>,  <option value="classKABC_1_1AddressBook.html">kabc::addressbook</option>,  <option value="classKABC_1_1AddressBook_1_1ConstIterator.html">kabc::addressbook::constiterator</option>,  <option value="classKABC_1_1AddressBook_1_1Iterator.html">kabc::addressbook::iterator</option>,  <option value="classKABC_1_1AddresseeDialog.html">kabc::addresseedialog</option>,  <option value="classKABC_1_1AddresseeHelper.html">kabc::addresseehelper</option>,  <option value="classKABC_1_1AddresseeItem.html">kabc::addresseeitem</option>,  <option value="classKABC_1_1AddresseeList.html">kabc::addresseelist</option>,  <option value="classKABC_1_1AddressLineEdit.html">kabc::addresslineedit</option>,  <option value="classKABC_1_1BinaryFormat.html">kabc::binaryformat</option>,  <option value="classKABC_1_1ConsoleErrorHandler.html">kabc::consoleerrorhandler</option>,  <option value="classKABC_1_1ContactGroup.html">kabc::contactgroup</option>,  <option value="classKABC_1_1ContactGroup_1_1ContactGroupReference.html">kabc::contactgroup::contactgroupreference</option>,  <option value="classKABC_1_1ContactGroup_1_1ContactReference.html">kabc::contactgroup::contactreference</option>,  <option value="classKABC_1_1ContactGroup_1_1Data.html">kabc::contactgroup::data</option>,  <option value="classKABC_1_1DistributionList.html">kabc::distributionlist</option>,  <option value="classKABC_1_1DistributionList_1_1Entry.html">kabc::distributionlist::entry</option>,  <option value="classKABC_1_1DistributionListDialog.html">kabc::distributionlistdialog</option>,  <option value="classKABC_1_1DistributionListEditorWidget.html">kabc::distributionlisteditorwidget</option>,  <option value="classKABC_1_1EmailSelector.html">kabc::emailselector</option>,  <option value="classKABC_1_1ErrorHandler.html">kabc::errorhandler</option>,  <option value="classKABC_1_1Field.html">kabc::field</option>,  <option value="classKABC_1_1FieldSortMode.html">kabc::fieldsortmode</option>,  <option value="classKABC_1_1Format.html">kabc::format</option>,  <option value="classKABC_1_1FormatFactory.html">kabc::formatfactory</option>,  <option value="classKABC_1_1Geo.html">kabc::geo</option>,  <option value="classKABC_1_1GuiErrorHandler.html">kabc::guierrorhandler</option>,  <option value="classKABC_1_1Key.html">kabc::key</option>,  <option value="classKABC_1_1Lock.html">kabc::lock</option>,  <option value="classKABC_1_1LockNull.html">kabc::locknull</option>,  <option value="classKABC_1_1NameSortMode.html">kabc::namesortmode</option>,  <option value="classKABC_1_1PhoneNumber.html">kabc::phonenumber</option>,  <option value="classKABC_1_1Picture.html">kabc::picture</option>,  <option value="classKABC_1_1Plugin.html">kabc::plugin</option>,  <option value="classKABC_1_1Resource.html">kabc::resource</option>,  <option value="classKABC_1_1Resource_1_1ConstIterator.html">kabc::resource::constiterator</option>,  <option value="classKABC_1_1ResourceABC.html">kabc::resourceabc</option>,  <option value="classKABC_1_1ResourceDir.html">kabc::resourcedir</option>,  <option value="classKABC_1_1ResourceFile.html">kabc::resourcefile</option>,  <option value="classKABC_1_1ResourceNet.html">kabc::resourcenet</option>,  <option value="classKABC_1_1SortMode.html">kabc::sortmode</option>,  <option value="classKABC_1_1Sound.html">kabc::sound</option>,  <option value="classKABC_1_1StdAddressBook.html">kabc::stdaddressbook</option>,  <option value="classKABC_1_1Ticket.html">kabc::ticket</option>,  <option value="classKABC_1_1TimeZone.html">kabc::timezone</option>,  <option value="classKABC_1_1VCardConverter.html">kabc::vcardconverter</option>,  <option value="classKABC_1_1VCardFormat.html">kabc::vcardformat</option>,  <option value="classLdif.html">ldif</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>