korganizer Library API Documentation

EventArchiver Class Reference

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

#include <eventarchiver.h>

Inheritance diagram for EventArchiver:

Inheritance graph
[legend]
Collaboration diagram for EventArchiver:

Collaboration graph
[legend]
List of all members.

Signals

void eventsDeleted ()

Public Member Functions

 EventArchiver (QObject *parent=0, const char *name=0)
void runOnce (Calendar *calendar, const QDate &limitDate, QWidget *widget)
void runAuto (Calendar *calendar, QWidget *widget, bool withGUI)

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.

Definition at line 46 of file eventarchiver.h.


Member Function Documentation

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

Delete or archive events once.

Parameters:
calendar the calendar to
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

Definition at line 47 of file eventarchiver.cpp.

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

Delete or archive events.

This is called regularly, when auto-archiving is enabled

Parameters:
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.

Definition at line 52 of file eventarchiver.cpp.

Referenced by ActionManager::slotAutoArchive().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for korganizer Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 22:45:42 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003