functions.h File Reference

#include <tqsize.h>
#include <tqstring.h>
#include "alarmevent.h"

Go to the source code of this file.

Enumerations
enum	KAlarm::FileType {   Unknown , TextPlain , TextFormatted , TextApplication ,   Image }
enum	KAlarm::UpdateStatus {   UPDATE_OK , UPDATE_KORG_ERR , UPDATE_ERROR , UPDATE_FAILED ,   SAVE_FAILED }
enum	KAlarm::UpdateError { ERR_ADD , ERR_DELETE , ERR_REACTIVATE , ERR_TEMPLATE }
enum	KAlarm::KOrgUpdateError { KORG_ERR_ADD , KORG_ERR_MODIFY , KORG_ERR_DELETE }

Functions
MainWindow *	KAlarm::displayMainWindowSelected (const TQString &eventID=TQString())
bool	KAlarm::readConfigWindowSize (const char *window, TQSize &result)
void	KAlarm::writeConfigWindowSize (const char *window, const TQSize &size)
FileType	KAlarm::fileType (const TQString &mimetype)
int	KAlarm::Version ()
int	KAlarm::Version (int major, int minor, int rev)
int	KAlarm::getVersionNumber (const TQString &version, TQString *subVersion)
int	KAlarm::currentCalendarVersion ()
TQString	KAlarm::currentCalendarVersionString ()
TQString	KAlarm::browseFile (const TQString &caption, TQString &defaultDir, const TQString &initialFile, const TQString &filter, int mode, TQWidget *parent, const char *name)
bool	KAlarm::edit (const TQString &eventID)
bool	KAlarm::editNew (const TQString &templateName)
TDEAction *	KAlarm::createNewAlarmAction (const TQString &label, TQObject *receiver, const char *slot, TDEActionCollection *, const char *name)
TemplateMenuAction *	KAlarm::createNewFromTemplateAction (const TQString &label, TQObject *receiver, const char *slot, TDEActionCollection *, const char *name)
TQValueList< KAEvent >	KAlarm::templateList ()
void	KAlarm::outputAlarmWarnings (TQWidget *parent, const KAEvent *event)
void	KAlarm::resetDaemon ()
void	KAlarm::resetDaemonIfQueued ()
TQString	KAlarm::runKMail (bool minimise)
bool	KAlarm::runProgram (const TQCString &program, const TQCString &windowName, TQCString &dcopName, TQString &errorMessage)
UpdateStatus	KAlarm::addEvent (KAEvent &event, AlarmListView *selectionView, TQWidget *errmsgParent, bool useEventID, bool allowKOrgUpdate)
bool	KAlarm::addExpiredEvent (KAEvent &event)
UpdateStatus	KAlarm::addTemplate (KAEvent &event, TemplateListView *selectionView, TQWidget *errmsgParent)
UpdateStatus	KAlarm::modifyEvent (KAEvent &oldEvent, const KAEvent &newEvent, AlarmListView *selectionView, TQWidget *errmsgParent)
UpdateStatus	KAlarm::updateEvent (KAEvent &event, AlarmListView *selectionView, TQWidget *errmsgParent, bool archiveOnDelete, bool incRevision)
UpdateStatus	KAlarm::updateTemplate (const KAEvent &event, TemplateListView *selectionView, TQWidget *errmsgParent)
UpdateStatus	KAlarm::deleteEvent (KAEvent &event, bool archive, TQWidget *errmsgParent)
UpdateStatus	KAlarm::deleteTemplate (const KAEvent &event)
void	KAlarm::deleteDisplayEvent (const TQString &eventID)
UpdateStatus	KAlarm::reactivateEvent (KAEvent &event, AlarmListView *selectionView, bool useEventID)
UpdateStatus	KAlarm::enableEvent (KAEvent &event, AlarmListView *selectionView, bool enable)
void	KAlarm::displayUpdateError (TQWidget *parent, UpdateStatus, UpdateError code, int nAlarms)
void	KAlarm::displayKOrgUpdateError (TQWidget *parent, KOrgUpdateError code, int nAlarms)
TQString	KAlarm::stripAccel (const TQString &text)
int	KAlarm::localeFirstDayOfWeek ()
int	KAlarm::weekDay_to_localeDayInWeek (int weekDay)
int	KAlarm::localeDayInWeek_to_weekDay (int index)

