<?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_US" xml:lang="en_US">
<head>
<title>korganizer: EventArchiver Class Reference (korganizer)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<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" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
/ <a href=".">korganizer</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>korganizer</h2>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>EventArchiver Class Reference</h1><!-- doxytag: class="EventArchiver" --><!-- doxytag: inherits="QObject" --><code>#include <<a class="el" href="eventarchiver_8h-source.html">eventarchiver.h</a>></code>
<p>
Inherits QObject.
<p>
<p>
<a href="classEventArchiver-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
This class handles expiring and archiving of events.
<p>
It is used directly by the archivedialog, and it is also triggered by actionmanager's timer for auto-archiving.<p>
The settings are not held in this class, but directly in KOPrefs (from korganizer.kcfg) Be sure to set mArchiveAction and mArchiveFile before a manual archiving mAutoArchive is used for auto archiving.
<p>Definition at line <a class="el" href="eventarchiver_8h-source.html#l00047">47</a> of file <a class="el" href="eventarchiver_8h-source.html">eventarchiver.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5a3487e138d0099e5021a670c985853"></a><!-- doxytag: member="EventArchiver::eventsDeleted" ref="e5a3487e138d0099e5021a670c985853" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>eventsDeleted</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d21cc4a7b50e527507a07ad50d36e4bc"></a><!-- doxytag: member="EventArchiver::EventArchiver" ref="d21cc4a7b50e527507a07ad50d36e4bc" args="(QObject *parent=0, const char *name=0)" -->
</td><td class="memItemRight" valign="bottom"><b>EventArchiver</b> (QObject *parent=0, const char *name=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventArchiver.html#67aec36352880675c0296bf25a9bef14">runOnce</a> (<a class="elRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Calendar.html">Calendar</a> *calendar, const QDate &limitDate, QWidget *widget)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEventArchiver.html#e5a6415e04b3466c3c53551bf6bdc7a1">runAuto</a> (<a class="elRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Calendar.html">Calendar</a> *calendar, QWidget *widget, bool withGUI)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="67aec36352880675c0296bf25a9bef14"></a><!-- doxytag: member="EventArchiver::runOnce" ref="67aec36352880675c0296bf25a9bef14" args="(Calendar *calendar, const QDate &limitDate, QWidget *widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EventArchiver::runOnce </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Calendar.html">Calendar</a> * </td>
<td class="paramname"> <em>calendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QDate & </td>
<td class="paramname"> <em>limitDate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QWidget * </td>
<td class="paramname"> <em>widget</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete or archive events once.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>calendar</em> </td><td>the calendar to archive </td></tr>
<tr><td valign="top"></td><td valign="top"><em>limitDate</em> </td><td>all events *before* the limitDate (not included) will be deleted/archived. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>widget</em> </td><td>parent widget for message boxes Confirmation and "no events to process" dialogs will be shown </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="eventarchiver_8cpp-source.html#l00048">48</a> of file <a class="el" href="eventarchiver_8cpp-source.html">eventarchiver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e5a6415e04b3466c3c53551bf6bdc7a1"></a><!-- doxytag: member="EventArchiver::runAuto" ref="e5a6415e04b3466c3c53551bf6bdc7a1" args="(Calendar *calendar, QWidget *widget, bool withGUI)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void EventArchiver::runAuto </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Calendar.html">Calendar</a> * </td>
<td class="paramname"> <em>calendar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QWidget * </td>
<td class="paramname"> <em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>withGUI</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete or archive events.
<p>
This is called regularly, when auto-archiving is enabled <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>calendar</em> </td><td>the calendar to archive </td></tr>
<tr><td valign="top"></td><td valign="top"><em>widget</em> </td><td>parent widget for message boxes </td></tr>
<tr><td valign="top"></td><td valign="top"><em>withGUI</em> </td><td>whether this is called from the dialog, so message boxes should be shown. Note that error dialogs like "cannot save" are shown even if from this method, so widget should be set in all cases. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="eventarchiver_8cpp-source.html#l00053">53</a> of file <a class="el" href="eventarchiver_8cpp-source.html">eventarchiver.cpp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="eventarchiver_8h-source.html">eventarchiver.h</a><li><a class="el" href="eventarchiver_8cpp-source.html">eventarchiver.cpp</a></ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>korganizer</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</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="classActionManager.html">actionmanager</option>, <option value="classCalendarView.html">calendarview</option>, <option value="classCalPrinter.html">calprinter</option>, <option value="classCalPrintPluginBase.html">calprintpluginbase</option>, <option value="classConfigDialog.html">configdialog</option>, <option value="classConverter.html">converter</option>, <option value="classDateNavigator.html">datenavigator</option>, <option value="classDynamicTip.html">dynamictip</option>, <option value="classEventArchiver.html">eventarchiver</option>, <option value="classExportWebDialog.html">exportwebdialog</option>, <option value="classFilterEditDialog.html">filtereditdialog</option>, <option value="classFreeBusyDownloadJob.html">freebusydownloadjob</option>, <option value="classHoliday.html">holiday</option>, <option value="classKCalendarIface.html">kcalendariface</option>, <option value="classKOAgendaView.html">koagendaview</option>, <option value="classKOAttendeeEditor.html">koattendeeeditor</option>, <option value="classKOAttendeeListView.html">koattendeelistview</option>, <option value="classKOCounterDialog.html">kocounterdialog</option>, <option value="classKODayMatrix.html">kodaymatrix</option>, <option value="classKODialogManager.html">kodialogmanager</option>, <option value="classKOEventEditor.html">koeventeditor</option>, <option value="classKOEventView.html">koeventview</option>, <option value="classKOEventViewer.html">koeventviewer</option>, <option value="classKOEventViewerDialog.html">koeventviewerdialog</option>, <option value="classKOIncidenceEditor.html">koincidenceeditor</option>, <option value="classKOIncidenceToolTip.html">koincidencetooltip</option>, <option value="classKOJournalEditor.html">kojournaleditor</option>, <option value="classKOJournalView.html">kojournalview</option>, <option value="classKOListView.html">kolistview</option>, <option value="classKOMonthView.html">komonthview</option>, <option value="classKOProjectView.html">koprojectview</option>, <option value="classKOProjectViewItem.html">koprojectviewitem</option>, <option value="classKOrg_1_1AgendaView.html">korg::agendaview</option>, <option value="classKOrg_1_1BaseView.html">korg::baseview</option>, <option value="classKOrg_1_1CalendarDecoration.html">korg::calendardecoration</option>, <option value="classKOrg_1_1CalendarViewBase.html">korg::calendarviewbase</option>, <option value="classKOrg_1_1CalPrinterBase.html">korg::calprinterbase</option>, <option value="classKOrg_1_1MainWindow.html">korg::mainwindow</option>, <option value="classKOrg_1_1MultiAgendaView.html">korg::multiagendaview</option>, <option value="classKOrg_1_1PrintPlugin.html">korg::printplugin</option>, <option value="classKOrganizer.html">korganizer</option>, <option value="classKOTimelineView.html">kotimelineview</option>, <option value="classKOTodoEditor.html">kotodoeditor</option>, <option value="classKOTodoView.html">kotodoview</option>, <option value="classKOTodoViewItem.html">kotodoviewitem</option>, <option value="classKOViewManager.html">koviewmanager</option>, <option value="classKOWhatsNextView.html">kowhatsnextview</option>, <option value="classKOWindowList.html">kowindowlist</option>, <option value="classMonthViewCell.html">monthviewcell</option>, <option value="classParsha.html">parsha</option>, <option value="classResourceView.html">resourceview</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
