<?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>kabc: KABC::Lock Class Reference (kabc)</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" />
</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>
<div id="nav_header_title" align="left">KDE 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_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kabc</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;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKABC.html">KABC</a> </li>
<li class="navelem"><a class="el" href="classKABC_1_1Lock.html">Lock</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">KABC::Lock Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KABC::Lock" --><!-- doxytag: inherits="QObject" -->
<p>This class provides locking functionality for a file, directory or an arbitrary string-represented resource.
<a href="classKABC_1_1Lock.html#details">More...</a></p>
<p><code>#include <<a class="el" href="lock_8h_source.html">lock.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KABC::Lock:</div>
<div class="dyncontent">
<div class="center">
<img src="classKABC_1_1Lock.png" usemap="#KABC::Lock_map" alt=""/>
<map id="KABC::Lock_map" name="KABC::Lock_map">
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,101,24"/>
<area href="classKABC_1_1LockNull.html" title="This class provides a lock without actually locking." alt="KABC::LockNull" shape="rect" coords="0,112,101,136"/>
</map>
</div></div>
<p><a href="classKABC_1_1Lock-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ccd6a7a2353dc4f62646652acf9f3d0"></a><!-- doxytag: member="KABC::Lock::locked" ref="a5ccd6a7a2353dc4f62646652acf9f3d0" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>locked</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c03dcf60fcf33dbeb3f59d1c4f3a676"></a><!-- doxytag: member="KABC::Lock::unlocked" ref="a3c03dcf60fcf33dbeb3f59d1c4f3a676" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>unlocked</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Lock.html#a2b0bb3f15b645e77c72a386c890df8e2">Lock</a> (const <a class="elRef" href="qstring.html">QString</a> &identifier)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Lock.html#a7ab6d9485c8665bb3643710432882971">~Lock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Lock.html#af7f60cb0f7176ad0b7704e49993afaa2">lock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKABC_1_1Lock.html#af51df18839060f5a4862cc35065706f1">unlock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac79c33fa67c3ec756aac89899bbb838b"></a><!-- doxytag: member="KABC::Lock::error" ref="ac79c33fa67c3ec756aac89899bbb838b" args="() const " -->
virtual <a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><b>error</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdac65d1caba94c7ed047186a2635a3e"></a><!-- doxytag: member="KABC::Lock::lockFileName" ref="abdac65d1caba94c7ed047186a2635a3e" args="() const " -->
<a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><b>lockFileName</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8723bbe2e6dc88c263eac3c4810b6147"></a><!-- doxytag: member="KABC::Lock::readLockFile" ref="a8723bbe2e6dc88c263eac3c4810b6147" args="(const QString &filename, int &pid, QString &app)" -->
static bool </td><td class="memItemRight" valign="bottom"><b>readLockFile</b> (const <a class="elRef" href="qstring.html">QString</a> &filename, int &pid, <a class="elRef" href="qstring.html">QString</a> &app)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ffc9bf5a49f59d63d39390ffbff47b1"></a><!-- doxytag: member="KABC::Lock::writeLockFile" ref="a9ffc9bf5a49f59d63d39390ffbff47b1" args="(const QString &filename)" -->
static bool </td><td class="memItemRight" valign="bottom"><b>writeLockFile</b> (const <a class="elRef" href="qstring.html">QString</a> &filename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada795539d5f73cf1f220d97961456b07"></a><!-- doxytag: member="KABC::Lock::locksDir" ref="ada795539d5f73cf1f220d97961456b07" args="()" -->
static <a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><b>locksDir</b> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class provides locking functionality for a file, directory or an arbitrary string-represented resource. </p>
<p>Definition at line <a class="el" href="lock_8h_source.html#l00035">35</a> of file <a class="el" href="lock_8h_source.html">lock.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2b0bb3f15b645e77c72a386c890df8e2"></a><!-- doxytag: member="KABC::Lock::Lock" ref="a2b0bb3f15b645e77c72a386c890df8e2" args="(const QString &identifier)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lock::Lock </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>identifier</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">identifier</td><td>An identifier for the resource to be locked, e.g. a file name. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="lock_8cpp_source.html#l00038">38</a> of file <a class="el" href="lock_8cpp_source.html">lock.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7ab6d9485c8665bb3643710432882971"></a><!-- doxytag: member="KABC::Lock::~Lock" ref="a7ab6d9485c8665bb3643710432882971" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lock::~Lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destruct lock object. </p>
<p>This also removes the lock on the resource. </p>
<p>Definition at line <a class="el" href="lock_8cpp_source.html#l00044">44</a> of file <a class="el" href="lock_8cpp_source.html">lock.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af7f60cb0f7176ad0b7704e49993afaa2"></a><!-- doxytag: member="KABC::Lock::lock" ref="af7f60cb0f7176ad0b7704e49993afaa2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lock::lock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classKABC_1_1Lock.html" title="This class provides locking functionality for a file, directory or an arbitrary string-represented re...">Lock</a> resource. </p>
<p>Reimplemented in <a class="el" href="classKABC_1_1LockNull.html#ad0dad06186aaa12506cc60b0ad93b214">KABC::LockNull</a>.</p>
<p>Definition at line <a class="el" href="lock_8cpp_source.html#l00081">81</a> of file <a class="el" href="lock_8cpp_source.html">lock.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af51df18839060f5a4862cc35065706f1"></a><!-- doxytag: member="KABC::Lock::unlock" ref="af51df18839060f5a4862cc35065706f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lock::unlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unlock resource. </p>
<p>Reimplemented in <a class="el" href="classKABC_1_1LockNull.html#a745c5f3387a57a1aa4ed1cc68230597b">KABC::LockNull</a>.</p>
<p>Definition at line <a class="el" href="lock_8cpp_source.html#l00136">136</a> of file <a class="el" href="lock_8cpp_source.html">lock.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="lock_8h_source.html">lock.h</a></li>
<li><a class="el" href="lock_8cpp_source.html">lock.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kabc</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><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="classKABC_1_1Address.html">kabc::address</option>, <option value="classKABC_1_1AddressBook.html">kabc::addressbook</option>, <option value="classKABC_1_1AddressBook_1_1ConstIterator.html">kabc::addressbook::constiterator</option>, <option value="classKABC_1_1AddressBook_1_1Iterator.html">kabc::addressbook::iterator</option>, <option value="classKABC_1_1Addressee.html">kabc::addressee</option>, <option value="classKABC_1_1AddresseeDialog.html">kabc::addresseedialog</option>, <option value="classKABC_1_1AddresseeItem.html">kabc::addresseeitem</option>, <option value="classKABC_1_1AddresseeList.html">kabc::addresseelist</option>, <option value="classKABC_1_1AddressLineEdit.html">kabc::addresslineedit</option>, <option value="classKABC_1_1Agent.html">kabc::agent</option>, <option value="classKABC_1_1BinaryFormat.html">kabc::binaryformat</option>, <option value="classKABC_1_1ConsoleErrorHandler.html">kabc::consoleerrorhandler</option>, <option value="classKABC_1_1DistributionList.html">kabc::distributionlist</option>, <option value="classKABC_1_1DistributionListDialog.html">kabc::distributionlistdialog</option>, <option value="classKABC_1_1DistributionListEditor.html">kabc::distributionlisteditor</option>, <option value="classKABC_1_1DistributionListEditorWidget.html">kabc::distributionlisteditorwidget</option>, <option value="classKABC_1_1DistributionListManager.html">kabc::distributionlistmanager</option>, <option value="classKABC_1_1DistributionListWatcher.html">kabc::distributionlistwatcher</option>, <option value="classKABC_1_1EmailSelector.html">kabc::emailselector</option>, <option value="classKABC_1_1ErrorHandler.html">kabc::errorhandler</option>, <option value="classKABC_1_1Format.html">kabc::format</option>, <option value="classKABC_1_1FormatFactory.html">kabc::formatfactory</option>, <option value="classKABC_1_1FormatPlugin.html">kabc::formatplugin</option>, <option value="classKABC_1_1Geo.html">kabc::geo</option>, <option value="classKABC_1_1GUIErrorHandler.html">kabc::guierrorhandler</option>, <option value="classKABC_1_1GuiErrorHandler.html">kabc::guierrorhandler</option>, <option value="classKABC_1_1Key.html">kabc::key</option>, <option value="classKABC_1_1LdapClient.html">kabc::ldapclient</option>, <option value="classKABC_1_1LdapConfigWidget.html">kabc::ldapconfigwidget</option>, <option value="classKABC_1_1LdapObject.html">kabc::ldapobject</option>, <option value="classKABC_1_1LdapSearch.html">kabc::ldapsearch</option>, <option value="classKABC_1_1LDAPUrl.html">kabc::ldapurl</option>, <option value="classKABC_1_1LDIF.html">kabc::ldif</option>, <option value="classKABC_1_1Lock.html">kabc::lock</option>, <option value="classKABC_1_1LockNull.html">kabc::locknull</option>, <option value="classKABC_1_1PhoneNumber.html">kabc::phonenumber</option>, <option value="classKABC_1_1Resource_1_1ConstIterator.html">kabc::resource::constiterator</option>, <option value="classKABC_1_1Resource_1_1Iterator.html">kabc::resource::iterator</option>, <option value="classKABC_1_1ResourceFile.html">kabc::resourcefile</option>, <option value="classKABC_1_1ResourceSelectDialog.html">kabc::resourceselectdialog</option>, <option value="classKABC_1_1SortMode.html">kabc::sortmode</option>, <option value="classKABC_1_1Sound.html">kabc::sound</option>, <option value="classKABC_1_1StdAddressBook.html">kabc::stdaddressbook</option>, <option value="classKABC_1_1Ticket.html">kabc::ticket</option>, <option value="classKABC_1_1TimeZone.html">kabc::timezone</option>, <option value="classKABC_1_1VCard21Parser.html">kabc::vcard21parser</option>, <option value="classKABC_1_1VCardConverter.html">kabc::vcardconverter</option>, <option value="classKABC_1_1VCardFormat.html">kabc::vcardformat</option>, <option value="classKABC_1_1VCardFormatImpl.html">kabc::vcardformatimpl</option>, <option value="classKABC_1_1VCardFormatPlugin.html">kabc::vcardformatplugin</option>, <option value="classVCard21ParserImpl.html">vcard21parserimpl</option>, <option value="classVCardLineX.html">vcardlinex</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