Detailed Description

• miscellaneous functions

Definition in file functions.h.

Enumeration Type Documentation

FileType

enum KAlarm::FileType

Return codes from fileType()

Definition at line 47 of file functions.h.

KOrgUpdateError

enum KAlarm::KOrgUpdateError

Error codes supplied as parameter to displayKOrgUpdateError()

Definition at line 61 of file functions.h.

UpdateError

enum KAlarm::UpdateError

Error codes supplied as parameter to displayUpdateError()

Definition at line 59 of file functions.h.

UpdateStatus

enum KAlarm::UpdateStatus

Return codes from calendar update functions.

The codes are ordered by severity.

Definition at line 51 of file functions.h.

Function Documentation

addEvent()

UpdateStatus KAlarm::addEvent	(	KAEvent &	event,
		AlarmListView *	selectionView,
		TQWidget *	errmsgParent,
		bool	useEventID,
		bool	allowKOrgUpdate
	)

Definition at line 132 of file functions.cpp.

addExpiredEvent()

bool KAlarm::addExpiredEvent

(

KAEvent &

event

)

Definition at line 169 of file functions.cpp.

addTemplate()

UpdateStatus KAlarm::addTemplate	(	KAEvent &	event,
		TemplateListView *	selectionView,
		TQWidget *	errmsgParent
	)

Definition at line 196 of file functions.cpp.

browseFile()

TQString KAlarm::browseFile	(	const TQString &	caption,
		TQString &	defaultDir,
		const TQString &	initialFile,
		const TQString &	filter,
		int	mode,
		TQWidget *	parent,
		const char *	name
	)

Definition at line 870 of file functions.cpp.

createNewAlarmAction()

TDEAction * KAlarm::createNewAlarmAction	(	const TQString &	label,
		TQObject *	receiver,
		const char *	slot,
		TDEActionCollection *	actions,
		const char *	name
	)

Create a "New Alarm" TDEAction.

Definition at line 112 of file functions.cpp.

createNewFromTemplateAction()

TemplateMenuAction * KAlarm::createNewFromTemplateAction	(	const TQString &	label,
		TQObject *	receiver,
		const char *	slot,
		TDEActionCollection *	actions,
		const char *	name
	)

Create a "New From Template" TDEAction.

Definition at line 120 of file functions.cpp.

currentCalendarVersion()

int KAlarm::currentCalendarVersion ( )

inline

Return which version of KAlarm was the first to use the current calendar/event format.

Definition at line 77 of file functions.h.

currentCalendarVersionString()

TQString KAlarm::currentCalendarVersionString ( )

inline

Definition at line 78 of file functions.h.

deleteDisplayEvent()

void KAlarm::deleteDisplayEvent

(

const TQString &

eventID

)

Definition at line 406 of file functions.cpp.

deleteEvent()

UpdateStatus KAlarm::deleteEvent	(	KAEvent &	event,
		bool	archive,
		TQWidget *	errmsgParent
	)

Definition at line 341 of file functions.cpp.

deleteTemplate()

UpdateStatus KAlarm::deleteTemplate

(

const KAEvent &

event

)

Definition at line 386 of file functions.cpp.

displayKOrgUpdateError()

void KAlarm::displayKOrgUpdateError	(	TQWidget *	parent,
		KOrgUpdateError	code,
		int	nAlarms
	)

Definition at line 528 of file functions.cpp.

displayMainWindowSelected()

MainWindow * KAlarm::displayMainWindowSelected

(

const TQString &

eventID

)

Display a main window with the specified event selected.

Definition at line 82 of file functions.cpp.

displayUpdateError()

void KAlarm::displayUpdateError	(	TQWidget *	parent,
		UpdateStatus	,
		UpdateError	code,
		int	nAlarms
	)

Definition at line 501 of file functions.cpp.

