You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
5.3 KiB
116 lines
5.3 KiB
/*
|
|
* alarmcalendar.h - KAlarm calendar file access
|
|
* Program: kalarm
|
|
* Copyright © 2001-2006 by David Jarvie <software@astrojar.org.uk>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef ALARMCALENDAR_H
|
|
#define ALARMCALENDAR_H
|
|
|
|
#include <tqobject.h>
|
|
#include <kurl.h>
|
|
#include <libkcal/calendarlocal.h>
|
|
#include "alarmevent.h"
|
|
|
|
class TDEConfig;
|
|
|
|
|
|
/** Provides read and write access to calendar files.
|
|
* Either vCalendar or iCalendar files may be read, but the calendar is saved
|
|
* only in iCalendar format to avoid information loss.
|
|
*/
|
|
class AlarmCalendar : public TQObject
|
|
{
|
|
TQ_OBJECT
|
|
|
|
public:
|
|
virtual ~AlarmCalendar();
|
|
bool valid() const { return mUrl.isValid(); }
|
|
KAEvent::Status type() const { return mType; }
|
|
bool open();
|
|
int load();
|
|
bool reload();
|
|
bool save();
|
|
void close();
|
|
void startUpdate();
|
|
bool endUpdate();
|
|
KCal::Event* event(const TQString& uniqueID);
|
|
KCal::Event::List events();
|
|
KCal::Event::List eventsWithAlarms(const TQDateTime& from, const TQDateTime& to);
|
|
KCal::Event* addEvent(KAEvent&, bool useEventID = false);
|
|
void updateEvent(const KAEvent&);
|
|
bool deleteEvent(const TQString& eventID, bool save = false);
|
|
void emitEmptyStatus();
|
|
void purgeAll() { purge(0); }
|
|
void setPurgeDays(int days);
|
|
void purgeIfQueued(); // must only be called from KAlarmApp::processQueue()
|
|
bool isOpen() const { return mOpen; }
|
|
TQString path() const { return mUrl.prettyURL(); }
|
|
TQString urlString() const { return mUrl.url(); }
|
|
|
|
static TQString icalProductId();
|
|
static bool initialiseCalendars();
|
|
static void terminateCalendars();
|
|
static AlarmCalendar* activeCalendar() { return mCalendars[ACTIVE]; }
|
|
static AlarmCalendar* expiredCalendar() { return mCalendars[EXPIRED]; }
|
|
static AlarmCalendar* displayCalendar() { return mCalendars[DISPLAY]; }
|
|
static AlarmCalendar* templateCalendar() { return mCalendars[TEMPLATE]; }
|
|
static AlarmCalendar* activeCalendarOpen() { return calendarOpen(ACTIVE); }
|
|
static AlarmCalendar* expiredCalendarOpen() { return calendarOpen(EXPIRED); }
|
|
static AlarmCalendar* displayCalendarOpen() { return calendarOpen(DISPLAY); }
|
|
static AlarmCalendar* templateCalendarOpen() { return calendarOpen(TEMPLATE); }
|
|
static bool importAlarms(TQWidget*);
|
|
static const KCal::Event* getEvent(const TQString& uniqueID);
|
|
|
|
enum CalID { ACTIVE, EXPIRED, DISPLAY, TEMPLATE, NCALS };
|
|
|
|
signals:
|
|
void calendarSaved(AlarmCalendar*);
|
|
void purged();
|
|
void emptyStatus(bool empty);
|
|
|
|
private slots:
|
|
void slotPurge();
|
|
|
|
private:
|
|
AlarmCalendar(const TQString& file, CalID, const TQString& icalFile = TQString(),
|
|
const TQString& configKey = TQString());
|
|
bool create();
|
|
bool saveCal(const TQString& newFile = TQString());
|
|
void purge(int daysToKeep);
|
|
void startPurgeTimer();
|
|
static AlarmCalendar* createCalendar(CalID, TDEConfig*, TQString& writePath, const TQString& configKey = TQString());
|
|
static AlarmCalendar* calendarOpen(CalID);
|
|
|
|
static AlarmCalendar* mCalendars[NCALS]; // the calendars
|
|
|
|
KCal::CalendarLocal* mCalendar;
|
|
KURL mUrl; // URL of current calendar file
|
|
KURL mICalUrl; // URL of iCalendar file
|
|
TQString mLocalFile; // calendar file, or local copy if it's a remote file
|
|
TQString mConfigKey; // config file key for this calendar's URL
|
|
KAEvent::Status mType; // what type of events the calendar file is for
|
|
int mPurgeDays; // how long to keep alarms, 0 = don't keep, -1 = keep indefinitely
|
|
bool mOpen; // true if the calendar file is open
|
|
int mPurgeDaysQueued; // >= 0 to purge the calendar when called from KAlarmApp::processLoop()
|
|
int mUpdateCount; // nesting level of group of calendar update calls
|
|
bool mUpdateSave; // save() was called while mUpdateCount > 0
|
|
bool mVCal; // true if calendar file is in VCal format
|
|
};
|
|
|
|
#endif // ALARMCALENDAR_H
|