• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

kalarm

PreferencesBase Class Reference

#include <kalarmconfig.h>

Inheritance diagram for PreferencesBase:

[legend]

List of all members.

---

Detailed Description

Definition at line 14 of file kalarmconfig.h.

Public Types
enum	{   signalMessageColoursChanged = 0x1, signalShowInSystemTrayChanged = 0x2, signalBase_TimeZoneChanged = 0x4, signalBase_StartOfDayChanged = 0x8,   signalBase_WorkTimeChanged = 0x10, signalDisabledColourChanged = 0x20, signalArchivedColourChanged = 0x40, signalArchivedKeepDaysChanged = 0x80,   signalFeb29TypeChanged = 0x100 }
enum	CmdLogType { Log_Discard, Log_File, Log_Terminal }
enum	Feb29Type { Feb29_Feb28, Feb29_Mar1, Feb29_None }
enum	MailClient { sendmail, kmail }
enum	RecurType {   Recur_None, Recur_Login, Recur_SubDaily, Recur_Daily,   Recur_Weekly, Recur_Monthly, Recur_Yearly }
enum	SoundType { Sound_None, Sound_Beep, Sound_File, Sound_Speak }
Signals
void	archivedColourChanged (const QColor &ArchivedColour)
void	archivedKeepDaysChanged (int ArchivedKeepDays)
void	base_StartOfDayChanged (const QDateTime &Base_StartOfDay)
void	base_TimeZoneChanged (const QString &Base_TimeZone)
void	base_WorkTimeChanged (const QDateTime &Base_WorkDayStart, const QDateTime &Base_WorkDayEnd, int Base_WorkDays)
void	disabledColourChanged (const QColor &DisabledColour)
void	feb29TypeChanged (Feb29Type DefaultFeb29Type)
void	messageColoursChanged ()
void	showInSystemTrayChanged (bool ShowInSystemTray)
Public Member Functions
ItemColor *	archivedColourItem ()
ItemInt *	archivedKeepDaysItem ()
ItemBool *	askResourceItem ()
ItemBool *	autoStartItem ()
ItemString *	base_CmdXTermCommandItem ()
ItemBool *	base_ConfirmAlarmDeletionItem ()
ItemInt *	base_DefaultSoundVolumeItem ()
ItemString *	base_EmailBccAddressItem ()
ItemBool *	base_EmailCopyToKMailItem ()
ItemString *	base_EmailFromItem ()
ItemBool *	base_EmailQueuedNotifyItem ()
ItemStringList *	base_MessageColoursItem ()
ItemString *	base_QuitWarnItem ()
ItemDateTime *	base_StartOfDayItem ()
ItemString *	base_TimeZoneItem ()
ItemDateTime *	base_WorkDayEndItem ()
ItemUInt *	base_WorkDaysItem ()
ItemDateTime *	base_WorkDayStartItem ()
ItemBool *	defaultAutoCloseItem ()
ItemColor *	defaultBgColourItem ()
ItemBool *	defaultCancelOnPreActionErrorItem ()
ItemPath *	defaultCmdLogFileItem ()
ItemEnum *	defaultCmdLogTypeItem ()
ItemBool *	defaultCmdScriptItem ()
ItemBool *	defaultConfirmAckItem ()
ItemBool *	defaultCopyToKOrganizerItem ()
ItemBool *	defaultEmailBccItem ()
ItemEnum *	defaultFeb29TypeItem ()
ItemInt *	defaultLateCancelItem ()
ItemString *	defaultPostActionItem ()
ItemString *	defaultPreActionItem ()
ItemEnum *	defaultRecurPeriodItem ()
ItemEnum *	defaultReminderUnitsItem ()
ItemPath *	defaultSoundFileItem ()
ItemBool *	defaultSoundRepeatItem ()
ItemEnum *	defaultSoundTypeItem ()
ItemColor *	disabledColourItem ()
ItemEnum *	emailClientItem ()
ItemInt *	messageButtonDelayItem ()
ItemFont *	messageFontItem ()
ItemBool *	modalMessagesItem ()
ItemBool *	showInSystemTrayItem ()
ItemBool *	showTooltipAlarmTimeItem ()
ItemBool *	showTooltipTimeToAlarmItem ()
ItemInt *	sodItem ()
ItemInt *	tooltipAlarmCountItem ()
ItemString *	tooltipTimeToPrefixItem ()
ItemString *	versionItem ()
	~PreferencesBase ()
