<?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_US" xml:lang="en_US">
<head>
<title>kpilot/lib: recordConduit.h Source File (kpilot/lib)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<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" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../../">API Reference</a>
/ <a href="../../html/index.html">kpilot</a> / <a href=".">lib</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>kpilot/lib</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>recordConduit.h</h1><a href="recordConduit_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef _KPILOT_RECORDCONDUIT_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _KPILOT_RECORDCONDUIT_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span><span class="comment">/* record-conduit.h KPilot</span>
<a name="l00004"></a>00004 <span class="comment">**</span>
<a name="l00005"></a>00005 <span class="comment">** Copyright (C) 2005 by Adriaan de Groot</span>
<a name="l00006"></a>00006 <span class="comment">**</span>
<a name="l00007"></a>00007 <span class="comment">*/</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="comment">/*</span>
<a name="l00010"></a>00010 <span class="comment">** This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment">** it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment">** the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00013"></a>00013 <span class="comment">** (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment">**</span>
<a name="l00015"></a>00015 <span class="comment">** This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment">** but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment">** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00018"></a>00018 <span class="comment">** GNU General Public License for more details.</span>
<a name="l00019"></a>00019 <span class="comment">**</span>
<a name="l00020"></a>00020 <span class="comment">** You should have received a copy of the GNU General Public License</span>
<a name="l00021"></a>00021 <span class="comment">** along with this program in a file called COPYING; if not, write to</span>
<a name="l00022"></a>00022 <span class="comment">** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,</span>
<a name="l00023"></a>00023 <span class="comment">** MA 02110-1301, USA.</span>
<a name="l00024"></a>00024 <span class="comment">*/</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="comment">/*</span>
<a name="l00027"></a>00027 <span class="comment">** Bug reports and questions can be sent to kde-pim@kde.org</span>
<a name="l00028"></a>00028 <span class="comment">*/</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#include <qtimer.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <klocale.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="plugin_8h.html" title="This file defines the base class of all KPilot conduit plugins configuration dialogs...">plugin.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="pilot_8h.html" title="These are some base structures that reside on the handheld device -- strings and...">pilot.h</a>"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="pilotDatabase_8h.html" title="This is the abstract base class for databases, which is used both by local databases...">pilotDatabase.h</a>"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include "kpilotdevicelink.h"</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="classKPilotDeviceLink.html" title="Definition of the device link class for physical handheld devices, which communicate...">KPilotDeviceLink</a>;
<a name="l00039"></a>00039
<a name="l00056"></a><a class="code" href="classRecordConduitBase.html">00056</a> <span class="keyword">class </span><a class="code" href="classRecordConduitBase.html" title="An intermediate class that introduces the slots we need for our sync implementation...">RecordConduitBase</a> : <span class="keyword">public</span> <a class="code" href="classConduitAction.html" title="The SyncActions created by the factory should obey at least the argument test, indicating...">ConduitAction</a>
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 Q_OBJECT
<a name="l00059"></a>00059 <span class="keyword">public</span>:
<a name="l00062"></a><a class="code" href="classRecordConduitBase.html#a16e5cfe1cc8d6e50a9cd1e29557299f">00062</a> <a class="code" href="classRecordConduitBase.html#a16e5cfe1cc8d6e50a9cd1e29557299f" title="Constructor.">RecordConduitBase</a>(<a class="code" href="classKPilotDeviceLink.html" title="Definition of the device link class for physical handheld devices, which communicate...">KPilotDeviceLink</a> *o,
<a name="l00063"></a>00063 <span class="keyword">const</span> <span class="keywordtype">char</span> *n,
<a name="l00064"></a>00064 <span class="keyword">const</span> QStringList a = QStringList()) :
<a name="l00065"></a>00065 <a class="code" href="classConduitAction.html" title="The SyncActions created by the factory should obey at least the argument test, indicating...">ConduitAction</a>(o,n,a),
<a name="l00066"></a>00066 fTimer(0L)
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 } ;
<a name="l00070"></a><a class="code" href="classRecordConduitBase.html#1a3b61a2c75d8280b1a642a7560bc9d7">00070</a> <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#1a3b61a2c75d8280b1a642a7560bc9d7" title="Destructor.">~RecordConduitBase</a>()
<a name="l00071"></a>00071 {
<a name="l00072"></a>00072 <span class="comment">// delete fTimer; // Timer is a child object</span>
<a name="l00073"></a>00073 } ;
<a name="l00074"></a>00074
<a name="l00080"></a><a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd">00080</a> <span class="keyword">enum</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> { NotDone=0, Done=1, Error=2 } ;
<a name="l00081"></a>00081
<a name="l00083"></a>00083 <span class="keyword">static</span> QString <a class="code" href="classRecordConduitBase.html#d3c91af90d82f0473fb74eec11faea80" title="Returns a human-readable name for the progress indicator s.">name</a>(<a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> s);
<a name="l00084"></a>00084
<a name="l00086"></a><a class="code" href="classRecordConduitBase.html#2bd949f937a98ab87c2f2ff3c0bc32d6">00086</a> <span class="keyword">enum</span> <a class="code" href="classRecordConduitBase.html#2bd949f937a98ab87c2f2ff3c0bc32d6" title="State of the conduit&#39;s sync.">States</a> { Initialize, PalmToPC, PCToPalm, Cleanup } ;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">static</span> QString <a class="code" href="classRecordConduitBase.html#d3c91af90d82f0473fb74eec11faea80" title="Returns a human-readable name for the progress indicator s.">name</a>(<a class="code" href="classRecordConduitBase.html#2bd949f937a98ab87c2f2ff3c0bc32d6" title="State of the conduit&#39;s sync.">States</a> s);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keyword">protected</span>:
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#46d53de983a92c4c60f59c6c2cc2ab34" title="Function called at the beginning of a sync to load data from the PC.">loadPC</a>() = 0;
<a name="l00096"></a>00096
<a name="l00103"></a>00103 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#d3311bbc11c7758f26dc51981e5c53d4" title="Function called repeatedly to fetch the next modified entry from the Palm and sync...">palmRecToPC</a>() = 0;
<a name="l00104"></a>00104
<a name="l00111"></a>00111 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#bc33f656a98a63d998940908951f4662" title="Function called repeatedly to fetch the next modified entry from the PC and sync...">pcRecToPalm</a>() = 0;
<a name="l00112"></a>00112
<a name="l00119"></a>00119 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#118ec8b0b7111d2f0edae30f91309ed4" title="Function called at the end of this conduit&#39;s sync, which should reset DB flags...">cleanup</a>() = 0;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">protected</span> slots:
<a name="l00125"></a>00125 <span class="keywordtype">void</span> <a class="code" href="classRecordConduitBase.html#94ef5284514abdc0b4b75ac6256c3020" title="Slot used for the implementation of a state machine: calls each of the relevant other...">process</a>();
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">protected</span>:
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> exec();
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keyword">private</span>:
<a name="l00132"></a>00132 QTimer *fTimer;
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <a class="code" href="classRecordConduitBase.html#2bd949f937a98ab87c2f2ff3c0bc32d6" title="State of the conduit&#39;s sync.">States</a> fState;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 Pilot::RecordIDList fIDList;
<a name="l00137"></a>00137 Pilot::RecordIDList::Iterator fIDListIterator;
<a name="l00138"></a>00138
<a name="l00139"></a>00139 QString fDBName;
<a name="l00140"></a>00140 } ;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">template</span> <<span class="keyword">class</span> PCEntry, <span class="keyword">class</span> PCContainer, <span class="keyword">class</span> HHEntry, <span class="keyword">class</span> HHAppInfo, <span class="keyword">class</span> Syncer>
<a name="l00143"></a>00143 <span class="keyword">class </span>RecordConduit : <span class="keyword">public</span> <a class="code" href="classRecordConduitBase.html" title="An intermediate class that introduces the slots we need for our sync implementation...">RecordConduitBase</a>
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="keyword">public</span>:
<a name="l00147"></a>00147 RecordConduit(
<a name="l00148"></a>00148 <a class="code" href="classKPilotDeviceLink.html" title="Definition of the device link class for physical handheld devices, which communicate...">KPilotDeviceLink</a> *o ,
<a name="l00149"></a>00149 <span class="keyword">const</span> <span class="keywordtype">char</span> *n ,
<a name="l00150"></a>00150 <span class="keyword">const</span> QStringList a = QStringList() ) :
<a name="l00151"></a>00151 <a class="code" href="classRecordConduitBase.html" title="An intermediate class that introduces the slots we need for our sync implementation...">RecordConduitBase</a>(o,n,a)
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 } ;
<a name="l00154"></a>00154 <span class="keyword">virtual</span> ~RecordConduit()
<a name="l00155"></a>00155 {
<a name="l00156"></a>00156 } ;
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#46d53de983a92c4c60f59c6c2cc2ab34" title="Function called at the beginning of a sync to load data from the PC.">loadPC</a>()
<a name="l00159"></a>00159 {
<a name="l00160"></a>00160 <span class="keywordflow">return</span> Done;
<a name="l00161"></a>00161 } ;
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#d3311bbc11c7758f26dc51981e5c53d4" title="Function called repeatedly to fetch the next modified entry from the Palm and sync...">palmRecToPC</a>()
<a name="l00164"></a>00164 {
<a name="l00165"></a>00165 <span class="keywordflow">return</span> Done;
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#bc33f656a98a63d998940908951f4662" title="Function called repeatedly to fetch the next modified entry from the PC and sync...">pcRecToPalm</a>()
<a name="l00169"></a>00169 {
<a name="l00170"></a>00170 <span class="keywordflow">return</span> Done;
<a name="l00171"></a>00171 }
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">virtual</span> <a class="code" href="classRecordConduitBase.html#7742f57d67cb7255643a21921192a3dd" title="Return values for the processing functions.">SyncProgress</a> <a class="code" href="classRecordConduitBase.html#118ec8b0b7111d2f0edae30f91309ed4" title="Function called at the end of this conduit&#39;s sync, which should reset DB flags...">cleanup</a>()
<a name="l00174"></a>00174 {
<a name="l00175"></a>00175 <span class="keywordflow">return</span> Done;
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 } ;
<a name="l00178"></a>00178
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="preprocessor">#endif</span>
<a name="l00181"></a>00181 <span class="preprocessor"></span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kpilot/lib</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</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="classActionQueue.html">actionqueue</option>, <option value="classCleanupAction.html">cleanupaction</option>, <option value="classConduitAction.html">conduitaction</option>, <option value="classConduitConfigBase.html">conduitconfigbase</option>, <option value="classConduitFactory.html">conduitfactory</option>, <option value="classConduitProxy.html">conduitproxy</option>, <option value="classCUDCounter.html">cudcounter</option>, <option value="classDatabaseInterpreter.html">databaseinterpreter</option>, <option value="classDeviceCommThread.html">devicecommthread</option>, <option value="classIDMapper.html">idmapper</option>, <option value="classKPilotDeviceLink.html">kpilotdevicelink</option>, <option value="classKPilotLink.html">kpilotlink</option>, <option value="classKPilotLocalLink.html">kpilotlocallink</option>, <option value="classNullMapper.html">nullmapper</option>, <option value="classPhoneSlot.html">phoneslot</option>, <option value="classPilotAddress.html">pilotaddress</option>, <option value="classPilotAppInfo.html">pilotappinfo</option>, <option value="classPilotAppInfoBase.html">pilotappinfobase</option>, <option value="classPilotDatabase.html">pilotdatabase</option>, <option value="classPilotDateEntry.html">pilotdateentry</option>, <option value="classPilotLocalDatabase.html">pilotlocaldatabase</option>, <option value="classPilotRecord.html">pilotrecord</option>, <option value="classPilotRecordBase.html">pilotrecordbase</option>, <option value="classPilotSerialDatabase.html">pilotserialdatabase</option>, <option value="classPilotTodoEntry.html">pilottodoentry</option>, <option value="classRecordConduitBase.html">recordconduitbase</option>, <option value="classSorryAction.html">sorryaction</option>, <option value="classSyncAction_1_1SyncMode.html">syncaction::syncmode</option>, <option value="classTestLink.html">testlink</option>, <option value="classWelcomeAction.html">welcomeaction</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../akregator/html/index.html">akregator</a></li><li> <a href="../../../akregator/src/html/index.html">src</a></li><li> <a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../../kandy/html/index.html">kandy</a></li><li><a href="../../../karm/html/index.html">karm</a></li><li><a href="../../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../../kgantt/html/index.html">kgantt</a></li><li><a href="../../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../../kmail/html/index.html">kmail</a></li><li><a href="../../../knotes/html/index.html">knotes</a></li><li><a href="../../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../../kontact/html/index.html">kontact</a></li><li><a href="../../../korganizer/html/index.html">korganizer</a></li><li><a href="../../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../../libkcal/html/index.html">libkcal</a></li><li><a href="../../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../../libkmime/html/index.html">libkmime</a></li><li><a href="../../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
