korganizer

Signals | Public Member Functions | List of all members
EventArchiver Class Reference

#include <eventarchiver.h>

Inherits TQObject.

Signals

void eventsDeleted ()
 

Public Member Functions

 EventArchiver (TQObject *parent=0, const char *name=0)
 
void runOnce (Calendar *calendar, const TQDate &limitDate, TQWidget *widget)
 
void runAuto (Calendar *calendar, TQWidget *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 47 of file eventarchiver.h.

Member Function Documentation

◆ runAuto()

void EventArchiver::runAuto ( Calendar *  calendar,
TQWidget *  widget,
bool  withGUI 
)

Delete or archive events.

This is called regularly, when auto-archiving is enabled

Parameters
calendarthe calendar to archive
widgetparent widget for message boxes
withGUIwhether 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 53 of file eventarchiver.cpp.

◆ runOnce()

void EventArchiver::runOnce ( Calendar *  calendar,
const TQDate &  limitDate,
TQWidget *  widget 
)

Delete or archive events once.

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

Definition at line 48 of file eventarchiver.cpp.

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