Static Public Member Functions
static QColor	archivedColour ()
static int	archivedKeepDays ()
static bool	askResource ()
static bool	autoStart ()
static QString	base_CmdXTermCommand ()
static bool	base_ConfirmAlarmDeletion ()
static int	base_DefaultSoundVolume ()
static QString	base_EmailBccAddress ()
static bool	base_EmailCopyToKMail ()
static QString	base_EmailFrom ()
static bool	base_EmailQueuedNotify ()
static QStringList	base_MessageColours ()
static QString	base_QuitWarn ()
static QDateTime	base_StartOfDay ()
static QString	base_TimeZone ()
static QDateTime	base_WorkDayEnd ()
static uint	base_WorkDays ()
static QDateTime	base_WorkDayStart ()
static bool	defaultAutoClose ()
static QColor	defaultBgColour ()
static bool	defaultCancelOnPreActionError ()
static QString	defaultCmdLogFile ()
static CmdLogType	defaultCmdLogType ()
static bool	defaultCmdScript ()
static bool	defaultConfirmAck ()
static bool	defaultCopyToKOrganizer ()
static bool	defaultEmailBcc ()
static Feb29Type	defaultFeb29Type ()
static int	defaultLateCancel ()
static QString	defaultPostAction ()
static QString	defaultPreAction ()
static RecurType	defaultRecurPeriod ()
static TimePeriod::Units	defaultReminderUnits ()
static QString	defaultSoundFile ()
static bool	defaultSoundRepeat ()
static SoundType	defaultSoundType ()
static QColor	disabledColour ()
static MailClient	emailClient ()
static int	messageButtonDelay ()
static QFont	messageFont ()
static bool	modalMessages ()
static PreferencesBase *	self ()
static void	setArchivedColour (const QColor &v)
static void	setArchivedKeepDays (int v)
static void	setAskResource (bool v)
static void	setAutoStart (bool v)
static void	setBase_CmdXTermCommand (const QString &v)
static void	setBase_ConfirmAlarmDeletion (bool v)
static void	setBase_DefaultSoundVolume (int v)
static void	setBase_EmailBccAddress (const QString &v)
static void	setBase_EmailCopyToKMail (bool v)
static void	setBase_EmailFrom (const QString &v)
static void	setBase_EmailQueuedNotify (bool v)
static void	setBase_MessageColours (const QStringList &v)
static void	setBase_QuitWarn (const QString &v)
static void	setBase_StartOfDay (const QDateTime &v)
static void	setBase_TimeZone (const QString &v)
static void	setBase_WorkDayEnd (const QDateTime &v)
static void	setBase_WorkDays (uint v)
static void	setBase_WorkDayStart (const QDateTime &v)
static void	setDefaultAutoClose (bool v)
static void	setDefaultBgColour (const QColor &v)
static void	setDefaultCancelOnPreActionError (bool v)
static void	setDefaultCmdLogFile (const QString &v)
static void	setDefaultCmdLogType (CmdLogType v)
static void	setDefaultCmdScript (bool v)
static void	setDefaultConfirmAck (bool v)
static void	setDefaultCopyToKOrganizer (bool v)
static void	setDefaultEmailBcc (bool v)
static void	setDefaultFeb29Type (Feb29Type v)
static void	setDefaultLateCancel (int v)
static void	setDefaultPostAction (const QString &v)
static void	setDefaultPreAction (const QString &v)
static void	setDefaultRecurPeriod (RecurType v)
static void	setDefaultReminderUnits (TimePeriod::Units v)
static void	setDefaultSoundFile (const QString &v)
static void	setDefaultSoundRepeat (bool v)
static void	setDefaultSoundType (SoundType v)
static void	setDisabledColour (const QColor &v)
static void	setEmailClient (MailClient v)
static void	setMessageButtonDelay (int v)
static void	setMessageFont (const QFont &v)
static void	setModalMessages (bool v)
static void	setShowInSystemTray (bool v)
static void	setShowTooltipAlarmTime (bool v)
static void	setShowTooltipTimeToAlarm (bool v)
static void	setSod (int v)
static void	setTooltipAlarmCount (int v)
static void	setTooltipTimeToPrefix (const QString &v)
static void	setVersion (const QString &v)
static bool	showInSystemTray ()
static bool	showTooltipAlarmTime ()
static bool	showTooltipTimeToAlarm ()
static int	sod ()
static int	tooltipAlarmCount ()
static QString	tooltipTimeToPrefix ()
static QString	version ()
Protected Member Functions
	PreferencesBase ()
