Sophie

Sophie

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

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: Pilot Namespace Reference (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 -->
<div class="contents">
<h1>Pilot Namespace Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a> namespace holds constants that are global for the handheld data structures. 
<p>
Also contains some global functions that deal with pilot-link structures as well as mapping user-visible strings from UTF8 (KDE side) to the encoding used on the handheld. 
<p>

<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPilot_1_1dlp.html">dlp</a></td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7608212218a05c74abc73296e623d0bb"></a><!-- doxytag: member="Pilot::RecordIDList" ref="7608212218a05c74abc73296e623d0bb" args="" -->
typedef QValueList&lt; recordid_t &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>RecordIDList</b></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#4746335eaede45736f303bf53f12732d">fromPilot</a> (const char *c, int len)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#0c0bb29ad6b8951313c6357a81ae801e">fromPilot</a> (const char *c)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QCString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#9d13e87df66389043e9db1a76c413f57">toPilot</a> (const QString &amp;s)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#1dd17dad18945adf557fb75a6e57bbd9">toPilot</a> (const QString &amp;s, char *buf, int len)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23b63087ee2200d523b44e349e6dc0ec"></a><!-- doxytag: member="Pilot::toPilot" ref="23b63087ee2200d523b44e349e6dc0ec" args="(const QString &amp;s, unsigned char *buf, int len)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>toPilot</b> (const QString &amp;s, unsigned char *buf, int len)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#8608c55a611720248d50ed69bcb63682">setupPilotCodec</a> (const QString &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#dad55df93cfac15062fff0c96d34012c">codecName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7ba98264eb62bab04fb57041881db03"></a><!-- doxytag: member="Pilot::category" ref="a7ba98264eb62bab04fb57041881db03" args="(const struct CategoryAppInfo *info, unsigned int i)" -->
QString&nbsp;</td><td class="memItemRight" valign="bottom"><b>category</b> (const struct CategoryAppInfo *info, unsigned int i)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#272ddda9b1cb1774eb3a6874ad55c1bd">findCategory</a> (const struct CategoryAppInfo *info, const QString &amp;name, bool unknownIsUnfiled)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#e7e0a58694dbedd382da805f97cf1589">insertCategory</a> (struct CategoryAppInfo *info, const QString &amp;label, bool unknownIsUnfiled)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#324d8fbe1b0e366523a12d783511dc1e">dumpCategories</a> (const struct CategoryAppInfo *info)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#f506cc856485b64de6ad689e6579b626">validCategory</a> (int c)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#405e02c7865d918ebbda94103b441081">categoryName</a> (const struct CategoryAppInfo *info, unsigned int i)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#400c34cc5192768e7800ad8aa00020d5">categoryNames</a> (const struct CategoryAppInfo *info)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#ea0468d9e798887a30da92defe68d71c">isResource</a> (struct DBInfo *info)</td></tr>

<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="778fd7df8c28dbc69080fa5d240d0d2f"></a><!-- doxytag: member="Pilot::codec" ref="778fd7df8c28dbc69080fa5d240d0d2f" args="" -->
static QTextCodec *&nbsp;</td><td class="memItemRight" valign="bottom"><b>codec</b> = 0L</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c26bcf6b19bc852e39201b80ca8788ea"></a><!-- doxytag: member="Pilot::mutex" ref="c26bcf6b19bc852e39201b80ca8788ea" args="" -->
static QMutex *&nbsp;</td><td class="memItemRight" valign="bottom"><b>mutex</b> = 0L</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#8f4195399f8299777272c29eff80ffbc">MAX_APPINFO_SIZE</a> = 8192</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#9a9cc19ceb012416519a533ec4829a44">CATEGORY_COUNT</a> = 16</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#661a223640a58908d6a5dcddb33e6167">CATEGORY_SIZE</a> = 16</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#4691c23018a8d4d001cc546b3040f258">Unfiled</a> = 0</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#bc99e5c63ee32c8b2c3022778ddabb5f">MAX_RECORD_SIZE</a> = 65535</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacePilot.html#747e9f7c7d7ce5e5b599fa1a70e15d40">PLUGIN_API</a> = 20061118</td></tr>

</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="405e02c7865d918ebbda94103b441081"></a><!-- doxytag: member="Pilot::categoryName" ref="405e02c7865d918ebbda94103b441081" args="(const struct CategoryAppInfo *info, unsigned int i)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Pilot::categoryName           </td>
          <td>(</td>
          <td class="paramtype">const struct CategoryAppInfo *&nbsp;</td>
          <td class="paramname"> <em>info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>i</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the QString for the requested category <code>i</code> in the category structure <code>info</code>. 
<p>
Returns <code>QString::null</code> on error (bad pointer or bad category number). May also return <code>QString::null</code> if the category name is empty. 
<p>Definition at line <a class="el" href="pilot_8h-source.html#l00148">148</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="400c34cc5192768e7800ad8aa00020d5"></a><!-- doxytag: member="Pilot::categoryNames" ref="400c34cc5192768e7800ad8aa00020d5" args="(const struct CategoryAppInfo *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QStringList Pilot::categoryNames           </td>
          <td>(</td>
          <td class="paramtype">const struct CategoryAppInfo *&nbsp;</td>
          <td class="paramname"> <em>info</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns a list of all the category names available on the handheld. 
<p>
This list is neither ordered nor does it contain all sixteen categories -- empty category names on the handheld are skipped. 
<p>Definition at line <a class="el" href="pilot_8h-source.html#l00169">169</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="dad55df93cfac15062fff0c96d34012c"></a><!-- doxytag: member="Pilot::codecName" ref="dad55df93cfac15062fff0c96d34012c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Pilot::codecName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the name of the codec being used. 
<p>

<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00138">138</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="324d8fbe1b0e366523a12d783511dc1e"></a><!-- doxytag: member="Pilot::dumpCategories" ref="324d8fbe1b0e366523a12d783511dc1e" args="(const struct CategoryAppInfo *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Pilot::dumpCategories           </td>
          <td>(</td>
          <td class="paramtype">const struct CategoryAppInfo *&nbsp;</td>
          <td class="paramname"> <em>info</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
For debugging, display category names for the given AppInfo structure. 
<p>
Called by dump(). You must pass a valid reference. 
<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00240">240</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="272ddda9b1cb1774eb3a6874ad55c1bd"></a><!-- doxytag: member="Pilot::findCategory" ref="272ddda9b1cb1774eb3a6874ad55c1bd" args="(const struct CategoryAppInfo *info, const QString &amp;name, bool unknownIsUnfiled)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Pilot::findCategory           </td>
          <td>(</td>
          <td class="paramtype">const struct CategoryAppInfo *&nbsp;</td>
          <td class="paramname"> <em>info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>unknownIsUnfiled</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Search for the given category <code>name</code> in the list of categories; returns the category number. 
<p>
If <code>unknownIsUnfiled</code> is true, then map unknown categories to Unfiled instead of returning an error number.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 is a specific category based on the text-to- category number mapping defined by the <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a>, where 0 is always the 'unfiled' category. <p>
-1 means unknown category selected when <code>unknownIsUnfiled</code> is false. <p>
0 == Unfiled means unknown category selected when <code>unknownIsUnfiled</code> is true. </dd></dl>

<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00158">158</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="0c0bb29ad6b8951313c6357a81ae801e"></a><!-- doxytag: member="Pilot::fromPilot" ref="0c0bb29ad6b8951313c6357a81ae801e" args="(const char *c)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Pilot::fromPilot           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>c</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Static translation function mapping a NUL-terminated string from the handheld's encoding to UTF-8. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>the NUL-terminated string to decode </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>QString (UTF-8) value of <code>c</code> </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>NUL-terminated strings are rare on the handheld. </dd></dl>

<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00059">59</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="4746335eaede45736f303bf53f12732d"></a><!-- doxytag: member="Pilot::fromPilot" ref="4746335eaede45736f303bf53f12732d" args="(const char *c, int len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString Pilot::fromPilot           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>c</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Static translation function that maps handheld native (8 bit, usually latin1 but sometimes someting else) encoded data to a Unicode string. 
<p>
Converts the <code>len</code> characters in <code>c</code> to a Unicode string. 
<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00051">51</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="e7e0a58694dbedd382da805f97cf1589"></a><!-- doxytag: member="Pilot::insertCategory" ref="e7e0a58694dbedd382da805f97cf1589" args="(struct CategoryAppInfo *info, const QString &amp;label, bool unknownIsUnfiled)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Pilot::insertCategory           </td>
          <td>(</td>
          <td class="paramtype">struct CategoryAppInfo *&nbsp;</td>
          <td class="paramname"> <em>info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>label</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>unknownIsUnfiled</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Search for the given category <code>name</code> in the list of categories; returns the category number. 
<p>
If <code>unknownIsUnfiled</code> is <code>true</code>, then map unknown categories to Unfiled. If <code>unknownIsUnfiled</code> is <code>false</code>, insert a <em>new</em> category into the structure and return the category number of the new category. Return -1 if (and only if) <code>unknownIsUnfiled</code> is false and the category structure is already full.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 is a specific category based on the text-to- category number mapping defined by the <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a>, where 0 is always the 'unfiled' category. <p>
0 Unknown category and <code>unknownIsUnfiled</code> is <code>true</code> <p>
-1 means unknown category selected when <code>unknownIsUnfiled</code> is false and categories are all full. </dd></dl>

<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00196">196</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="ea0468d9e798887a30da92defe68d71c"></a><!-- doxytag: member="Pilot::isResource" ref="ea0468d9e798887a30da92defe68d71c" args="(struct DBInfo *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool Pilot::isResource           </td>
          <td>(</td>
          <td class="paramtype">struct DBInfo *&nbsp;</td>
          <td class="paramname"> <em>info</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The handheld also holds data about each database in a DBInfo structure; check if the database described by this structure is a resource database. 
<p>

<p>Definition at line <a class="el" href="pilot_8h-source.html#l00227">227</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="8608c55a611720248d50ed69bcb63682"></a><!-- doxytag: member="Pilot::setupPilotCodec" ref="8608c55a611720248d50ed69bcb63682" args="(const QString &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Pilot::setupPilotCodec           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a codec for translating handheld native 8 bit to Unicode, using the given codec <code>name</code> -- this will often be latin1, but might be something else for, say, Russian-language Pilots. 
<p>
If <code>name</code> is empty, use latin1.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> otherwise </dd></dl>

<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00116">116</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="1dd17dad18945adf557fb75a6e57bbd9"></a><!-- doxytag: member="Pilot::toPilot" ref="1dd17dad18945adf557fb75a6e57bbd9" args="(const QString &amp;s, char *buf, int len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Pilot::toPilot           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Static translation function that maps a QString onto the native 8 bit encoding of the handheld. 
<p>
Writes the result into the buffer <code>buf</code> which has size <code>len</code>. Returns the length of the result. Zero-fills the buffer as needed. 
<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00075">75</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="9d13e87df66389043e9db1a76c413f57"></a><!-- doxytag: member="Pilot::toPilot" ref="9d13e87df66389043e9db1a76c413f57" args="(const QString &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QCString Pilot::toPilot           </td>
          <td>(</td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Static translation function that maps a QString onto the native 8 bit encoding of the handheld. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>String to encode </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Encoded string in a QCString </dd></dl>

<p>Definition at line <a class="el" href="pilot_8cc-source.html#l00067">67</a> of file <a class="el" href="pilot_8cc-source.html">pilot.cc</a>.</p>

</div>
</div><p>
<a class="anchor" name="f506cc856485b64de6ad689e6579b626"></a><!-- doxytag: member="Pilot::validCategory" ref="f506cc856485b64de6ad689e6579b626" args="(int c)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Pilot::validCategory           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>c</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check that a given category number is valid. 
<p>
This restricts the range of integers to [0..CATEGORY_COUNT-1] (i.e. [0..15]) which is what the handheld supports. 
<p>Definition at line <a class="el" href="pilot_8h-source.html#l00134">134</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="9a9cc19ceb012416519a533ec4829a44"></a><!-- doxytag: member="Pilot::CATEGORY_COUNT" ref="9a9cc19ceb012416519a533ec4829a44" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="namespacePilot.html#9a9cc19ceb012416519a533ec4829a44">Pilot::CATEGORY_COUNT</a> = 16<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Maximum number of categories the handheld has. 
<p>

<p>Definition at line <a class="el" href="pilot_8h-source.html#l00069">69</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="661a223640a58908d6a5dcddb33e6167"></a><!-- doxytag: member="Pilot::CATEGORY_SIZE" ref="661a223640a58908d6a5dcddb33e6167" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="namespacePilot.html#661a223640a58908d6a5dcddb33e6167">Pilot::CATEGORY_SIZE</a> = 16<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Maximum size of a category label. 
<p>

<p>Definition at line <a class="el" href="pilot_8h-source.html#l00072">72</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="8f4195399f8299777272c29eff80ffbc"></a><!-- doxytag: member="Pilot::MAX_APPINFO_SIZE" ref="8f4195399f8299777272c29eff80ffbc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="namespacePilot.html#8f4195399f8299777272c29eff80ffbc">Pilot::MAX_APPINFO_SIZE</a> = 8192<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Maximum size of an AppInfo block, taken roughly from the pilot-link source. 
<p>

<p>Definition at line <a class="el" href="pilot_8h-source.html#l00066">66</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="bc99e5c63ee32c8b2c3022778ddabb5f"></a><!-- doxytag: member="Pilot::MAX_RECORD_SIZE" ref="bc99e5c63ee32c8b2c3022778ddabb5f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="namespacePilot.html#bc99e5c63ee32c8b2c3022778ddabb5f">Pilot::MAX_RECORD_SIZE</a> = 65535<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Maximum size (in bytes) of a record's data. 
<p>

<p>Definition at line <a class="el" href="pilot_8h-source.html#l00078">78</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="747e9f7c7d7ce5e5b599fa1a70e15d40"></a><!-- doxytag: member="Pilot::PLUGIN_API" ref="747e9f7c7d7ce5e5b599fa1a70e15d40" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="namespacePilot.html#747e9f7c7d7ce5e5b599fa1a70e15d40">Pilot::PLUGIN_API</a> = 20061118<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
As the API for conduits may change in the course of time, identify them and refuse to load incompatible API versions. 
<p>
Bump this number every release to the current YYYYMMDD value. 
<p>Definition at line <a class="el" href="plugin_8h-source.html#l00059">59</a> of file <a class="el" href="plugin_8h-source.html">plugin.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="4691c23018a8d4d001cc546b3040f258"></a><!-- doxytag: member="Pilot::Unfiled" ref="4691c23018a8d4d001cc546b3040f258" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="namespacePilot.html#4691c23018a8d4d001cc546b3040f258">Pilot::Unfiled</a> = 0<code> [static]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Category number for unfiled records. 
<p>

<p>Definition at line <a class="el" href="pilot_8h-source.html#l00075">75</a> of file <a class="el" href="pilot_8h-source.html">pilot.h</a>.</p>

</div>
</div><p>
</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>