• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

kioslave/mbox

Public Member Functions | Protected Member Functions | Protected Attributes
MBoxFile Class Reference

#include <mboxfile.h>

Inheritance diagram for MBoxFile:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 MBoxFile (const UrlInfo *info, MBoxProtocol *parent)
 ~MBoxFile ()

Protected Member Functions

bool lock ()
void unlock ()

Protected Attributes

const UrlInfo *const m_info
MBoxProtocol *const m_mbox

Detailed Description

This class can be used to lock files when implemented.

It is a base class for all classes that needs locking and/ir an UrlInfo*.

Definition at line 29 of file mboxfile.h.


Constructor & Destructor Documentation

MBoxFile::MBoxFile ( const UrlInfo *  info,
MBoxProtocol *  parent 
)

Constructor.

Parameters:
infoThe urlinfo which must be used
parentThe MBoxProtocol parent instance, used to throw errors.

Definition at line 23 of file mboxfile.cpp.

MBoxFile::~MBoxFile ( )

Empty destructor.

Definition at line 30 of file mboxfile.cpp.


Member Function Documentation

bool MBoxFile::lock ( ) [protected]

When implemented, this function handles the locking of the file.

Returns:
true if the locking was done successfully.

Definition at line 34 of file mboxfile.cpp.

void MBoxFile::unlock ( ) [protected]

When implemented, this function unlocks the file.

Definition at line 40 of file mboxfile.cpp.


Member Data Documentation

const UrlInfo* const MBoxFile::m_info [protected]

This can be used to get information about the file.

The file specified here is the file that must be used.

Definition at line 61 of file mboxfile.h.

MBoxProtocol* const MBoxFile::m_mbox [protected]

A instance of the parent protocol, meant to throw errors if neccesairy.

Definition at line 66 of file mboxfile.h.


The documentation for this class was generated from the following files:
  • mboxfile.h
  • mboxfile.cpp

kioslave/mbox

Skip menu "kioslave/mbox"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal