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

kioslave/mbox

  • sources
  • kde-4.14
  • kdepimlibs
  • kioslave
  • mbox
mboxfile.h
1 /*
2  * This is a simple kioslave to handle mbox-files.
3  * Copyright (C) 2004 Mart Kelder (mart.kde@hccnet.nl)
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 #ifndef MBOXFILE_H
20 #define MBOXFILE_H
21 class MBoxProtocol;
22 class UrlInfo;
23 
29 class MBoxFile
30 {
31 public:
37  MBoxFile( const UrlInfo* info, MBoxProtocol* parent );
38 
42  ~MBoxFile();
43 
44 protected:
49  bool lock();
50 
54  void unlock();
55 
56 protected:
61  const UrlInfo* const m_info;
62 
66  MBoxProtocol* const m_mbox;
67 };
68 #endif
MBoxFile::m_mbox
MBoxProtocol *const m_mbox
A instance of the parent protocol, meant to throw errors if neccesairy.
Definition: mboxfile.h:66
MBoxFile::~MBoxFile
~MBoxFile()
Empty destructor.
Definition: mboxfile.cpp:30
MBoxFile::unlock
void unlock()
When implemented, this function unlocks the file.
Definition: mboxfile.cpp:40
MBoxProtocol
This class is the main class and implements all function which can be called through the user...
Definition: mbox.h:33
MBoxFile::MBoxFile
MBoxFile(const UrlInfo *info, MBoxProtocol *parent)
Constructor.
Definition: mboxfile.cpp:23
MBoxFile::lock
bool lock()
When implemented, this function handles the locking of the file.
Definition: mboxfile.cpp:34
MBoxFile::m_info
const UrlInfo *const m_info
This can be used to get information about the file.
Definition: mboxfile.h:61
MBoxFile
This class can be used to lock files when implemented.
Definition: mboxfile.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:37:11 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs 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

Search



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