• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

kioslave/mbox

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MBoxFile Class Reference

#include <mboxfile.h>

Inheritance diagram for MBoxFile:
ReadMBox

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::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::~MBoxFile ( )

Empty destructor.

Definition at line 30 of file mboxfile.cpp.

Member Function Documentation

◆ lock()

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.

◆ unlock()

void MBoxFile::unlock ( )
protected

When implemented, this function unlocks the file.

Definition at line 40 of file mboxfile.cpp.

Member Data Documentation

◆ m_info

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.

◆ m_mbox

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kioslave/mbox

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

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal