<?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" xml:lang="en">
<head>
<title>mboxfile.h Source File</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<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" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../../favicon.ico" /><link rel="icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>kioslave/mbox</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_63c0b8a97962c98845ea2eacf00b4f7d.html">kioslave</a></li><li class="navelem"><a class="el" href="dir_8b2029eb2dc37bb99ee16dd92f664be3.html">mbox</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">mboxfile.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This is a simple kioslave to handle mbox-files.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2004 Mart Kelder (mart.kde@hccnet.nl)</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * version 2 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef MBOXFILE_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span><span class="preprocessor">#define MBOXFILE_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="keyword">class </span><a class="code" href="classMBoxProtocol.html" title="This class is the main class and implements all function which can be called through the user...">MBoxProtocol</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">class </span>UrlInfo;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="classMBoxFile.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classMBoxFile.html" title="This class can be used to lock files when implemented.">MBoxFile</a></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classMBoxFile.html#ac6193fb5a732c3aef8f1624f7ccf84f0" title="Constructor.">MBoxFile</a>( <span class="keyword">const</span> UrlInfo* info, <a class="code" href="classMBoxProtocol.html" title="This class is the main class and implements all function which can be called through the user...">MBoxProtocol</a>* parent );</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classMBoxFile.html#abd1d8788fb7bfe88de49ce463a4b8dcf" title="Empty destructor.">~MBoxFile</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span> <a class="code" href="classMBoxFile.html#aa1f7e0a81ef83f7970c5b8a735ca4f1b" title="When implemented, this function handles the locking of the file.">lock</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="classMBoxFile.html#a1da7dbc86509f4345743560c5591adcd" title="When implemented, this function unlocks the file.">unlock</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classMBoxFile.html#aa04cff696c2aa36bfaabbe1b7f6de39d"> 61</a></span>  <span class="keyword">const</span> UrlInfo* <span class="keyword">const</span> <a class="code" href="classMBoxFile.html#aa04cff696c2aa36bfaabbe1b7f6de39d" title="This can be used to get information about the file.">m_info</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="classMBoxFile.html#aa6f62c9cf19f0b270f2914c9348e83dd"> 66</a></span>  <a class="code" href="classMBoxProtocol.html" title="This class is the main class and implements all function which can be called through the user...">MBoxProtocol</a>* <span class="keyword">const</span> <a class="code" href="classMBoxFile.html#aa6f62c9cf19f0b270f2914c9348e83dd" title="A instance of the parent protocol, meant to throw errors if neccesairy.">m_mbox</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> };</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:15 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kioslave/mbox</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kioslave/mbox"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</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="classMBoxFile.html">mboxfile</option>, <option value="classMBoxProtocol.html">mboxprotocol</option>, <option value="classReadMBox.html">readmbox</option>, <option value="classStat.html">stat</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../../kabc/html/index.html">kabc</a></li><li><a href="../../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../../kblog/html/index.html">kblog</a></li><li><a href="../../../kcal/html/index.html">kcal</a></li><li><a href="../../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../../kholidays/html/index.html">kholidays</a></li><li><a href="../../../kimap/html/index.html">kimap</a></li><li><a href="../../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../../kldap/html/index.html">kldap</a></li><li><a href="../../../kmbox/html/index.html">kmbox</a></li><li><a href="../../../kmime/html/index.html">kmime</a></li><li><a href="../../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../../kresources/html/index.html">kresources</a></li><li><a href="../../../ktnef/html/index.html">ktnef</a></li><li><a href="../../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../../microblog/html/index.html">microblog</a></li><li><a href="../../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../../syndication/html/index.html">syndication</a></li><li> <a href="../../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
