<?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 Class Reference</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><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classMBoxFile-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">MBoxFile Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="mboxfile_8h_source.html">mboxfile.h</a>></code></p> <div class="dynheader"> Inheritance diagram for MBoxFile:</div> <div class="dyncontent"> <div class="center"> <img src="classMBoxFile.png" usemap="#MBoxFile_map" alt=""/> <map id="MBoxFile_map" name="MBoxFile_map"> <area href="classReadMBox.html" title="This class handels reading from a mbox-file." alt="ReadMBox" shape="rect" coords="0,56,73,80"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ac6193fb5a732c3aef8f1624f7ccf84f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxFile.html#ac6193fb5a732c3aef8f1624f7ccf84f0">MBoxFile</a> (const UrlInfo *info, <a class="el" href="classMBoxProtocol.html">MBoxProtocol</a> *parent)</td></tr> <tr class="separator:ac6193fb5a732c3aef8f1624f7ccf84f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abd1d8788fb7bfe88de49ce463a4b8dcf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxFile.html#abd1d8788fb7bfe88de49ce463a4b8dcf">~MBoxFile</a> ()</td></tr> <tr class="separator:abd1d8788fb7bfe88de49ce463a4b8dcf"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:aa1f7e0a81ef83f7970c5b8a735ca4f1b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxFile.html#aa1f7e0a81ef83f7970c5b8a735ca4f1b">lock</a> ()</td></tr> <tr class="separator:aa1f7e0a81ef83f7970c5b8a735ca4f1b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1da7dbc86509f4345743560c5591adcd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxFile.html#a1da7dbc86509f4345743560c5591adcd">unlock</a> ()</td></tr> <tr class="separator:a1da7dbc86509f4345743560c5591adcd"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:aa04cff696c2aa36bfaabbe1b7f6de39d"><td class="memItemLeft" align="right" valign="top">const UrlInfo *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxFile.html#aa04cff696c2aa36bfaabbe1b7f6de39d">m_info</a></td></tr> <tr class="separator:aa04cff696c2aa36bfaabbe1b7f6de39d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa6f62c9cf19f0b270f2914c9348e83dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMBoxProtocol.html">MBoxProtocol</a> *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxFile.html#aa6f62c9cf19f0b270f2914c9348e83dd">m_mbox</a></td></tr> <tr class="separator:aa6f62c9cf19f0b270f2914c9348e83dd"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This class can be used to lock files when implemented. </p> <p>It is a base class for all classes that needs locking and/ir an UrlInfo*. </p> <p>Definition at line <a class="el" href="mboxfile_8h_source.html#l00029">29</a> of file <a class="el" href="mboxfile_8h_source.html">mboxfile.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="ac6193fb5a732c3aef8f1624f7ccf84f0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">MBoxFile::MBoxFile </td> <td>(</td> <td class="paramtype">const UrlInfo * </td> <td class="paramname"><em>info</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classMBoxProtocol.html">MBoxProtocol</a> * </td> <td class="paramname"><em>parent</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">info</td><td>The urlinfo which must be used </td></tr> <tr><td class="paramname">parent</td><td>The <a class="el" href="classMBoxProtocol.html" title="This class is the main class and implements all function which can be called through the user...">MBoxProtocol</a> parent instance, used to throw errors. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="mboxfile_8cpp_source.html#l00023">23</a> of file <a class="el" href="mboxfile_8cpp_source.html">mboxfile.cpp</a>.</p> </div> </div> <a class="anchor" id="abd1d8788fb7bfe88de49ce463a4b8dcf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">MBoxFile::~MBoxFile </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Empty destructor. </p> <p>Definition at line <a class="el" href="mboxfile_8cpp_source.html#l00030">30</a> of file <a class="el" href="mboxfile_8cpp_source.html">mboxfile.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aa1f7e0a81ef83f7970c5b8a735ca4f1b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool MBoxFile::lock </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>When implemented, this function handles the locking of the file. </p> <dl class="section return"><dt>Returns</dt><dd>true if the locking was done successfully. </dd></dl> <p>Definition at line <a class="el" href="mboxfile_8cpp_source.html#l00034">34</a> of file <a class="el" href="mboxfile_8cpp_source.html">mboxfile.cpp</a>.</p> </div> </div> <a class="anchor" id="a1da7dbc86509f4345743560c5591adcd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void MBoxFile::unlock </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>When implemented, this function unlocks the file. </p> <p>Definition at line <a class="el" href="mboxfile_8cpp_source.html#l00040">40</a> of file <a class="el" href="mboxfile_8cpp_source.html">mboxfile.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="aa04cff696c2aa36bfaabbe1b7f6de39d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const UrlInfo* const MBoxFile::m_info</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>This can be used to get information about the file. </p> <p>The file specified here is the file that must be used. </p> <p>Definition at line <a class="el" href="mboxfile_8h_source.html#l00061">61</a> of file <a class="el" href="mboxfile_8h_source.html">mboxfile.h</a>.</p> </div> </div> <a class="anchor" id="aa6f62c9cf19f0b270f2914c9348e83dd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classMBoxProtocol.html">MBoxProtocol</a>* const MBoxFile::m_mbox</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>A instance of the parent protocol, meant to throw errors if neccesairy. </p> <p>Definition at line <a class="el" href="mboxfile_8h_source.html#l00066">66</a> of file <a class="el" href="mboxfile_8h_source.html">mboxfile.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="mboxfile_8h_source.html">mboxfile.h</a></li> <li><a class="el" href="mboxfile_8cpp_source.html">mboxfile.cpp</a></li> </ul> </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>