KDE PIM / Developers / API Docs / korganizer

EventArchiver Class Reference

This class handles expiring and archiving of events. More...

#include <eventarchiver.h>

Inherits QObject.

List of all members.

Signals

Public Member Functions


Detailed Description

This class handles expiring and archiving of events.

It is used directly by the archivedialog, and it is also triggered by actionmanager's timer for auto-archiving.

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.


Member Function Documentation

void EventArchiver::runOnce Calendar *  calendar,
const QDate &  limitDate,
QWidget *  widget
 

Delete or archive events once.

Parameters:
calendar the calendar to archive
limitDate all events *before* the limitDate (not included) will be deleted/archived.
widget parent widget for message boxes Confirmation and "no events to process" dialogs will be shown

void EventArchiver::runAuto Calendar *  calendar,
QWidget *  widget,
bool  withGUI
 

Delete or archive events.

This is called regularly, when auto-archiving is enabled

Parameters:
calendar the calendar to archive
widget parent widget for message boxes
withGUI 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.

The documentation for this class was generated from the following files: