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.
130 lines
6.3 KiB
130 lines
6.3 KiB
/*
|
|
* functions.h - miscellaneous functions
|
|
* Program: kalarm
|
|
* Copyright © 2004-2006,2009 by David Jarvie <djarvie@kde.org>
|
|
*
|
|
* 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 FUNCTIONS_H
|
|
#define FUNCTIONS_H
|
|
|
|
/** @file functions.h - miscellaneous functions */
|
|
|
|
#include <tqsize.h>
|
|
#include <tqstring.h>
|
|
|
|
#include "alarmevent.h"
|
|
|
|
class TQObject;
|
|
class TQWidget;
|
|
class TQString;
|
|
class KAction;
|
|
class KActionCollection;
|
|
namespace KCal { class Event; }
|
|
class KAEvent;
|
|
class MainWindow;
|
|
class AlarmListView;
|
|
class TemplateListView;
|
|
class TemplateMenuAction;
|
|
|
|
namespace KAlarm
|
|
{
|
|
|
|
/** Return codes from fileType() */
|
|
enum FileType { Unknown, TextPlain, TextFormatted, TextApplication, Image };
|
|
/** Return codes from calendar update functions.
|
|
* The codes are ordered by severity.
|
|
*/
|
|
enum UpdatetqStatus {
|
|
UPDATE_OK, // update succeeded
|
|
UPDATE_KORG_ERR, // update succeeded, but KOrganizer update failed
|
|
UPDATE_ERROR, // update failed partially
|
|
UPDATE_FAILED, // update failed completely
|
|
SAVE_FAILED // calendar was updated in memory, but save failed
|
|
};
|
|
/** Error codes supplied as parameter to displayUpdateError() */
|
|
enum UpdateError { ERR_ADD, ERR_DELETE, ERR_REACTIVATE, ERR_TEMPLATE };
|
|
/** Error codes supplied as parameter to displayKOrgUpdateError() */
|
|
enum KOrgUpdateError { KORG_ERR_ADD, KORG_ERR_MODIFY, KORG_ERR_DELETE };
|
|
|
|
|
|
/** Display a main window with the specified event selected */
|
|
MainWindow* displayMainWindowSelected(const TQString& eventID = TQString());
|
|
bool readConfigWindowSize(const char* window, TQSize&);
|
|
void writeConfigWindowSize(const char* window, const TQSize&);
|
|
/** Check from its mime type whether a file appears to be a text or image file.
|
|
* If a text file, its type is distinguished.
|
|
*/
|
|
FileType fileType(const TQString& mimetype);
|
|
/** Return current KAlarm version number */
|
|
int Version();
|
|
inline int Version(int major, int minor, int rev) { return major*10000 + minor*100 + rev; }
|
|
int getVersionNumber(const TQString& version, TQString* subVersion = 0);
|
|
/** Return which version of KAlarm was the first to use the current calendar/event format */
|
|
inline int currentCalendarVersion() { return KAEvent::calVersion(); }
|
|
inline TQString currentCalendarVersionString() { return KAEvent::calVersionString(); }
|
|
TQString browseFile(const TQString& caption, TQString& defaultDir, const TQString& initialFile = TQString(),
|
|
const TQString& filter = TQString(), int mode = 0, TQWidget* parent = 0, const char* name = 0);
|
|
bool edit(const TQString& eventID);
|
|
bool editNew(const TQString& templateName = TQString());
|
|
/** Create a "New Alarm" KAction */
|
|
KAction* createNewAlarmAction(const TQString& label, TQObject* receiver, const char* slot, KActionCollection*, const char* name);
|
|
/** Create a "New From Template" KAction */
|
|
TemplateMenuAction* createNewFromTemplateAction(const TQString& label, TQObject* receiver, const char* slot, KActionCollection*, const char* name);
|
|
/** Returns a list of all alarm templates.
|
|
* If shell commands are disabled, command alarm templates are omitted.
|
|
*/
|
|
TQValueList<KAEvent> templateList();
|
|
void outputAlarmWarnings(TQWidget* parent, const KAEvent* = 0);
|
|
void resetDaemon();
|
|
void resetDaemonIfQueued(); // must only be called from KAlarmApp::processQueue()
|
|
TQString runKMail(bool minimise);
|
|
bool runProgram(const TQCString& program, const TQCString& windowName, TQCString& dcopName, TQString& errorMessage);
|
|
|
|
UpdatetqStatus addEvent(KAEvent&, AlarmListView* selectionView, TQWidget* errmsgParent = 0, bool useEventID = false, bool allowKOrgUpdate = true);
|
|
bool addExpiredEvent(KAEvent&);
|
|
UpdatetqStatus addTemplate(KAEvent&, TemplateListView* selectionView, TQWidget* errmsgParent = 0);
|
|
UpdatetqStatus modifyEvent(KAEvent& oldEvent, const KAEvent& newEvent, AlarmListView* selectionView, TQWidget* errmsgParent = 0);
|
|
UpdatetqStatus updateEvent(KAEvent&, AlarmListView* selectionView, TQWidget* errmsgParent = 0, bool archiveOnDelete = true, bool incRevision = true);
|
|
UpdatetqStatus updateTemplate(const KAEvent&, TemplateListView* selectionView, TQWidget* errmsgParent = 0);
|
|
UpdatetqStatus deleteEvent(KAEvent&, bool archive = true, TQWidget* errmsgParent = 0);
|
|
UpdatetqStatus deleteTemplate(const KAEvent&);
|
|
void deleteDisplayEvent(const TQString& eventID);
|
|
UpdatetqStatus reactivateEvent(KAEvent&, AlarmListView* selectionView, bool useEventID = false);
|
|
UpdatetqStatus enableEvent(KAEvent&, AlarmListView* selectionView, bool enable);
|
|
void displayUpdateError(TQWidget* parent, UpdatetqStatus, UpdateError, int nAlarms);
|
|
void displayKOrgUpdateError(TQWidget* parent, KOrgUpdateError, int nAlarms);
|
|
|
|
TQString stripAccel(const TQString&);
|
|
|
|
int localeFirstDayOfWeek();
|
|
|
|
/* Given a standard KDE day number, return the day number in the week for the user's locale.
|
|
* Standard day number = 1 (Mon) .. 7 (Sun)
|
|
* Locale day number in week = 0 .. 6
|
|
*/
|
|
inline int weekDay_to_localeDayInWeek(int weekDay) { return (weekDay + 7 - localeFirstDayOfWeek()) % 7; }
|
|
|
|
/* Given a day number in the week for the user's locale, return the standard KDE day number.
|
|
* 'index' = 0 .. 6
|
|
* Standard day number = 1 (Mon) .. 7 (Sun)
|
|
*/
|
|
inline int localeDayInWeek_to_weekDay(int index) { return (index + localeFirstDayOfWeek() - 1) % 7 + 1; }
|
|
|
|
} // namespace KAlarm
|
|
|
|
#endif // FUNCTIONS_H
|