<?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" xml:lang="en">
<head>
<title>KRES::IdMapper Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<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" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>kresources</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KRES</b></li><li class="navelem"><a class="el" href="classKRES_1_1IdMapper.html">IdMapper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classKRES_1_1IdMapper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KRES::IdMapper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="idmapper_8h_source.html">idmapper.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1cec5c80f83120f9c0ad154112fd81e2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a1cec5c80f83120f9c0ad154112fd81e2">IdMapper</a> ()</td></tr>
<tr class="separator:a1cec5c80f83120f9c0ad154112fd81e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48988d96081526b80a6c38adc1b593cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a48988d96081526b80a6c38adc1b593cf">IdMapper</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#ae9437ccf416f2697bfc5dbba18a2f285">path</a>, const QString &<a class="el" href="classKRES_1_1IdMapper.html#a4593f45a6fb90c56b2ccbff5329ddec8">identifier</a>=QString())</td></tr>
<tr class="separator:a48988d96081526b80a6c38adc1b593cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0697def895edf49d8c94ce50ff6b33e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#af0697def895edf49d8c94ce50ff6b33e">~IdMapper</a> ()</td></tr>
<tr class="separator:af0697def895edf49d8c94ce50ff6b33e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b894ddb060f91f9fdadb04a61bf73ab"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a1b894ddb060f91f9fdadb04a61bf73ab">asString</a> () const </td></tr>
<tr class="separator:a1b894ddb060f91f9fdadb04a61bf73ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d7f82ff87acda513196a8258a5176fd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a6d7f82ff87acda513196a8258a5176fd">clear</a> ()</td></tr>
<tr class="separator:a6d7f82ff87acda513196a8258a5176fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1850663bf97672056bed7e2c9d8cf13"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#ad1850663bf97672056bed7e2c9d8cf13">fingerprint</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#a43dcbc1e19271e97a03bdfd6cbeaf00d">localId</a>) const </td></tr>
<tr class="separator:ad1850663bf97672056bed7e2c9d8cf13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4593f45a6fb90c56b2ccbff5329ddec8"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a4593f45a6fb90c56b2ccbff5329ddec8">identifier</a> () const </td></tr>
<tr class="separator:a4593f45a6fb90c56b2ccbff5329ddec8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae051be8e0c2c6ee470af6e65cb5a5e32"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#ae051be8e0c2c6ee470af6e65cb5a5e32">load</a> ()</td></tr>
<tr class="separator:ae051be8e0c2c6ee470af6e65cb5a5e32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43dcbc1e19271e97a03bdfd6cbeaf00d"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a43dcbc1e19271e97a03bdfd6cbeaf00d">localId</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#aa682cb6ac75188cd8952207173820b63">remoteId</a>) const </td></tr>
<tr class="separator:a43dcbc1e19271e97a03bdfd6cbeaf00d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9437ccf416f2697bfc5dbba18a2f285"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#ae9437ccf416f2697bfc5dbba18a2f285">path</a> () const </td></tr>
<tr class="separator:ae9437ccf416f2697bfc5dbba18a2f285"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa682cb6ac75188cd8952207173820b63"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#aa682cb6ac75188cd8952207173820b63">remoteId</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#a43dcbc1e19271e97a03bdfd6cbeaf00d">localId</a>) const </td></tr>
<tr class="separator:aa682cb6ac75188cd8952207173820b63"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56bc5fa96747bf3a6c854ac57f2510a9"><td class="memItemLeft" align="right" valign="top">QMap< QString, QString > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a56bc5fa96747bf3a6c854ac57f2510a9">remoteIdMap</a> () const </td></tr>
<tr class="separator:a56bc5fa96747bf3a6c854ac57f2510a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c0f64a8a56530e5b81b0fca7bce41b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a2c0f64a8a56530e5b81b0fca7bce41b9">removeRemoteId</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#aa682cb6ac75188cd8952207173820b63">remoteId</a>)</td></tr>
<tr class="separator:a2c0f64a8a56530e5b81b0fca7bce41b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69b243dcc3f837d2d774a6e8abda77c4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a69b243dcc3f837d2d774a6e8abda77c4">save</a> ()</td></tr>
<tr class="separator:a69b243dcc3f837d2d774a6e8abda77c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ad8cea93295427f5275a1d861d09d30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a8ad8cea93295427f5275a1d861d09d30">setFingerprint</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#a43dcbc1e19271e97a03bdfd6cbeaf00d">localId</a>, const QString &<a class="el" href="classKRES_1_1IdMapper.html#ad1850663bf97672056bed7e2c9d8cf13">fingerprint</a>)</td></tr>
<tr class="separator:a8ad8cea93295427f5275a1d861d09d30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26390f650188e84e39391f6464941adf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a26390f650188e84e39391f6464941adf">setIdentifier</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#a4593f45a6fb90c56b2ccbff5329ddec8">identifier</a>)</td></tr>
<tr class="separator:a26390f650188e84e39391f6464941adf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f61c55a418b254d3ef7c0f5d40a1665"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a6f61c55a418b254d3ef7c0f5d40a1665">setPath</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#ae9437ccf416f2697bfc5dbba18a2f285">path</a>)</td></tr>
<tr class="separator:a6f61c55a418b254d3ef7c0f5d40a1665"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5924afab28684a940dd7c0947c346b25"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a5924afab28684a940dd7c0947c346b25">setRemoteId</a> (const QString &<a class="el" href="classKRES_1_1IdMapper.html#a43dcbc1e19271e97a03bdfd6cbeaf00d">localId</a>, const QString &<a class="el" href="classKRES_1_1IdMapper.html#aa682cb6ac75188cd8952207173820b63">remoteId</a>)</td></tr>
<tr class="separator:a5924afab28684a940dd7c0947c346b25"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3a255d570e24e67ba409b34488c5c920"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKRES_1_1IdMapper.html#a3a255d570e24e67ba409b34488c5c920">filename</a> ()</td></tr>
<tr class="separator:a3a255d570e24e67ba409b34488c5c920"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Keeps a map of paths and identifiers. </p>
<p>An Id Mapper maps Ids. What to or what for is not entirely clear, but maps have categories. This is probably an adjoint functor, since adjoint functors are everywhere. </p>
<p>Definition at line <a class="el" href="idmapper_8h_source.html#l00051">51</a> of file <a class="el" href="idmapper_8h_source.html">idmapper.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1cec5c80f83120f9c0ad154112fd81e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRES::IdMapper::IdMapper </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create Id mapper. </p>
<p>You have to set path and identifier before you can call <a class="el" href="classKRES_1_1IdMapper.html#ae051be8e0c2c6ee470af6e65cb5a5e32" title="Loads the map.">load()</a> or <a class="el" href="classKRES_1_1IdMapper.html#a69b243dcc3f837d2d774a6e8abda77c4" title="Saves the map.">save()</a>. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00055">55</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a48988d96081526b80a6c38adc1b593cf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">KRES::IdMapper::IdMapper </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>identifier</em> = <code>QString()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create Id mapper. </p>
<p>The path specifies the category of mapping, the identifier the concrete object.</p>
<p>If you don't pass an identifier you have to set it before calling <a class="el" href="classKRES_1_1IdMapper.html#ae051be8e0c2c6ee470af6e65cb5a5e32" title="Loads the map.">load()</a> or <a class="el" href="classKRES_1_1IdMapper.html#a69b243dcc3f837d2d774a6e8abda77c4" title="Saves the map.">save()</a>.</p>
<p>The current implementation stores the data at /share/apps/<path>/<identifier>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Category of mapping (path into the mapping namespace) </td></tr>
<tr><td class="paramname">identifier</td><td>The concrete mapping object (filename in namespace) </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00060">60</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af0697def895edf49d8c94ce50ff6b33e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRES::IdMapper::~IdMapper </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00067">67</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1b894ddb060f91f9fdadb04a61bf73ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::asString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of the id pairs, that's useful for debugging. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00210">210</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6d7f82ff87acda513196a8258a5176fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KRES::IdMapper::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the map. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00156">156</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3a255d570e24e67ba409b34488c5c920"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::filename </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Filename of the map when stored on disk. </p>
<p>Used in <a class="el" href="classKRES_1_1IdMapper.html#a69b243dcc3f837d2d774a6e8abda77c4" title="Saves the map.">save()</a> and <a class="el" href="classKRES_1_1IdMapper.html#ae051be8e0c2c6ee470af6e65cb5a5e32" title="Loads the map.">load()</a>, </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKRES_1_1IdMapper.html#a48988d96081526b80a6c38adc1b593cf" title="Create Id mapper.">IdMapper( const QString &path, const QString &identifier )</a> </dd></dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00092">92</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad1850663bf97672056bed7e2c9d8cf13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::fingerprint </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>localId</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the fingerprint for the map. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">localId</td><td>Local Id to get the fingerprint for. </td></tr>
</table>
</dd>
</dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Figure out if this returns the last fingerprint set by <a class="el" href="classKRES_1_1IdMapper.html#a8ad8cea93295427f5275a1d861d09d30" title="Stores a fingerprint for an id which can be used to detect if the locally held version differs from w...">setFingerprint()</a> only or if anything else can change it. </dd></dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00233">233</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4593f45a6fb90c56b2ccbff5329ddec8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::identifier </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return id map identifier. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00087">87</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae051be8e0c2c6ee470af6e65cb5a5e32"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KRES::IdMapper::load </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the map. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00103">103</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a43dcbc1e19271e97a03bdfd6cbeaf00d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::localId </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>remoteId</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the local id for the given remote id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">remoteId</td><td>Remote Id to get the local Id for. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00198">198</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae9437ccf416f2697bfc5dbba18a2f285"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::path </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return id map path. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00077">77</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa682cb6ac75188cd8952207173820b63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KRES::IdMapper::remoteId </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>localId</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the remote id of the given local id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">localId</td><td>Local Id to get the remote Id from. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKRES_1_1IdMapper.html#a5924afab28684a940dd7c0947c346b25" title="Stores the remote id for the given local id.">setRemoteId()</a> </dd>
<dd>
<a class="el" href="classKRES_1_1IdMapper.html#a2c0f64a8a56530e5b81b0fca7bce41b9" title="Removes the remote id.">removeRemoteId()</a> </dd></dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00186">186</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a56bc5fa96747bf3a6c854ac57f2510a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< QString, QString > KRES::IdMapper::remoteIdMap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the entire map of local-to-remote Ids. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00242">242</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2c0f64a8a56530e5b81b0fca7bce41b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KRES::IdMapper::removeRemoteId </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>remoteId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the remote id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">remoteId</td><td>remote Id to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>So what does that do? Remove local Ids with only that one remote Id? Remove the remote Id from all local Ids that have it? </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKRES_1_1IdMapper.html#a5924afab28684a940dd7c0947c346b25" title="Stores the remote id for the given local id.">setRemoteId()</a> </dd></dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00169">169</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a69b243dcc3f837d2d774a6e8abda77c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KRES::IdMapper::save </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Saves the map. </p>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00131">131</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8ad8cea93295427f5275a1d861d09d30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KRES::IdMapper::setFingerprint </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>localId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>fingerprint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores a fingerprint for an id which can be used to detect if the locally held version differs from what is on the server. </p>
<p>This can be a sequence number of an md5 hash depending on what the server provides.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">localId</td><td>Local Id to set the fingerprint on. </td></tr>
<tr><td class="paramname">fingerprint</td><td>Fingerprint (any string will do, though an md5 hash is probably a good idea) of the Id. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00226">226</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a26390f650188e84e39391f6464941adf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KRES::IdMapper::setIdentifier </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>identifier</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set id map identifier. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">identifier</td><td>the identifier (filename) within the mapping namespace </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00082">82</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6f61c55a418b254d3ef7c0f5d40a1665"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KRES::IdMapper::setPath </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set id map path. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Path to use into mapping namespace. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKRES_1_1IdMapper.html#a1cec5c80f83120f9c0ad154112fd81e2" title="Create Id mapper.">IdMapper()</a> </dd></dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00072">72</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5924afab28684a940dd7c0947c346b25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KRES::IdMapper::setRemoteId </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>localId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>remoteId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores the remote id for the given local id. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">localId</td><td>Local Id to set remote for. </td></tr>
<tr><td class="paramname">remoteId</td><td>Remote Id to associate with this local Id. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKRES_1_1IdMapper.html#aa682cb6ac75188cd8952207173820b63" title="Returns the remote id of the given local id.">remoteId()</a> </dd>
<dd>
<a class="el" href="classKRES_1_1IdMapper.html#a43dcbc1e19271e97a03bdfd6cbeaf00d" title="Returns the local id for the given remote id.">localId()</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>What happens when you set the same remote Id for more than one localId? </dd></dl>
<p>Definition at line <a class="el" href="idmapper_8cpp_source.html#l00162">162</a> of file <a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="idmapper_8h_source.html">idmapper.h</a></li>
<li><a class="el" href="idmapper_8cpp_source.html">idmapper.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:47 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kresources</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kresources"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</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="classKRES_1_1ConfigDialog.html">kres::configdialog</option>, <option value="classKRES_1_1ConfigPage.html">kres::configpage</option>, <option value="classKRES_1_1ConfigWidget.html">kres::configwidget</option>, <option value="classKRES_1_1Factory.html">kres::factory</option>, <option value="classKRES_1_1IdMapper.html">kres::idmapper</option>, <option value="classKRES_1_1Manager.html">kres::manager</option>, <option value="classKRES_1_1Manager_1_1ActiveIterator.html">kres::manager::activeiterator</option>, <option value="classKRES_1_1Manager_1_1Iterator.html">kres::manager::iterator</option>, <option value="classKRES_1_1ManagerImpl.html">kres::managerimpl</option>, <option value="classKRES_1_1ManagerNotifier.html">kres::managernotifier</option>, <option value="classKRES_1_1ManagerObserver.html">kres::managerobserver</option>, <option value="classKRES_1_1Resource.html">kres::resource</option>, <option value="classKRES_1_1SelectDialog.html">kres::selectdialog</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
