<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qorganizermanagerenginefactory.cpp -->
<title>Qt Mobility 1.2: QOrganizerManagerEngineFactory Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtorganizer.html">QtOrganizer</a></li>
<li>QOrganizerManagerEngineFactory</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QOrganizerManagerEngineFactory Class Reference</h1>
<!-- $$$QOrganizerManagerEngineFactory-brief -->
<p>The QOrganizerManagerEngineFactory class provides the interface for plugins that implement <a href="qorganizermanagerengine.html">QOrganizerManagerEngine</a> functionality. <a href="#details">More...</a></p>
<!-- @@@QOrganizerManagerEngineFactory -->
<pre class="cpp"> <span class="preprocessor">#include <QOrganizerManagerEngineFactory></span></pre><p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qorganizermanagerenginefactory-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qorganizermanagerenginefactory.html#dtor.QOrganizerManagerEngineFactory">~QOrganizerManagerEngineFactory</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QOrganizerCollectionEngineId * </td><td class="memItemRight bottomAlign"><b><a href="qorganizermanagerenginefactory.html#createCollectionEngineId">createCollectionEngineId</a></b> ( const QMap<QString, QString> & <i>parameters</i>, const QString & <i>engineIdString</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QOrganizerItemEngineId * </td><td class="memItemRight bottomAlign"><b><a href="qorganizermanagerenginefactory.html#createItemEngineId">createItemEngineId</a></b> ( const QMap<QString, QString> & <i>parameters</i>, const QString & <i>engineIdString</i> ) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QOrganizerManagerEngine * </td><td class="memItemRight bottomAlign"><b><a href="qorganizermanagerenginefactory.html#engine">engine</a></b> ( const QMap<QString, QString> & <i>parameters</i>, QOrganizerManager::Error * <i>error</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizermanagerenginefactory.html#managerName">managerName</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<int> </td><td class="memItemRight bottomAlign"><b><a href="qorganizermanagerenginefactory.html#supportedImplementationVersions">supportedImplementationVersions</a></b> () const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QOrganizerManagerEngineFactory-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QOrganizerManagerEngineFactory class provides the interface for plugins that implement <a href="qorganizermanagerengine.html">QOrganizerManagerEngine</a> functionality.</p>
<p>This class provides a simple interface for the creation of manager engine instances. Each factory has a specific id associated with it, which forms the <tt>managerName</tt> parameter when creating <a href="qorganizermanager.html">QOrganizerManager</a> objects.</p>
<p>More information on writing a organizeritems engine plugin is available in the <a href="organizerengines.html">Qt Organizer Manager Engines</a> documentation.</p>
</div>
<p><b>See also </b><a href="qorganizermanager.html">QOrganizerManager</a> and <a href="qorganizermanagerengine.html">QOrganizerManagerEngine</a>.</p>
<!-- @@@QOrganizerManagerEngineFactory -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$~QOrganizerManagerEngineFactory[overload1]$$$~QOrganizerManagerEngineFactory -->
<h3 class="fn"><a name="dtor.QOrganizerManagerEngineFactory"></a>QOrganizerManagerEngineFactory::<span class="name">~QOrganizerManagerEngineFactory</span> ()<tt> [virtual]</tt></h3>
<p>A default, empty destructor.</p>
<!-- @@@~QOrganizerManagerEngineFactory -->
<!-- $$$createCollectionEngineId[overload1]$$$createCollectionEngineIdconstQMap<QString,QString>&constQString& -->
<h3 class="fn"><a name="createCollectionEngineId"></a><span class="type"><a href="qorganizercollectionid.html">QOrganizerCollectionEngineId</a></span> * QOrganizerManagerEngineFactory::<span class="name">createCollectionEngineId</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qmap.html">QMap</a></span><<span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>> & <i>parameters</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>engineIdString</i> ) const<tt> [pure virtual]</tt></h3>
<p>This function is used internally when deserializing an id. It allows the deserialization functions to correctly allocate an engine-specific id for an item, filled with the serialized data <i>engineIdString</i>.</p>
<p>Since the format of the id might be different depending on the construction parameters <i>parameters</i>, these parameters are passed to the factory implementation of this function.</p>
<p>Engine implementers must implement this function, but should not need to call it.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@createCollectionEngineId -->
<!-- $$$createItemEngineId[overload1]$$$createItemEngineIdconstQMap<QString,QString>&constQString& -->
<h3 class="fn"><a name="createItemEngineId"></a><span class="type"><a href="qorganizeritemid.html">QOrganizerItemEngineId</a></span> * QOrganizerManagerEngineFactory::<span class="name">createItemEngineId</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qmap.html">QMap</a></span><<span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>> & <i>parameters</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>engineIdString</i> ) const<tt> [pure virtual]</tt></h3>
<p>This function is used internally when deserializing an id. It allows the deserialization functions to correctly allocate an engine-specific id for a collection, filled with the serialized data <i>engineIdString</i>.</p>
<p>Since the format of the id might be different depending on the construction parameters <i>parameters</i>, these parameters are passed to the factory implementation of this function.</p>
<p>Engine implementers must implement this function, but should not need to call it.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@createItemEngineId -->
<!-- $$$engine[overload1]$$$engineconstQMap<QString,QString>&QOrganizerManager::Error* -->
<h3 class="fn"><a name="engine"></a><span class="type"><a href="qorganizermanagerengine.html">QOrganizerManagerEngine</a></span> * QOrganizerManagerEngineFactory::<span class="name">engine</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qmap.html">QMap</a></span><<span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>> & <i>parameters</i>, <span class="type"><a href="qorganizermanager.html#Error-enum">QOrganizerManager::Error</a></span> * <i>error</i> )<tt> [pure virtual]</tt></h3>
<p>This function is called by the <a href="qorganizermanager.html">QOrganizerManager</a> implementation to create an instance of the engine provided by this factory.</p>
<p>The <i>parameters</i> supplied can be ignored or interpreted as desired.</p>
<p>If a supplied parameter results in an unfulfillable request, or some other error occurs, this function may return a null pointer, and the client developer will get an invalid <a href="qorganizermanager.html">QOrganizerManager</a> in return. Any error should be stored in the supplied <i>error</i> reference.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@engine -->
<!-- $$$managerName[overload1]$$$managerName -->
<h3 class="fn"><a name="managerName"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerManagerEngineFactory::<span class="name">managerName</span> () const<tt> [pure virtual]</tt></h3>
<p>This function should return a unique string that identifies the engines provided by this factory.</p>
<p>Typically this would be of the form "com.nokia.qt.organizeritems.engines.memory", with the appropriate domain and engine name substituted.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@managerName -->
<!-- $$$supportedImplementationVersions[overload1]$$$supportedImplementationVersions -->
<h3 class="fn"><a name="supportedImplementationVersions"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type">int</span>> QOrganizerManagerEngineFactory::<span class="name">supportedImplementationVersions</span> () const<tt> [virtual]</tt></h3>
<p>This function should return a list of versions of the engine which this factory can instantiate.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@supportedImplementationVersions -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
Free Documentation License version 1.3</a>
as published by the Free Software Foundation.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
1632