virtual void	usrWriteConfig ()
Protected Attributes
QColor	mArchivedColour
int	mArchivedKeepDays
bool	mAskResource
bool	mAutoStart
QString	mBase_CmdXTermCommand
bool	mBase_ConfirmAlarmDeletion
int	mBase_DefaultSoundVolume
QString	mBase_EmailBccAddress
bool	mBase_EmailCopyToKMail
QString	mBase_EmailFrom
bool	mBase_EmailQueuedNotify
QStringList	mBase_MessageColours
QString	mBase_QuitWarn
QDateTime	mBase_StartOfDay
QString	mBase_TimeZone
QDateTime	mBase_WorkDayEnd
uint	mBase_WorkDays
QDateTime	mBase_WorkDayStart
bool	mDefaultAutoClose
QColor	mDefaultBgColour
bool	mDefaultCancelOnPreActionError
QString	mDefaultCmdLogFile
int	mDefaultCmdLogType
bool	mDefaultCmdScript
bool	mDefaultConfirmAck
bool	mDefaultCopyToKOrganizer
bool	mDefaultEmailBcc
int	mDefaultFeb29Type
int	mDefaultLateCancel
QString	mDefaultPostAction
QString	mDefaultPreAction
int	mDefaultRecurPeriod
int	mDefaultReminderUnits
QString	mDefaultSoundFile
bool	mDefaultSoundRepeat
int	mDefaultSoundType
QColor	mDisabledColour
int	mEmailClient
int	mMessageButtonDelay
QFont	mMessageFont
bool	mModalMessages
bool	mShowInSystemTray
bool	mShowTooltipAlarmTime
bool	mShowTooltipTimeToAlarm
int	mSod
int	mTooltipAlarmCount
QString	mTooltipTimeToPrefix
QString	mVersion

---

Member Enumeration Documentation

anonymous enum

Enumerator:

signalMessageColoursChanged
signalShowInSystemTrayChanged
signalBase_TimeZoneChanged
signalBase_StartOfDayChanged
signalBase_WorkTimeChanged
signalDisabledColourChanged
signalArchivedColourChanged
signalArchivedKeepDaysChanged
signalFeb29TypeChanged

Definition at line 24 of file kalarmconfig.h.

enum PreferencesBase::CmdLogType

Enumerator:

Log_Discard
Log_File
Log_Terminal

Definition at line 20 of file kalarmconfig.h.

enum PreferencesBase::Feb29Type

Enumerator:

Feb29_Feb28
Feb29_Mar1
Feb29_None

Definition at line 22 of file kalarmconfig.h.

enum PreferencesBase::MailClient

Enumerator:

sendmail
kmail

Definition at line 18 of file kalarmconfig.h.

enum PreferencesBase::RecurType

Enumerator:

Recur_None
Recur_Login
Recur_SubDaily
Recur_Daily
Recur_Weekly
Recur_Monthly
Recur_Yearly

Definition at line 21 of file kalarmconfig.h.

enum PreferencesBase::SoundType

Enumerator:

Sound_None
Sound_Beep
Sound_File
Sound_Speak

Definition at line 19 of file kalarmconfig.h.

---

Constructor & Destructor Documentation

PreferencesBase::~PreferencesBase

(

)

Definition at line 409 of file kalarmconfig.cpp.

PreferencesBase::PreferencesBase

(

)

[protected]

Definition at line 31 of file kalarmconfig.cpp.

---

Member Function Documentation

static QColor PreferencesBase::archivedColour

(

)

[inline, static]

Get Archived alarm color.

Definition at line 763 of file kalarmconfig.h.

void PreferencesBase::archivedColourChanged

(

const QColor &

ArchivedColour

)

[signal]

ItemColor* PreferencesBase::archivedColourItem

(

)

[inline]

Get Item object corresponding to ArchivedColour().

Definition at line 771 of file kalarmconfig.h.

static int PreferencesBase::archivedKeepDays

(

)

[inline, static]

Get Days to keep expired alarms.

Definition at line 797 of file kalarmconfig.h.

void PreferencesBase::archivedKeepDaysChanged

(

int

ArchivedKeepDays

)

[signal]

ItemInt* PreferencesBase::archivedKeepDaysItem

(

)

[inline]

Get Item object corresponding to ArchivedKeepDays().

Definition at line 805 of file kalarmconfig.h.

static bool PreferencesBase::askResource

(

)

[inline, static]

Get Prompt for which resource to store in.