edit()

bool KAlarm::edit

(

const TQString &

eventID

)

Definition at line 551 of file functions.cpp.

editNew()

bool KAlarm::editNew

(

const TQString &

templateName

)

Definition at line 581 of file functions.cpp.

enableEvent()

UpdateStatus KAlarm::enableEvent	(	KAEvent &	event,
		AlarmListView *	selectionView,
		bool	enable
	)

Definition at line 471 of file functions.cpp.

fileType()

FileType KAlarm::fileType

(

const TQString &

mimetype

)

Check from its mime type whether a file appears to be a text or image file.

If a text file, its type is distinguished.

Definition at line 829 of file functions.cpp.

getVersionNumber()

int KAlarm::getVersionNumber	(	const TQString &	version,
		TQString *	subVersion
	)

Definition at line 790 of file functions.cpp.

localeDayInWeek_to_weekDay()

int KAlarm::localeDayInWeek_to_weekDay ( int  index )

inline

Definition at line 125 of file functions.h.

localeFirstDayOfWeek()

int KAlarm::localeFirstDayOfWeek

(

)

Definition at line 893 of file functions.cpp.

modifyEvent()

UpdateStatus KAlarm::modifyEvent	(	KAEvent &	oldEvent,
		const KAEvent &	newEvent,
		AlarmListView *	selectionView,
		TQWidget *	errmsgParent
	)

Definition at line 228 of file functions.cpp.

outputAlarmWarnings()

void KAlarm::outputAlarmWarnings	(	TQWidget *	parent,
		const KAEvent *	event
	)

Definition at line 631 of file functions.cpp.

reactivateEvent()

UpdateStatus KAlarm::reactivateEvent	(	KAEvent &	event,
		AlarmListView *	selectionView,
		bool	useEventID
	)

Definition at line 424 of file functions.cpp.

readConfigWindowSize()

bool KAlarm::readConfigWindowSize	(	const char *	window,
		TQSize &	result
	)

Definition at line 746 of file functions.cpp.

resetDaemon()

void KAlarm::resetDaemon

(

)

Definition at line 652 of file functions.cpp.

resetDaemonIfQueued()

void KAlarm::resetDaemonIfQueued

(

)

Definition at line 669 of file functions.cpp.

runKMail()

TQString KAlarm::runKMail

(

bool

minimise

)

Definition at line 703 of file functions.cpp.

runProgram()

bool KAlarm::runProgram	(	const TQCString &	program,
		const TQCString &	windowName,
		TQCString &	dcopName,
		TQString &	errorMessage
	)

Definition at line 719 of file functions.cpp.

stripAccel()

TQString KAlarm::stripAccel

(

const TQString &

text

)

Definition at line 904 of file functions.cpp.

templateList()

TQValueList< KAEvent > KAlarm::templateList

(

)

Returns a list of all alarm templates.

If shell commands are disabled, command alarm templates are omitted.

Definition at line 607 of file functions.cpp.

updateEvent()

UpdateStatus KAlarm::updateEvent	(	KAEvent &	event,
		AlarmListView *	selectionView,
		TQWidget *	errmsgParent,
		bool	archiveOnDelete,
		bool	incRevision
	)

Definition at line 283 of file functions.cpp.

updateTemplate()

UpdateStatus KAlarm::updateTemplate	(	const KAEvent &	event,
		TemplateListView *	selectionView,
		TQWidget *	errmsgParent
	)

Definition at line 314 of file functions.cpp.

Version() [1/2]

int KAlarm::Version

(

)

Return current KAlarm version number.

Definition at line 776 of file functions.cpp.

Version() [2/2]

int KAlarm::Version ( int  major, int  minor, int  rev  )

inline

Definition at line 74 of file functions.h.

weekDay_to_localeDayInWeek()

int KAlarm::weekDay_to_localeDayInWeek ( int  weekDay )

inline

Definition at line 119 of file functions.h.

writeConfigWindowSize()

void KAlarm::writeConfigWindowSize	(	const char *	window,
		const TQSize &	size
	)

Definition at line 763 of file functions.cpp.