Sophie

Sophie

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

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>kitchensync: member.cpp Source File (kitchensync)</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=".">kitchensync</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>kitchensync</h2>


<!-- Generated by Doxygen 1.5.5 -->
<h1>member.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    This file is part of libqopensync.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    Copyright (c) 2005 Tobias Koenig &lt;tokoe@kde.org&gt;</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment">    Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">    You should have received a copy of the GNU Library General Public License</span>
<a name="l00017"></a>00017 <span class="comment">    along with this library; see the file COPYING.LIB.  If not, write to</span>
<a name="l00018"></a>00018 <span class="comment">    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00019"></a>00019 <span class="comment">    Boston, MA 02110-1301, USA.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;opensync/opensync.h&gt;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;stdlib.h&gt;</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#include "member.h"</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">using namespace </span>QSync;
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 Member::Member()
<a name="l00030"></a>00030   : mMember( 0 )
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 }
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 Member::~Member()
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 }
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="keywordtype">bool</span> Member::isValid()<span class="keyword"> const</span>
<a name="l00039"></a>00039 <span class="keyword"></span>{
<a name="l00040"></a>00040   OSyncError *error = 0;
<a name="l00041"></a>00041 
<a name="l00042"></a>00042   <span class="keywordflow">if</span> ( !mMember )
<a name="l00043"></a>00043     <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00044"></a>00044 
<a name="l00045"></a>00045   <span class="keywordflow">if</span> ( !osync_member_instance_plugin( mMember, pluginName().utf8(), &amp;error ) ) {
<a name="l00046"></a>00046     qDebug( <span class="stringliteral">"Plugin %s is not valid: %s"</span>, pluginName().latin1(), osync_error_print( &amp;error ) );
<a name="l00047"></a>00047     osync_error_free( &amp;error );
<a name="l00048"></a>00048     <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00049"></a>00049   }
<a name="l00050"></a>00050 
<a name="l00051"></a>00051   <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053 
<a name="l00054"></a>00054 QString Member::configurationDirectory()<span class="keyword"> const</span>
<a name="l00055"></a>00055 <span class="keyword"></span>{
<a name="l00056"></a>00056   Q_ASSERT( mMember );
<a name="l00057"></a>00057 
<a name="l00058"></a>00058   <span class="keywordflow">return</span> QString::fromLatin1( osync_member_get_configdir( mMember ) );
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060 
<a name="l00061"></a>00061 QString Member::pluginName()<span class="keyword"> const</span>
<a name="l00062"></a>00062 <span class="keyword"></span>{
<a name="l00063"></a>00063   Q_ASSERT( mMember );
<a name="l00064"></a>00064 
<a name="l00065"></a>00065   <span class="keywordflow">return</span> QString::fromLatin1( osync_member_get_pluginname( mMember ) );
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 Plugin Member::plugin()<span class="keyword"> const</span>
<a name="l00069"></a>00069 <span class="keyword"></span>{
<a name="l00070"></a>00070   Q_ASSERT( mMember );
<a name="l00071"></a>00071 
<a name="l00072"></a>00072   Plugin plugin;
<a name="l00073"></a>00073 
<a name="l00074"></a>00074   OSyncPlugin *oplugin = osync_member_get_plugin( mMember );
<a name="l00075"></a>00075   <span class="keywordflow">if</span> ( oplugin )
<a name="l00076"></a>00076     plugin.mPlugin = oplugin;
<a name="l00077"></a>00077 
<a name="l00078"></a>00078   <span class="keywordflow">return</span> plugin;
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080 
<a name="l00081"></a>00081 <span class="keywordtype">int</span> Member::id()<span class="keyword"> const</span>
<a name="l00082"></a>00082 <span class="keyword"></span>{
<a name="l00083"></a>00083   Q_ASSERT( mMember );
<a name="l00084"></a>00084 
<a name="l00085"></a>00085   <span class="keywordflow">return</span> osync_member_get_id( mMember );
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="keywordtype">void</span> Member::setName( <span class="keyword">const</span> QString &amp;name )
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090   Q_ASSERT( mMember );
<a name="l00091"></a>00091 
<a name="l00092"></a>00092   osync_member_set_name( mMember, (<span class="keyword">const</span> <span class="keywordtype">char</span>*)name.utf8() );
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 QString Member::name()<span class="keyword"> const</span>
<a name="l00096"></a>00096 <span class="keyword"></span>{
<a name="l00097"></a>00097   Q_ASSERT( mMember );
<a name="l00098"></a>00098 
<a name="l00099"></a>00099   <span class="keywordflow">return</span> QString::fromUtf8( osync_member_get_name( mMember ) );
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101 
<a name="l00102"></a>00102 <span class="keywordtype">void</span> Member::setConfiguration( <span class="keyword">const</span> QByteArray &amp;configurationData )
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104   Q_ASSERT( mMember );
<a name="l00105"></a>00105 
<a name="l00106"></a>00106   osync_member_set_config( mMember, configurationData.data(), configurationData.size() );
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108 
<a name="l00109"></a>00109 Result Member::configuration( QByteArray &amp;configurationData, <span class="keywordtype">bool</span> useDefault )
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111   Q_ASSERT( mMember );
<a name="l00112"></a>00112 
<a name="l00113"></a>00113   <span class="keywordtype">char</span> *data;
<a name="l00114"></a>00114   <span class="keywordtype">int</span> size;
<a name="l00115"></a>00115 
<a name="l00116"></a>00116   OSyncError *error = 0;
<a name="l00117"></a>00117   osync_bool ok = <span class="keyword">false</span>;
<a name="l00118"></a>00118   <span class="keywordflow">if</span> ( useDefault )
<a name="l00119"></a>00119     ok = osync_member_get_config_or_default( mMember, &amp;data, &amp;size, &amp;error );
<a name="l00120"></a>00120   <span class="keywordflow">else</span>
<a name="l00121"></a>00121     ok = osync_member_get_config( mMember, &amp;data, &amp;size, &amp;error );
<a name="l00122"></a>00122 
<a name="l00123"></a>00123   <span class="keywordflow">if</span> ( !ok ) {
<a name="l00124"></a>00124     <span class="keywordflow">return</span> Result( &amp;error );
<a name="l00125"></a>00125   } <span class="keywordflow">else</span> {
<a name="l00126"></a>00126     configurationData.resize( size );
<a name="l00127"></a>00127     memcpy( configurationData.data(), data, size );
<a name="l00128"></a>00128 
<a name="l00129"></a>00129     <span class="keywordflow">return</span> Result();
<a name="l00130"></a>00130   }
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 Result Member::save()
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135   Q_ASSERT( mMember );
<a name="l00136"></a>00136 
<a name="l00137"></a>00137   OSyncError *error = 0;
<a name="l00138"></a>00138   <span class="keywordflow">if</span> ( !osync_member_save( mMember, &amp;error ) )
<a name="l00139"></a>00139     <span class="keywordflow">return</span> Result( &amp;error );
<a name="l00140"></a>00140   <span class="keywordflow">else</span>
<a name="l00141"></a>00141     <span class="keywordflow">return</span> Result();
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143 
<a name="l00144"></a>00144 Result Member::instance( <span class="keyword">const</span> Plugin &amp;plugin )
<a name="l00145"></a>00145 {
<a name="l00146"></a>00146   OSyncError *error = 0;
<a name="l00147"></a>00147   <span class="keywordflow">if</span> ( !osync_member_instance_plugin( mMember, plugin.name().utf8(), &amp;error ) )
<a name="l00148"></a>00148     <span class="keywordflow">return</span> Result( &amp;error );
<a name="l00149"></a>00149   <span class="keywordflow">else</span>
<a name="l00150"></a>00150     <span class="keywordflow">return</span> Result();
<a name="l00151"></a>00151 }
<a name="l00152"></a>00152 
<a name="l00153"></a>00153 <span class="keywordtype">bool</span> Member::operator==( <span class="keyword">const</span> Member &amp;member )<span class="keyword"> const</span>
<a name="l00154"></a>00154 <span class="keyword"></span>{
<a name="l00155"></a>00155   <span class="keywordflow">return</span> mMember == member.mMember;
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157 
<a name="l00158"></a>00158 QString Member::scanDevices( <span class="keyword">const</span> QString &amp;query )
<a name="l00159"></a>00159 {
<a name="l00160"></a>00160   Q_ASSERT( mMember );
<a name="l00161"></a>00161 
<a name="l00162"></a>00162   OSyncError *error = 0;
<a name="l00163"></a>00163   <span class="keywordtype">char</span> *data = (<span class="keywordtype">char</span>*)osync_member_call_plugin( mMember, <span class="stringliteral">"scan_devices"</span>, const_cast&lt;char*&gt;( query.utf8().data() ), &amp;error );
<a name="l00164"></a>00164   <span class="keywordflow">if</span> ( error != 0 ) {
<a name="l00165"></a>00165     osync_error_free( &amp;error );
<a name="l00166"></a>00166     <span class="keywordflow">return</span> QString();
<a name="l00167"></a>00167   } <span class="keywordflow">else</span> {
<a name="l00168"></a>00168     QString xml = QString::fromUtf8( data );
<a name="l00169"></a>00169     free( data );
<a name="l00170"></a>00170     <span class="keywordflow">return</span> xml;
<a name="l00171"></a>00171   }
<a name="l00172"></a>00172 }
<a name="l00173"></a>00173 
<a name="l00174"></a>00174 <span class="keywordtype">bool</span> Member::testConnection( <span class="keyword">const</span> QString &amp;configuration )
<a name="l00175"></a>00175 {
<a name="l00176"></a>00176   Q_ASSERT( mMember );
<a name="l00177"></a>00177 
<a name="l00178"></a>00178   OSyncError *error = 0;
<a name="l00179"></a>00179   <span class="keywordtype">int</span> *result = (<span class="keywordtype">int</span>*)osync_member_call_plugin( mMember, <span class="stringliteral">"test_connection"</span>, const_cast&lt;char*&gt;( configuration.utf8().data() ), &amp;error );
<a name="l00180"></a>00180   <span class="keywordflow">if</span> ( error != 0 ) {
<a name="l00181"></a>00181     osync_error_free( &amp;error );
<a name="l00182"></a>00182     <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00183"></a>00183   } <span class="keywordflow">else</span> {
<a name="l00184"></a>00184     <span class="keywordtype">bool</span> value = ( *result == 1 ? <span class="keyword">true</span> : false );
<a name="l00185"></a>00185     free( result );
<a name="l00186"></a>00186     <span class="keywordflow">return</span> value;
<a name="l00187"></a>00187   }
<a name="l00188"></a>00188 }
</pre></div></div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kitchensync</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</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></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="classConflictDialog.html">conflictdialog</option>,  <option value="classMainWindow.html">mainwindow</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>