Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 98d6b53e11e983e268c3e19f14e091a0 > files > 3693

kdepim-devel-doc-3.5.9-9mdv2008.1.x86_64.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_US" xml:lang="en_US">

<head>
  <title>kpilot/lib: kpilotlocallink.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>kpilotlocallink.h</h1><a href="kpilotlocallink_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_KPILOTLOCALLINK_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _KPILOT_KPILOTLOCALLINK_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span><span class="comment">/*</span>
<a name="l00004"></a>00004 <span class="comment">**</span>
<a name="l00005"></a>00005 <span class="comment">** Copyright (C) 1998-2001 by Dan Pilone</span>
<a name="l00006"></a>00006 <span class="comment">** Copyright (C) 2003-2004 Reinhold Kainhofer &lt;reinhold@kainhofer.com&gt;</span>
<a name="l00007"></a>00007 <span class="comment">** Copyright (C) 2006 Adriaan de Groot &lt;groot@kde.org&gt;</span>
<a name="l00008"></a>00008 <span class="comment">**</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010 
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** This program is free software; you can redistribute it and/or modify</span>
<a name="l00013"></a>00013 <span class="comment">** it under the terms of the GNU Lesser General Public License as published by</span>
<a name="l00014"></a>00014 <span class="comment">** the Free Software Foundation; either version 2.1 of the License, or</span>
<a name="l00015"></a>00015 <span class="comment">** (at your option) any later version.</span>
<a name="l00016"></a>00016 <span class="comment">**</span>
<a name="l00017"></a>00017 <span class="comment">** This program is distributed in the hope that it will be useful,</span>
<a name="l00018"></a>00018 <span class="comment">** but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00019"></a>00019 <span class="comment">** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00020"></a>00020 <span class="comment">** GNU Lesser General Public License for more details.</span>
<a name="l00021"></a>00021 <span class="comment">**</span>
<a name="l00022"></a>00022 <span class="comment">** You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00023"></a>00023 <span class="comment">** along with this program in a file called COPYING; if not, write to</span>
<a name="l00024"></a>00024 <span class="comment">** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,</span>
<a name="l00025"></a>00025 <span class="comment">** MA 02110-1301, USA.</span>
<a name="l00026"></a>00026 <span class="comment">*/</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="comment">/*</span>
<a name="l00029"></a>00029 <span class="comment">** Bug reports and questions can be sent to kde-pim@kde.org</span>
<a name="l00030"></a>00030 <span class="comment">*/</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="kpilotlink_8h.html" title="Encapsulates all the communication with the handheld.">kpilotlink.h</a>"</span>
<a name="l00033"></a>00033 
<a name="l00043"></a><a class="code" href="classKPilotLocalLink.html">00043</a> <span class="keyword">class </span>KDE_EXPORT <a class="code" href="classKPilotLocalLink.html" title="Implementation of the device link for file-system backed (ie.">KPilotLocalLink</a> : <span class="keyword">public</span> <a class="code" href="classKPilotLink.html" title="KPilotLink handles some aspects of communication with a Handheld.">KPilotLink</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 Q_OBJECT
<a name="l00046"></a>00046 <span class="keyword">public</span>:
<a name="l00047"></a>00047     <a class="code" href="classKPilotLocalLink.html" title="Implementation of the device link for file-system backed (ie.">KPilotLocalLink</a>( QObject *parent=0L, <span class="keyword">const</span> <span class="keywordtype">char</span> *name=0L );
<a name="l00048"></a>00048     <span class="keyword">virtual</span> ~<a class="code" href="classKPilotLocalLink.html" title="Implementation of the device link for file-system backed (ie.">KPilotLocalLink</a>();
<a name="l00049"></a>00049 
<a name="l00050"></a>00050     <span class="keyword">virtual</span> QString <a class="code" href="classKPilotLink.html#b033fdc1c4365a18d6c6d63c3d92b0fc" title="Provides a human-readable status string.">statusString</a>() <span class="keyword">const</span>;
<a name="l00051"></a>00051     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKPilotLink.html#0d5cf7168473128b7b082876e892d536" title="True if HotSync has been started but not finished yet (ie.">isConnected</a>() <span class="keyword">const</span>;
<a name="l00052"></a>00052     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKPilotLink.html#3e877d552e0ef8f12c36389a76cefd55" title="Assuming things have been set up at least once already by a call to reset() with...">reset</a>( <span class="keyword">const</span> QString &amp; );
<a name="l00053"></a>00053     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKPilotLink.html#c0ec64e0d61b0035ae93c130b77fe9bd" title="Release all resources, including the master pilot socket, timers, etc.">close</a>();
<a name="l00054"></a>00054     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKPilotLink.html#3e877d552e0ef8f12c36389a76cefd55" title="Assuming things have been set up at least once already by a call to reset() with...">reset</a>();
<a name="l00055"></a>00055     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKPilotLink.html#a1aa03ed38c1c8940230fd66e6dfa1d2" title="Tickle the underlying device exactly once.">tickle</a>();
<a name="l00056"></a>00056     <span class="keyword">virtual</span> <span class="keyword">const</span> KPilotCard *<a class="code" href="classKPilotLink.html#12ac9c13081d1205f243c3aeae0cf5c3" title="Retrieve information about the data card card; I don&amp;#39;t think that any pilot supports...">getCardInfo</a>(<span class="keywordtype">int</span> card);
<a name="l00057"></a>00057     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKPilotLink.html#6a4e594890e7f2c8058802c619912fe9" title="End the sync in a gracuful manner.">endSync</a>( <a class="code" href="classKPilotLink.html#61758d52e6a0684866d82f5ba224f8c9" title="When ending the sync, you can do so gracefully, updating the last-sync time to indicate...">EndOfSyncFlags</a> f );
<a name="l00058"></a>00058     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKPilotLink.html#601d9f9b8455f186ab2fe96128f05615" title="Notify the Pilot user that a conduit is running now.">openConduit</a>();
<a name="l00059"></a>00059     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKPilotLink.html#8ba42e37753719be725e16096e82ac57" title="Fill the DBInfo structure db with information about the next database (in some ordering)...">getNextDatabase</a>(<span class="keywordtype">int</span> index,<span class="keyword">struct</span> DBInfo *);
<a name="l00060"></a>00060     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKPilotLink.html#2ad0890c23f6ddea8032eb44be665c79" title="Find a database with the given name (and optionally, type type and creator ID (from...">findDatabase</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">struct</span> DBInfo*,
<a name="l00061"></a>00061         <span class="keywordtype">int</span> index=0, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> type=0, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> creator=0);
<a name="l00062"></a>00062     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKPilotLink.html#1f99fd2affb3555a87811db2568c9ea0" title="Retrieve the database indicated by DBInfo *db into the local file path.">retrieveDatabase</a>(<span class="keyword">const</span> QString &amp;path, <span class="keyword">struct</span> DBInfo *db);
<a name="l00063"></a>00063     <span class="keyword">virtual</span> DBInfoList <a class="code" href="classKPilotLink.html#d385f4be335cf3cb503b8a6164a4d70d" title="Returns a list of DBInfo structures describing all the databases available on the...">getDBList</a>(<span class="keywordtype">int</span> cardno=0, <span class="keywordtype">int</span> flags=dlpDBListRAM);
<a name="l00064"></a>00064     <span class="keyword">virtual</span> <a class="code" href="classPilotDatabase.html" title="Methods to access a database on the pilot.">PilotDatabase</a> *<a class="code" href="classKPilotLink.html#94735b8dc57f66856f805b67945c5b7e" title="Return a database object for manipulating the database with name name on the link...">database</a>( <span class="keyword">const</span> QString &amp;name );
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="keyword">public</span> slots:
<a name="l00067"></a>00067     <span class="keywordtype">void</span> ready();
<a name="l00068"></a>00068 
<a name="l00069"></a>00069 <span class="keyword">protected</span>:
<a name="l00070"></a>00070     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKPilotLink.html#1f0a3f6c244b3324ecd44b8b1135e3b5" title="Install a single file onto the device link.">installFile</a>(<span class="keyword">const</span> QString &amp;, <span class="keyword">const</span> <span class="keywordtype">bool</span> deleteFile);
<a name="l00071"></a>00071     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKPilotLink.html#8b1f27c4461a0f91589e9e34b0e46812" title="Actually write an entry to the device link.">addSyncLogEntryImpl</a>( <span class="keyword">const</span> QString &amp;s );
<a name="l00072"></a><a class="code" href="classKPilotLocalLink.html#457309503c1c5c2c4883163c6740ee08">00072</a>     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classKPilotLink.html#12c8cf7bd8cc77246a8ca47ce23877ec" title="Returns a file handle for raw operations.">pilotSocket</a>()<span class="keyword"> const</span>
<a name="l00073"></a>00073 <span class="keyword">    </span>{
<a name="l00074"></a>00074         <span class="keywordflow">return</span> -1;
<a name="l00075"></a>00075     }
<a name="l00076"></a>00076 
<a name="l00077"></a>00077 <span class="keyword">protected</span>:
<a name="l00078"></a>00078     <span class="keywordtype">bool</span> fReady;
<a name="l00079"></a>00079     QString fPath;
<a name="l00080"></a>00080 
<a name="l00081"></a>00081     <span class="keyword">class </span>Private;
<a name="l00082"></a>00082     Private *d;
<a name="l00083"></a>00083 
<a name="l00090"></a>00090     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> findAvailableDatabases( Private &amp;, <span class="keyword">const</span> QString &amp;path );
<a name="l00091"></a>00091 } ;
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 
<a name="l00094"></a>00094 <span class="preprocessor">#endif</span>
<a name="l00095"></a>00095 <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>&nbsp;&nbsp;<a href="../../../akregator/src/html/index.html">src</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>