Definition at line 248 of file kalarmconfig.h.

ItemBool* PreferencesBase::askResourceItem

(

)

[inline]

Get Item object corresponding to AskResource().

Definition at line 256 of file kalarmconfig.h.

static bool PreferencesBase::autoStart

(

)

[inline, static]

Get Start at login.

Definition at line 221 of file kalarmconfig.h.

ItemBool* PreferencesBase::autoStartItem

(

)

[inline]

Get Item object corresponding to AutoStart().

Definition at line 229 of file kalarmconfig.h.

static QString PreferencesBase::base_CmdXTermCommand

(

)

[inline, static]

Get Terminal for command alarms.

Definition at line 562 of file kalarmconfig.h.

ItemString* PreferencesBase::base_CmdXTermCommandItem

(

)

[inline]

Get Item object corresponding to Base_CmdXTermCommand().

Definition at line 570 of file kalarmconfig.h.

static bool PreferencesBase::base_ConfirmAlarmDeletion

(

)

[inline, static]

Get Confirm alarm deletions.

Definition at line 1356 of file kalarmconfig.h.

ItemBool* PreferencesBase::base_ConfirmAlarmDeletionItem

(

)

[inline]

Get Item object corresponding to Base_ConfirmAlarmDeletion().

Definition at line 1364 of file kalarmconfig.h.

static int PreferencesBase::base_DefaultSoundVolume

(

)

[inline, static]

Get Sound volume.

Definition at line 1003 of file kalarmconfig.h.

ItemInt* PreferencesBase::base_DefaultSoundVolumeItem

(

)

[inline]

Get Item object corresponding to Base_DefaultSoundVolume().

Definition at line 1011 of file kalarmconfig.h.

static QString PreferencesBase::base_EmailBccAddress

(

)

[inline, static]

Get 'Bcc' email address.

Definition at line 535 of file kalarmconfig.h.

ItemString* PreferencesBase::base_EmailBccAddressItem

(

)

[inline]

Get Item object corresponding to Base_EmailBccAddress().

Definition at line 543 of file kalarmconfig.h.

static bool PreferencesBase::base_EmailCopyToKMail

(

)

[inline, static]

Get Whether to copy sent emails into KMail's Sent folder.

Definition at line 481 of file kalarmconfig.h.

ItemBool* PreferencesBase::base_EmailCopyToKMailItem

(

)

[inline]

Get Item object corresponding to Base_EmailCopyToKMail().

Definition at line 489 of file kalarmconfig.h.

static QString PreferencesBase::base_EmailFrom

(

)

[inline, static]

Get 'From' email address.

Definition at line 508 of file kalarmconfig.h.

ItemString* PreferencesBase::base_EmailFromItem

(

)

[inline]

Get Item object corresponding to Base_EmailFrom().

Definition at line 516 of file kalarmconfig.h.

static bool PreferencesBase::base_EmailQueuedNotify

(

)

[inline, static]

Get Notify when remote emails are queued.

Definition at line 1383 of file kalarmconfig.h.

ItemBool* PreferencesBase::base_EmailQueuedNotifyItem

(

)

[inline]

Get Item object corresponding to Base_EmailQueuedNotify().

Definition at line 1391 of file kalarmconfig.h.

static QStringList PreferencesBase::base_MessageColours

(

)

[inline, static]

Get Color selection list.

Definition at line 111 of file kalarmconfig.h.

ItemStringList* PreferencesBase::base_MessageColoursItem

(

)

[inline]

Get Item object corresponding to Base_MessageColours().

Definition at line 119 of file kalarmconfig.h.

static QString PreferencesBase::base_QuitWarn

(

)

[inline, static]

Get Warn before quitting.

Definition at line 1329 of file kalarmconfig.h.

ItemString* PreferencesBase::base_QuitWarnItem

(

)

[inline]

Get Item object corresponding to Base_QuitWarn().

Definition at line 1337 of file kalarmconfig.h.

static QDateTime PreferencesBase::base_StartOfDay

(

)

[inline, static]

Get Start of day for date-only alarms.

Definition at line 591 of file kalarmconfig.h.

void PreferencesBase::base_StartOfDayChanged

(

const QDateTime &

Base_StartOfDay

)

[signal]

ItemDateTime* PreferencesBase::base_StartOfDayItem

(

)

[inline]

Get Item object corresponding to Base_StartOfDay().

Definition at line 599 of file kalarmconfig.h.

static QString PreferencesBase::base_TimeZone

(

)

[inline, static]

