CalendarSupport::EventArchiver Class
| Header: | #include <CalendarSupport/EventArchiver> |
| CMake: | find_package(KPim6CalendarSupport REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::CalendarSupport) |
| Inherits: | QObject |
Public Functions
| void | runAuto(const Akonadi::ETMCalendar::Ptr &calendar, Akonadi::IncidenceChanger *changer, QWidget *widget, bool withGUI) |
| void | runOnce(const Akonadi::ETMCalendar::Ptr &calendar, Akonadi::IncidenceChanger *changer, QDate limitDate, QWidget *widget) |
Signals
| void | eventsDeleted() |
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
[signal] void EventArchiver::eventsDeleted()
void EventArchiver::runAuto(const Akonadi::ETMCalendar::Ptr &calendar, Akonadi::IncidenceChanger *changer, QWidget *widget, bool withGUI)
Delete or archive events. This is called regularly, when auto-archiving is enabled 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.
void EventArchiver::runOnce(const Akonadi::ETMCalendar::Ptr &calendar, Akonadi::IncidenceChanger *changer, QDate limitDate, QWidget *widget)
Delete or archive events once 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