kabc Library API Documentation

KABC::Lock Class Reference

This class provides locking functionality for a file, directory or an arbitrary string-represented resource. More...

#include <lock.h>

Inheritance diagram for KABC::Lock:

QObject KABC::LockNull List of all members.

Public Methods

 Lock (const QString &identifier)
 ~Lock ()
virtual bool lock ()
virtual bool unlock ()

Detailed Description

This class provides locking functionality for a file, directory or an arbitrary string-represented resource.

Definition at line 33 of file lock.h.


Constructor & Destructor Documentation

Lock::Lock const QString   identifier
 

Constructor.

Parameters:
identifier  An identifier for the resource to be locked, e.g. a file name.

Definition at line 38 of file lock.cpp.

References QString::replace().

Lock::~Lock  
 

Destruct lock object.

This also removes the lock on the resource.

Definition at line 44 of file lock.cpp.

References unlock().


Member Function Documentation

bool Lock::lock   [virtual]
 

Lock resource.

Reimplemented in KABC::LockNull.

Definition at line 80 of file lock.cpp.

References QString::arg(), QFile::encodeName(), QFile::exists(), and QFile::remove().

Referenced by KABC::ResourceFile::requestSaveTicket().

bool Lock::unlock   [virtual]
 

Unlock resource.

Reimplemented in KABC::LockNull.

Definition at line 132 of file lock.cpp.

References QString::arg(), QString::number(), and QFile::remove().

Referenced by ~Lock().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kabc Library Version 3.2.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Feb 4 12:36:46 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003