Get Time zone.

Definition at line 82 of file kalarmconfig.h.

void PreferencesBase::base_TimeZoneChanged

(

const QString &

Base_TimeZone

)

[signal]

ItemString* PreferencesBase::base_TimeZoneItem

(

)

[inline]

Get Item object corresponding to Base_TimeZone().

Definition at line 90 of file kalarmconfig.h.

static QDateTime PreferencesBase::base_WorkDayEnd

(

)

[inline, static]

Get End time of working day.

Definition at line 676 of file kalarmconfig.h.

ItemDateTime* PreferencesBase::base_WorkDayEndItem

(

)

[inline]

Get Item object corresponding to Base_WorkDayEnd().

Definition at line 684 of file kalarmconfig.h.

static uint PreferencesBase::base_WorkDays

(

)

[inline, static]

Get Working days.

Definition at line 705 of file kalarmconfig.h.

ItemUInt* PreferencesBase::base_WorkDaysItem

(

)

[inline]

Get Item object corresponding to Base_WorkDays().

Definition at line 713 of file kalarmconfig.h.

static QDateTime PreferencesBase::base_WorkDayStart

(

)

[inline, static]

Get Start time of working day.

Definition at line 647 of file kalarmconfig.h.

ItemDateTime* PreferencesBase::base_WorkDayStartItem

(

)

[inline]

Get Item object corresponding to Base_WorkDayStart().

Definition at line 655 of file kalarmconfig.h.

void PreferencesBase::base_WorkTimeChanged	(	const QDateTime &	Base_WorkDayStart,
		const QDateTime &	Base_WorkDayEnd,
		int	Base_WorkDays
	)			[signal]

static bool PreferencesBase::defaultAutoClose

(

)

[inline, static]

Get Auto-close window after late-cancellation time.

Definition at line 856 of file kalarmconfig.h.

ItemBool* PreferencesBase::defaultAutoCloseItem

(

)

[inline]

Get Item object corresponding to DefaultAutoClose().

Definition at line 864 of file kalarmconfig.h.

static QColor PreferencesBase::defaultBgColour

(

)

[inline, static]

Get Background color.

Definition at line 138 of file kalarmconfig.h.

ItemColor* PreferencesBase::defaultBgColourItem

(

)

[inline]

Get Item object corresponding to DefaultBgColour().

Definition at line 146 of file kalarmconfig.h.

static bool PreferencesBase::defaultCancelOnPreActionError

(

)

[inline, static]

Get Cancel alarm on pre-alarm action error.

Definition at line 1275 of file kalarmconfig.h.

ItemBool* PreferencesBase::defaultCancelOnPreActionErrorItem

(

)

[inline]

Get Item object corresponding to DefaultCancelOnPreActionError().

Definition at line 1283 of file kalarmconfig.h.

static QString PreferencesBase::defaultCmdLogFile

(

)

[inline, static]

Get Log file.

Definition at line 1111 of file kalarmconfig.h.

ItemPath* PreferencesBase::defaultCmdLogFileItem

(

)

[inline]

Get Item object corresponding to DefaultCmdLogFile().

Definition at line 1119 of file kalarmconfig.h.

static CmdLogType PreferencesBase::defaultCmdLogType

(

)

[inline, static]

Get Command output.

Definition at line 1084 of file kalarmconfig.h.

ItemEnum* PreferencesBase::defaultCmdLogTypeItem

(

)

[inline]

Get Item object corresponding to DefaultCmdLogType().

Definition at line 1092 of file kalarmconfig.h.

static bool PreferencesBase::defaultCmdScript

(

)

[inline, static]

Get Enter script.

Definition at line 1057 of file kalarmconfig.h.

ItemBool* PreferencesBase::defaultCmdScriptItem

(

)

[inline]

Get Item object corresponding to DefaultCmdScript().

Definition at line 1065 of file kalarmconfig.h.

static bool PreferencesBase::defaultConfirmAck

(

)

[inline, static]

Get Confirm acknowledgement.

Definition at line 883 of file kalarmconfig.h.

ItemBool* PreferencesBase::defaultConfirmAckItem

(

)

[inline]

Get Item object corresponding to DefaultConfirmAck().

Definition at line 891 of file kalarmconfig.h.

static bool PreferencesBase::defaultCopyToKOrganizer

(

)

[inline, static]

Get Show in KOrganizer.

Definition at line 910 of file kalarmconfig.h.

ItemBool* PreferencesBase::defaultCopyToKOrganizerItem

(

)