<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kalarm: alarmevent.h Source File (kalarm)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../">API Reference</a>
/ <a href=".">kalarm</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>kalarm</h2>
<!-- Generated by Doxygen 1.5.5 -->
<h1>alarmevent.h</h1><a href="alarmevent_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * alarmevent.h - represents calendar alarms and events</span>
<a name="l00003"></a>00003 <span class="comment"> * Program: kalarm</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright © 2001-2008 by David Jarvie <djarvie@kde.org></span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> * (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00017"></a>00017 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00018"></a>00018 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef KALARMEVENT_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define KALARMEVENT_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <qcolor.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <qfont.h></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#include <libkcal/person.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <libkcal/event.h></span>
<a name="l00031"></a>00031 <span class="keyword">namespace </span>KCal {
<a name="l00032"></a>00032 <span class="keyword">class </span>Calendar;
<a name="l00033"></a>00033 <span class="keyword">class </span>CalendarLocal;
<a name="l00034"></a>00034 }
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include "datetime.h"</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include "karecurrence.h"</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>;
<a name="l00040"></a>00040 <span class="keyword">class </span>KARecurrence;
<a name="l00041"></a>00041 <span class="keyword">struct </span>AlarmData;
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">typedef</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Person.html">KCal::Person</a> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Person.html">EmailAddress</a>;
<a name="l00045"></a>00045 <span class="keyword">class </span>EmailAddressList : <span class="keyword">public</span> QValueList<KCal::Person>
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00048"></a>00048 EmailAddressList() : QValueList<KCal::Person>() { }
<a name="l00049"></a>00049 EmailAddressList(<span class="keyword">const</span> QValueList<KCal::Person>& list) { operator=(list); }
<a name="l00050"></a>00050 EmailAddressList& operator=(<span class="keyword">const</span> QValueList<KCal::Person>&);
<a name="l00051"></a>00051 QString join(<span class="keyword">const</span> QString& separator) <span class="keyword">const</span>;
<a name="l00052"></a>00052 };
<a name="l00053"></a>00053
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// Base class containing data common to KAAlarm and KAEvent</span>
<a name="l00056"></a>00056 <span class="keyword">class </span>KAAlarmEventBase
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00059"></a>00059 ~KAAlarmEventBase() { }
<a name="l00060"></a>00060 <span class="keyword">const</span> QString& cleanText()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mText; }
<a name="l00061"></a>00061 QString message()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_MESSAGE || mActionType == T_EMAIL) ? mText : QString::null; }
<a name="l00062"></a>00062 QString fileName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_FILE) ? mText : QString::null; }
<a name="l00063"></a>00063 QString command()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_COMMAND) ? mText : QString::null; }
<a name="l00064"></a>00064 uint emailFromId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailFromIdentity; }
<a name="l00065"></a>00065 <span class="keyword">const</span> EmailAddressList& emailAddresses()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailAddresses; }
<a name="l00066"></a>00066 QString emailAddresses(<span class="keyword">const</span> QString& sep)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailAddresses.join(sep); }
<a name="l00067"></a>00067 <span class="keyword">const</span> QString& emailSubject()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailSubject; }
<a name="l00068"></a>00068 <span class="keyword">const</span> QStringList& emailAttachments()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailAttachments; }
<a name="l00069"></a>00069 QString emailAttachments(<span class="keyword">const</span> QString& sep)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailAttachments.join(sep); }
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> emailBcc()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEmailBcc; }
<a name="l00071"></a>00071 <span class="keyword">const</span> QColor& bgColour()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mBgColour; }
<a name="l00072"></a>00072 <span class="keyword">const</span> QColor& fgColour()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFgColour; }
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> defaultFont()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDefaultFont; }
<a name="l00074"></a>00074 <span class="keyword">const</span> QFont& font() <span class="keyword">const</span>;
<a name="l00075"></a>00075 <span class="keywordtype">int</span> lateCancel()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLateCancel; }
<a name="l00076"></a>00076 <span class="keywordtype">bool</span> autoClose()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mAutoClose; }
<a name="l00077"></a>00077 <span class="keywordtype">bool</span> commandScript()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCommandScript; }
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> confirmAck()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mConfirmAck; }
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> repeatAtLogin()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRepeatAtLogin; }
<a name="l00080"></a>00080 <span class="keywordtype">int</span> repeatCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRepeatCount; }
<a name="l00081"></a>00081 <span class="keywordtype">int</span> repeatInterval()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRepeatInterval; }
<a name="l00082"></a>00082 <span class="keywordtype">bool</span> displaying()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDisplaying; }
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> beep()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mBeep; }
<a name="l00084"></a>00084 <span class="keywordtype">bool</span> speak()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_MESSAGE) && mSpeak; }
<a name="l00085"></a>00085 <span class="keywordtype">int</span> flags() <span class="keyword">const</span>;
<a name="l00086"></a>00086 <span class="preprocessor">#ifdef NDEBUG</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span> <span class="keywordtype">void</span> dumpDebug()<span class="keyword"> const </span>{ }
<a name="l00088"></a>00088 <span class="preprocessor">#else</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span> <span class="keywordtype">void</span> dumpDebug() <span class="keyword">const</span>;
<a name="l00090"></a>00090 <span class="preprocessor">#endif</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span>
<a name="l00092"></a>00092 <span class="keyword">protected</span>:
<a name="l00093"></a>00093 <span class="keyword">enum</span> Type { T_MESSAGE, T_FILE, T_COMMAND, T_AUDIO, T_EMAIL };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 KAAlarmEventBase() : mRepeatCount(0), mLateCancel(0), mAutoClose(false), mBeep(false), mRepeatAtLogin(false),
<a name="l00096"></a>00096 mDisplaying(false), mEmailBcc(false), mConfirmAck(false) { }
<a name="l00097"></a>00097 KAAlarmEventBase(<span class="keyword">const</span> KAAlarmEventBase& rhs) { copy(rhs); }
<a name="l00098"></a>00098 KAAlarmEventBase& operator=(<span class="keyword">const</span> KAAlarmEventBase& rhs) { copy(rhs); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00099"></a>00099 <span class="keywordtype">void</span> copy(<span class="keyword">const</span> KAAlarmEventBase&);
<a name="l00100"></a>00100 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keywordtype">int</span> flags);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 QString mEventID; <span class="comment">// UID: KCal::Event unique ID</span>
<a name="l00103"></a>00103 QString mText; <span class="comment">// message text, file URL, command, email body [or audio file for KAAlarm]</span>
<a name="l00104"></a>00104 DateTime mNextMainDateTime; <span class="comment">// next time to display the alarm, excluding repetitions</span>
<a name="l00105"></a>00105 QColor mBgColour; <span class="comment">// background colour of alarm message</span>
<a name="l00106"></a>00106 QColor mFgColour; <span class="comment">// foreground colour of alarm message, or invalid for default</span>
<a name="l00107"></a>00107 QFont mFont; <span class="comment">// font of alarm message (ignored if mDefaultFont true)</span>
<a name="l00108"></a>00108 uint mEmailFromIdentity;<span class="comment">// KMail identity for email 'From' field, or empty</span>
<a name="l00109"></a>00109 EmailAddressList mEmailAddresses; <span class="comment">// ATTENDEE: addresses to send email to</span>
<a name="l00110"></a>00110 QString mEmailSubject; <span class="comment">// SUMMARY: subject line of email</span>
<a name="l00111"></a>00111 QStringList mEmailAttachments; <span class="comment">// ATTACH: email attachment file names</span>
<a name="l00112"></a>00112 <span class="keywordtype">float</span> mSoundVolume; <span class="comment">// volume for sound file, or < 0 for unspecified</span>
<a name="l00113"></a>00113 <span class="keywordtype">float</span> mFadeVolume; <span class="comment">// initial volume for sound file, or < 0 for no fade</span>
<a name="l00114"></a>00114 <span class="keywordtype">int</span> mFadeSeconds; <span class="comment">// fade time for sound file, or 0 if none</span>
<a name="l00115"></a>00115 Type mActionType; <span class="comment">// alarm action type</span>
<a name="l00116"></a>00116 <span class="keywordtype">int</span> mRepeatCount; <span class="comment">// sub-repetition count (excluding the first time)</span>
<a name="l00117"></a>00117 <span class="keywordtype">int</span> mRepeatInterval; <span class="comment">// sub-repetition interval (minutes)</span>
<a name="l00118"></a>00118 <span class="keywordtype">int</span> mNextRepeat; <span class="comment">// repetition count of next due sub-repetition</span>
<a name="l00119"></a>00119 <span class="keywordtype">int</span> mLateCancel; <span class="comment">// how many minutes late will cancel the alarm, or 0 for no cancellation</span>
<a name="l00120"></a>00120 <span class="keywordtype">bool</span> mAutoClose; <span class="comment">// whether to close the alarm window after the late-cancel period</span>
<a name="l00121"></a>00121 <span class="keywordtype">bool</span> mCommandScript; <span class="comment">// the command text is a script, not a shell command line</span>
<a name="l00122"></a>00122 <span class="keywordtype">bool</span> mBeep; <span class="comment">// whether to beep when the alarm is displayed</span>
<a name="l00123"></a>00123 <span class="keywordtype">bool</span> mSpeak; <span class="comment">// whether to speak the message when the alarm is displayed</span>
<a name="l00124"></a>00124 <span class="keywordtype">bool</span> mRepeatSound; <span class="comment">// whether to repeat the sound file while the alarm is displayed</span>
<a name="l00125"></a>00125 <span class="keywordtype">bool</span> mRepeatAtLogin; <span class="comment">// whether to repeat the alarm at every login</span>
<a name="l00126"></a>00126 <span class="keywordtype">bool</span> mDisplaying; <span class="comment">// whether the alarm is currently being displayed</span>
<a name="l00127"></a>00127 <span class="keywordtype">bool</span> mEmailBcc; <span class="comment">// blind copy the email to the user</span>
<a name="l00128"></a>00128 <span class="keywordtype">bool</span> mConfirmAck; <span class="comment">// alarm acknowledgement requires confirmation by user</span>
<a name="l00129"></a>00129 <span class="keywordtype">bool</span> mDefaultFont; <span class="comment">// use default message font, not mFont</span>
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">friend</span> <span class="keyword">class </span>AlarmData;
<a name="l00132"></a>00132 };
<a name="l00133"></a>00133
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="comment">// KAAlarm corresponds to a single KCal::Alarm instance.</span>
<a name="l00136"></a>00136 <span class="comment">// A KAEvent may contain multiple KAAlarm's.</span>
<a name="l00137"></a>00137 <span class="keyword">class </span>KAAlarm : <span class="keyword">public</span> KAAlarmEventBase
<a name="l00138"></a>00138 {
<a name="l00139"></a>00139 <span class="keyword">public</span>:
<a name="l00140"></a>00140 <span class="comment">// Define the basic KAAlaem action types</span>
<a name="l00141"></a>00141 <span class="keyword">enum</span> Action
<a name="l00142"></a>00142 {
<a name="l00143"></a>00143 MESSAGE = T_MESSAGE, <span class="comment">// KCal::Alarm::Display type: display a text message</span>
<a name="l00144"></a>00144 FILE = T_FILE, <span class="comment">// KCal::Alarm::Display type: display a file (URL given by the alarm text)</span>
<a name="l00145"></a>00145 COMMAND = T_COMMAND, <span class="comment">// KCal::Alarm::Procedure type: execute a shell command</span>
<a name="l00146"></a>00146 EMAIL = T_EMAIL, <span class="comment">// KCal::Alarm::Email type: send an email</span>
<a name="l00147"></a>00147 AUDIO = T_AUDIO <span class="comment">// KCal::Alarm::Audio type: play a sound file</span>
<a name="l00148"></a>00148 };
<a name="l00149"></a>00149 <span class="comment">// Define the KAAlarm types.</span>
<a name="l00150"></a>00150 <span class="comment">// KAAlarm's of different types may be contained in a KAEvent,</span>
<a name="l00151"></a>00151 <span class="comment">// each defining a different component of the overall alarm.</span>
<a name="l00152"></a>00152 <span class="keyword">enum</span> Type
<a name="l00153"></a>00153 {
<a name="l00154"></a>00154 INVALID_ALARM = 0, <span class="comment">// not an alarm</span>
<a name="l00155"></a>00155 MAIN_ALARM = 1, <span class="comment">// THE real alarm. Must be the first in the enumeration.</span>
<a name="l00156"></a>00156 <span class="comment">// The following values may be used in combination as a bitmask 0x0E</span>
<a name="l00157"></a>00157 REMINDER_ALARM = 0x02, <span class="comment">// reminder in advance of main alarm</span>
<a name="l00158"></a>00158 DEFERRED_ALARM = 0x04, <span class="comment">// deferred alarm</span>
<a name="l00159"></a>00159 DEFERRED_REMINDER_ALARM = REMINDER_ALARM | DEFERRED_ALARM, <span class="comment">// deferred early warning</span>
<a name="l00160"></a>00160 <span class="comment">// The following values must be greater than the preceding ones, to</span>
<a name="l00161"></a>00161 <span class="comment">// ensure that in ordered processing they are processed afterwards.</span>
<a name="l00162"></a>00162 AT_LOGIN_ALARM = 0x10, <span class="comment">// additional repeat-at-login trigger</span>
<a name="l00163"></a>00163 DISPLAYING_ALARM = 0x20, <span class="comment">// copy of the alarm currently being displayed</span>
<a name="l00164"></a>00164 <span class="comment">// The following values are for internal KAEvent use only</span>
<a name="l00165"></a>00165 AUDIO_ALARM = 0x30, <span class="comment">// sound to play when displaying the alarm</span>
<a name="l00166"></a>00166 PRE_ACTION_ALARM = 0x40, <span class="comment">// command to execute before displaying the alarm</span>
<a name="l00167"></a>00167 POST_ACTION_ALARM = 0x50 <span class="comment">// command to execute after the alarm window is closed</span>
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169 <span class="keyword">enum</span> SubType
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171 INVALID__ALARM = INVALID_ALARM,
<a name="l00172"></a>00172 MAIN__ALARM = MAIN_ALARM,
<a name="l00173"></a>00173 <span class="comment">// The following values may be used in combination as a bitmask 0x0E</span>
<a name="l00174"></a>00174 REMINDER__ALARM = REMINDER_ALARM,
<a name="l00175"></a>00175 TIMED_DEFERRAL_FLAG = 0x08, <span class="comment">// deferral has a time; if clear, it is date-only</span>
<a name="l00176"></a>00176 DEFERRED_DATE__ALARM = DEFERRED_ALARM, <span class="comment">// deferred alarm - date-only</span>
<a name="l00177"></a>00177 DEFERRED_TIME__ALARM = DEFERRED_ALARM | TIMED_DEFERRAL_FLAG,
<a name="l00178"></a>00178 DEFERRED_REMINDER_DATE__ALARM = REMINDER_ALARM | DEFERRED_ALARM, <span class="comment">// deferred early warning (date-only)</span>
<a name="l00179"></a>00179 DEFERRED_REMINDER_TIME__ALARM = REMINDER_ALARM | DEFERRED_ALARM | TIMED_DEFERRAL_FLAG, <span class="comment">// deferred early warning (date/time)</span>
<a name="l00180"></a>00180 <span class="comment">// The following values must be greater than the preceding ones, to</span>
<a name="l00181"></a>00181 <span class="comment">// ensure that in ordered processing they are processed afterwards.</span>
<a name="l00182"></a>00182 AT_LOGIN__ALARM = AT_LOGIN_ALARM,
<a name="l00183"></a>00183 DISPLAYING__ALARM = DISPLAYING_ALARM,
<a name="l00184"></a>00184 <span class="comment">// The following values are for internal KAEvent use only</span>
<a name="l00185"></a>00185 AUDIO__ALARM = AUDIO_ALARM,
<a name="l00186"></a>00186 PRE_ACTION__ALARM = PRE_ACTION_ALARM,
<a name="l00187"></a>00187 POST_ACTION__ALARM = POST_ACTION_ALARM
<a name="l00188"></a>00188 };
<a name="l00189"></a>00189
<a name="l00190"></a>00190 KAAlarm() : mType(INVALID__ALARM), mDeferred(false) { }
<a name="l00191"></a>00191 KAAlarm(<span class="keyword">const</span> KAAlarm&);
<a name="l00192"></a>00192 ~KAAlarm() { }
<a name="l00193"></a>00193 Action action()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (Action)mActionType; }
<a name="l00194"></a>00194 <span class="keywordtype">bool</span> valid()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mType != INVALID__ALARM; }
<a name="l00195"></a>00195 Type type()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>Type<span class="keyword">></span>(mType & ~TIMED_DEFERRAL_FLAG); }
<a name="l00196"></a>00196 SubType subType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mType; }
<a name="l00197"></a>00197 <span class="keyword">const</span> QString& eventID()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEventID; }
<a name="l00198"></a>00198 DateTime dateTime(<span class="keywordtype">bool</span> withRepeats = <span class="keyword">false</span>)<span class="keyword"> const</span>
<a name="l00199"></a>00199 <span class="keyword"> </span>{ <span class="keywordflow">return</span> (withRepeats && mNextRepeat && mRepeatInterval)
<a name="l00200"></a>00200 ? mNextMainDateTime.addSecs(mNextRepeat * mRepeatInterval * 60) : mNextMainDateTime; }
<a name="l00201"></a>00201 QDate date()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mNextMainDateTime.date(); }
<a name="l00202"></a>00202 QTime time()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mNextMainDateTime.time(); }
<a name="l00203"></a>00203 QString audioFile()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_AUDIO) && !mBeep ? mText : QString::null; }
<a name="l00204"></a>00204 <span class="keywordtype">float</span> soundVolume()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_AUDIO) && !mBeep && !mText.isEmpty() ? mSoundVolume : -1; }
<a name="l00205"></a>00205 <span class="keywordtype">float</span> fadeVolume()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_AUDIO) && mSoundVolume >= 0 && mFadeSeconds && !mBeep && !mText.isEmpty() ? mFadeVolume : -1; }
<a name="l00206"></a>00206 <span class="keywordtype">int</span> fadeSeconds()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_AUDIO) && mSoundVolume >= 0 && mFadeVolume >= 0 && !mBeep && !mText.isEmpty() ? mFadeSeconds : 0; }
<a name="l00207"></a>00207 <span class="keywordtype">bool</span> repeatSound()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mActionType == T_AUDIO) && mRepeatSound && !mBeep && !mText.isEmpty(); }
<a name="l00208"></a>00208 <span class="keywordtype">bool</span> reminder()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mType == REMINDER__ALARM; }
<a name="l00209"></a>00209 <span class="keywordtype">bool</span> deferred()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDeferred; }
<a name="l00210"></a>00210 <span class="keywordtype">void</span> setTime(<span class="keyword">const</span> DateTime& dt) { mNextMainDateTime = dt; }
<a name="l00211"></a>00211 <span class="keywordtype">void</span> setTime(<span class="keyword">const</span> QDateTime& dt) { mNextMainDateTime = dt; }
<a name="l00212"></a>00212 <span class="keywordtype">int</span> flags() <span class="keyword">const</span>;
<a name="l00213"></a>00213 <span class="preprocessor">#ifdef NDEBUG</span>
<a name="l00214"></a>00214 <span class="preprocessor"></span> <span class="keywordtype">void</span> dumpDebug()<span class="keyword"> const </span>{ }
<a name="l00215"></a>00215 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* debugType(Type) { <span class="keywordflow">return</span> <span class="stringliteral">""</span>; }
<a name="l00216"></a>00216 <span class="preprocessor">#else</span>
<a name="l00217"></a>00217 <span class="preprocessor"></span> <span class="keywordtype">void</span> dumpDebug() <span class="keyword">const</span>;
<a name="l00218"></a>00218 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* debugType(Type);
<a name="l00219"></a>00219 <span class="preprocessor">#endif</span>
<a name="l00220"></a>00220 <span class="preprocessor"></span>
<a name="l00221"></a>00221 <span class="keyword">private</span>:
<a name="l00222"></a>00222 SubType mType; <span class="comment">// alarm type</span>
<a name="l00223"></a>00223 <span class="keywordtype">bool</span> mRecurs; <span class="comment">// there is a recurrence rule for the alarm</span>
<a name="l00224"></a>00224 <span class="keywordtype">bool</span> mDeferred; <span class="comment">// whether the alarm is an extra deferred/deferred-reminder alarm</span>
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>;
<a name="l00227"></a>00227 };
<a name="l00228"></a>00228
<a name="l00229"></a>00229
<a name="l00231"></a><a class="code" href="classKAEvent.html">00231</a> <span class="keyword">class </span><a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a> : <span class="keyword">public</span> KAAlarmEventBase
<a name="l00232"></a>00232 {
<a name="l00233"></a>00233 <span class="keyword">public</span>:
<a name="l00234"></a>00234 <span class="keyword">enum</span> <span class="comment">// flags for use in DCOP calls, etc.</span>
<a name="l00235"></a>00235 {
<a name="l00236"></a>00236 <span class="preprocessor">#ifdef OLD_DCOP</span>
<a name="l00237"></a>00237 <span class="preprocessor"></span> <span class="comment">// *** DON'T CHANGE THESE VALUES ***</span>
<a name="l00238"></a>00238 <span class="comment">// because they are part of KAlarm's external DCOP interface.</span>
<a name="l00239"></a>00239 <span class="comment">// (But it's alright to add new values.)</span>
<a name="l00240"></a>00240 LATE_CANCEL = 0x01, <span class="comment">// cancel alarm if not triggered within a minute of its scheduled time</span>
<a name="l00241"></a>00241 <span class="preprocessor">#endif</span>
<a name="l00242"></a>00242 <span class="preprocessor"></span> BEEP = 0x02, <span class="comment">// sound audible beep when alarm is displayed</span>
<a name="l00243"></a>00243 REPEAT_AT_LOGIN = 0x04, <span class="comment">// repeat alarm at every login</span>
<a name="l00244"></a>00244 ANY_TIME = 0x08, <span class="comment">// only a date is specified for the alarm, not a time</span>
<a name="l00245"></a>00245 CONFIRM_ACK = 0x10, <span class="comment">// closing the alarm message window requires confirmation prompt</span>
<a name="l00246"></a>00246 EMAIL_BCC = 0x20, <span class="comment">// blind copy the email to the user</span>
<a name="l00247"></a>00247 DEFAULT_FONT = 0x40, <span class="comment">// use default alarm message font</span>
<a name="l00248"></a>00248 REPEAT_SOUND = 0x80, <span class="comment">// repeat sound file while alarm is displayed</span>
<a name="l00249"></a>00249 DISABLED = 0x100, <span class="comment">// alarm is currently disabled</span>
<a name="l00250"></a>00250 AUTO_CLOSE = 0x200, <span class="comment">// auto-close alarm window after late-cancel period</span>
<a name="l00251"></a>00251 SCRIPT = 0x400, <span class="comment">// command is a script, not a shell command line</span>
<a name="l00252"></a>00252 EXEC_IN_XTERM = 0x800, <span class="comment">// execute command in terminal window</span>
<a name="l00253"></a>00253 SPEAK = 0x1000, <span class="comment">// speak the message when the alarm is displayed</span>
<a name="l00254"></a>00254 COPY_KORGANIZER = 0x2000, <span class="comment">// KOrganizer should hold a copy of the event</span>
<a name="l00255"></a>00255 <span class="preprocessor">#ifdef OLD_DCOP</span>
<a name="l00256"></a>00256 <span class="preprocessor"></span> <span class="comment">// The following are read-only internal values, and may be changed</span>
<a name="l00257"></a>00257 <span class="preprocessor">#else</span>
<a name="l00258"></a>00258 <span class="preprocessor"></span> <span class="comment">// The following are read-only internal values</span>
<a name="l00259"></a>00259 <span class="preprocessor">#endif</span>
<a name="l00260"></a>00260 <span class="preprocessor"></span> REMINDER = 0x10000,
<a name="l00261"></a>00261 DEFERRAL = 0x20000,
<a name="l00262"></a>00262 TIMED_FLAG = 0x40000,
<a name="l00263"></a>00263 DATE_DEFERRAL = DEFERRAL,
<a name="l00264"></a>00264 TIME_DEFERRAL = DEFERRAL | TIMED_FLAG,
<a name="l00265"></a>00265 DISPLAYING_ = 0x80000,
<a name="l00266"></a>00266 READ_ONLY_FLAGS = 0xF0000 <span class="comment">// mask for all read-only internal values</span>
<a name="l00267"></a>00267 };
<a name="l00269"></a><a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c">00269</a> <span class="keyword">enum</span> <a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">Status</a>
<a name="l00270"></a>00270 {
<a name="l00271"></a>00271 ACTIVE, <span class="comment">// the event is currently active</span>
<a name="l00272"></a>00272 EXPIRED, <span class="comment">// the event has expired</span>
<a name="l00273"></a>00273 DISPLAYING, <span class="comment">// the event is currently being displayed</span>
<a name="l00274"></a>00274 TEMPLATE, <span class="comment">// the event is an alarm template</span>
<a name="l00275"></a>00275 KORGANIZER <span class="comment">// the event is a copy of a KAlarm event, held by KOrganizer</span>
<a name="l00276"></a>00276 };
<a name="l00277"></a>00277 <span class="keyword">enum</span> Action
<a name="l00278"></a>00278 {
<a name="l00279"></a>00279 MESSAGE = T_MESSAGE,
<a name="l00280"></a>00280 FILE = T_FILE,
<a name="l00281"></a>00281 COMMAND = T_COMMAND,
<a name="l00282"></a>00282 EMAIL = T_EMAIL
<a name="l00283"></a>00283 };
<a name="l00284"></a>00284 <span class="keyword">enum</span> OccurType <span class="comment">// what type of occurrence is due</span>
<a name="l00285"></a>00285 {
<a name="l00286"></a>00286 NO_OCCURRENCE = 0, <span class="comment">// no occurrence is due</span>
<a name="l00287"></a>00287 FIRST_OR_ONLY_OCCURRENCE = 0x01, <span class="comment">// the first occurrence (takes precedence over LAST_RECURRENCE)</span>
<a name="l00288"></a>00288 RECURRENCE_DATE = 0x02, <span class="comment">// a recurrence with only a date, not a time</span>
<a name="l00289"></a>00289 RECURRENCE_DATE_TIME = 0x03, <span class="comment">// a recurrence with a date and time</span>
<a name="l00290"></a>00290 LAST_RECURRENCE = 0x04, <span class="comment">// the last recurrence</span>
<a name="l00291"></a>00291 OCCURRENCE_REPEAT = 0x10, <span class="comment">// (bitmask for a repetition of an occurrence)</span>
<a name="l00292"></a>00292 FIRST_OR_ONLY_OCCURRENCE_REPEAT = OCCURRENCE_REPEAT | FIRST_OR_ONLY_OCCURRENCE, <span class="comment">// a repetition of the first occurrence</span>
<a name="l00293"></a>00293 RECURRENCE_DATE_REPEAT = OCCURRENCE_REPEAT | RECURRENCE_DATE, <span class="comment">// a repetition of a date-only recurrence</span>
<a name="l00294"></a>00294 RECURRENCE_DATE_TIME_REPEAT = OCCURRENCE_REPEAT | RECURRENCE_DATE_TIME, <span class="comment">// a repetition of a date/time recurrence</span>
<a name="l00295"></a>00295 LAST_RECURRENCE_REPEAT = OCCURRENCE_REPEAT | LAST_RECURRENCE <span class="comment">// a repetition of the last recurrence</span>
<a name="l00296"></a>00296 };
<a name="l00297"></a>00297 <span class="keyword">enum</span> OccurOption <span class="comment">// options for nextOccurrence()</span>
<a name="l00298"></a>00298 {
<a name="l00299"></a>00299 IGNORE_REPETITION, <span class="comment">// check for recurrences only, ignore repetitions</span>
<a name="l00300"></a>00300 RETURN_REPETITION, <span class="comment">// return repetition if it's the next occurrence</span>
<a name="l00301"></a>00301 ALLOW_FOR_REPETITION <span class="comment">// check for repetition being the next occurrence, but return recurrence</span>
<a name="l00302"></a>00302 };
<a name="l00303"></a>00303 <span class="keyword">enum</span> DeferLimitType <span class="comment">// what type of occurrence currently limits a deferral</span>
<a name="l00304"></a>00304 {
<a name="l00305"></a>00305 LIMIT_NONE,
<a name="l00306"></a>00306 LIMIT_MAIN,
<a name="l00307"></a>00307 LIMIT_RECURRENCE,
<a name="l00308"></a>00308 LIMIT_REPETITION,
<a name="l00309"></a>00309 LIMIT_REMINDER
<a name="l00310"></a>00310 };
<a name="l00311"></a>00311
<a name="l00312"></a>00312 <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>() : mRevision(0), mRecurrence(0), mAlarmCount(0) { }
<a name="l00313"></a>00313 <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>(<span class="keyword">const</span> QDateTime& dt, <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont& f, Action action, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags)
<a name="l00314"></a>00314 : mRecurrence(0) { <span class="keyword">set</span>(dt, message, bg, fg, f, action, lateCancel, flags); }
<a name="l00315"></a>00315 <span class="keyword">explicit</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>(<span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>& e) : mRecurrence(0) { <span class="keyword">set</span>(e); }
<a name="l00316"></a>00316 <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>(<span class="keyword">const</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>& e) : KAAlarmEventBase(e), mRecurrence(0) { copy(e); }
<a name="l00317"></a>00317 ~<a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>() { <span class="keyword">delete</span> mRecurrence; }
<a name="l00318"></a>00318 <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>& operator=(<span class="keyword">const</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>& e) { <span class="keywordflow">if</span> (&e != <span class="keyword">this</span>) copy(e); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00319"></a>00319 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>&);
<a name="l00320"></a>00320 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> QDate& d, <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont& f, Action action, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags)
<a name="l00321"></a>00321 { <span class="keyword">set</span>(d, message, bg, fg, f, action, lateCancel, flags | ANY_TIME); }
<a name="l00322"></a>00322 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> QDateTime&, <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont&, Action, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags);
<a name="l00323"></a>00323 <span class="keywordtype">void</span> setMessage(<span class="keyword">const</span> QDate& d, <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont& f, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags)
<a name="l00324"></a>00324 { <span class="keyword">set</span>(d, message, bg, fg, f, MESSAGE, lateCancel, flags | ANY_TIME); }
<a name="l00325"></a>00325 <span class="keywordtype">void</span> setMessage(<span class="keyword">const</span> QDateTime& dt, <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont& f, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags)
<a name="l00326"></a>00326 { <span class="keyword">set</span>(dt, message, bg, fg, f, MESSAGE, lateCancel, flags); }
<a name="l00327"></a>00327 <span class="keywordtype">void</span> setFileName(<span class="keyword">const</span> QDate& d, <span class="keyword">const</span> QString& filename, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont& f, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags)
<a name="l00328"></a>00328 { <span class="keyword">set</span>(d, filename, bg, fg, f, FILE, lateCancel, flags | ANY_TIME); }
<a name="l00329"></a>00329 <span class="keywordtype">void</span> setFileName(<span class="keyword">const</span> QDateTime& dt, <span class="keyword">const</span> QString& filename, <span class="keyword">const</span> QColor& bg, <span class="keyword">const</span> QColor& fg, <span class="keyword">const</span> QFont& f, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags)
<a name="l00330"></a>00330 { <span class="keyword">set</span>(dt, filename, bg, fg, f, FILE, lateCancel, flags); }
<a name="l00331"></a>00331 <span class="keywordtype">void</span> setCommand(<span class="keyword">const</span> QDate&, <span class="keyword">const</span> QString& command, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags, <span class="keyword">const</span> QString& logfile = QString::null);
<a name="l00332"></a>00332 <span class="keywordtype">void</span> setCommand(<span class="keyword">const</span> QDateTime&, <span class="keyword">const</span> QString& command, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags, <span class="keyword">const</span> QString& logfile = QString::null);
<a name="l00333"></a>00333 <span class="keywordtype">void</span> setEmail(<span class="keyword">const</span> QDate&, uint from, <span class="keyword">const</span> EmailAddressList&, <span class="keyword">const</span> QString& subject,
<a name="l00334"></a>00334 <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QStringList& attachments, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags);
<a name="l00335"></a>00335 <span class="keywordtype">void</span> setEmail(<span class="keyword">const</span> QDateTime&, uint from, <span class="keyword">const</span> EmailAddressList&, <span class="keyword">const</span> QString& subject,
<a name="l00336"></a>00336 <span class="keyword">const</span> QString& message, <span class="keyword">const</span> QStringList& attachments, <span class="keywordtype">int</span> lateCancel, <span class="keywordtype">int</span> flags);
<a name="l00337"></a>00337 <span class="keywordtype">void</span> setEmail(uint from, <span class="keyword">const</span> EmailAddressList&, <span class="keyword">const</span> QString& subject, <span class="keyword">const</span> QStringList& attachments);
<a name="l00338"></a>00338 <span class="keywordtype">void</span> setAudioFile(<span class="keyword">const</span> QString& filename, <span class="keywordtype">float</span> volume, <span class="keywordtype">float</span> fadeVolume, <span class="keywordtype">int</span> fadeSeconds);
<a name="l00339"></a>00339 <span class="keywordtype">void</span> setTemplate(<span class="keyword">const</span> QString& name, <span class="keywordtype">int</span> afterTime = -1) { mTemplateName = name; mTemplateAfterTime = afterTime; mUpdated = <span class="keyword">true</span>; }
<a name="l00340"></a>00340 <span class="keywordtype">void</span> setActions(<span class="keyword">const</span> QString& pre, <span class="keyword">const</span> QString& post) { mPreAction = pre; mPostAction = post; mUpdated = <span class="keyword">true</span>; }
<a name="l00341"></a>00341 OccurType setNextOccurrence(<span class="keyword">const</span> QDateTime& preDateTime);
<a name="l00342"></a>00342 <span class="keywordtype">void</span> setFirstRecurrence();
<a name="l00343"></a>00343 <span class="keywordtype">void</span> setEventID(<span class="keyword">const</span> QString& <span class="keywordtype">id</span>) { mEventID = id; mUpdated = <span class="keyword">true</span>; }
<a name="l00344"></a>00344 <span class="keywordtype">void</span> setDate(<span class="keyword">const</span> QDate& d) { mNextMainDateTime.set(d); mUpdated = <span class="keyword">true</span>; }
<a name="l00345"></a>00345 <span class="keywordtype">void</span> setTime(<span class="keyword">const</span> QDateTime& dt) { mNextMainDateTime.set(dt); mUpdated = <span class="keyword">true</span>; }
<a name="l00346"></a>00346 <span class="keywordtype">void</span> setSaveDateTime(<span class="keyword">const</span> QDateTime& dt) { mSaveDateTime = dt; mUpdated = <span class="keyword">true</span>; }
<a name="l00347"></a>00347 <span class="keywordtype">void</span> setLateCancel(<span class="keywordtype">int</span> lc) { mLateCancel = lc; mUpdated = <span class="keyword">true</span>; }
<a name="l00348"></a>00348 <span class="keywordtype">void</span> setAutoClose(<span class="keywordtype">bool</span> ac) { mAutoClose = ac; mUpdated = <span class="keyword">true</span>; }
<a name="l00349"></a>00349 <span class="keywordtype">void</span> setRepeatAtLogin(<span class="keywordtype">bool</span> rl) { mRepeatAtLogin = rl; mUpdated = <span class="keyword">true</span>; }
<a name="l00350"></a>00350 <span class="keywordtype">void</span> setUid(<a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">Status</a> s) { mEventID = uid(mEventID, s); mUpdated = <span class="keyword">true</span>; }
<a name="l00351"></a>00351 <span class="keywordtype">void</span> setKMailSerialNumber(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n) { mKMailSerialNumber = n; }
<a name="l00352"></a>00352 <span class="keywordtype">void</span> setLogFile(<span class="keyword">const</span> QString& logfile);
<a name="l00353"></a>00353 <span class="keywordtype">void</span> setReminder(<span class="keywordtype">int</span> minutes, <span class="keywordtype">bool</span> onceOnly);
<a name="l00354"></a>00354 <span class="keywordtype">bool</span> defer(<span class="keyword">const</span> DateTime&, <span class="keywordtype">bool</span> reminder, <span class="keywordtype">bool</span> adjustRecurrence = <span class="keyword">false</span>);
<a name="l00355"></a>00355 <span class="keywordtype">void</span> cancelDefer();
<a name="l00356"></a>00356 <span class="keywordtype">void</span> cancelCancelledDeferral();
<a name="l00357"></a>00357 <span class="keywordtype">void</span> setDeferDefaultMinutes(<span class="keywordtype">int</span> minutes) { mDeferDefaultMinutes = minutes; mUpdated = <span class="keyword">true</span>; }
<a name="l00358"></a>00358 <span class="keywordtype">bool</span> setDisplaying(<span class="keyword">const</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>&, KAAlarm::Type, <span class="keyword">const</span> QDateTime&);
<a name="l00359"></a>00359 <span class="keywordtype">void</span> reinstateFromDisplaying(<span class="keyword">const</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>& dispEvent);
<a name="l00360"></a>00360 <span class="keywordtype">void</span> setArchive() { mArchive = <span class="keyword">true</span>; mUpdated = <span class="keyword">true</span>; }
<a name="l00361"></a>00361 <span class="keywordtype">void</span> setEnabled(<span class="keywordtype">bool</span> enable) { mEnabled = enable; mUpdated = <span class="keyword">true</span>; }
<a name="l00362"></a>00362 <span class="keywordtype">void</span> setUpdated() { mUpdated = <span class="keyword">true</span>; }
<a name="l00363"></a>00363 <span class="keywordtype">void</span> clearUpdated()<span class="keyword"> const </span>{ mUpdated = <span class="keyword">false</span>; }
<a name="l00364"></a>00364 <span class="keywordtype">void</span> removeExpiredAlarm(KAAlarm::Type);
<a name="l00365"></a>00365 <span class="keywordtype">void</span> incrementRevision() { ++mRevision; mUpdated = <span class="keyword">true</span>; }
<a name="l00366"></a>00366
<a name="l00367"></a>00367 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>* event() <span class="keyword">const</span>; <span class="comment">// convert to new Event</span>
<a name="l00368"></a>00368 <span class="keywordtype">bool</span> isTemplate()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !mTemplateName.isEmpty(); }
<a name="l00369"></a>00369 <span class="keyword">const</span> QString& templateName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mTemplateName; }
<a name="l00370"></a>00370 <span class="keywordtype">bool</span> usingDefaultTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mTemplateAfterTime == 0; }
<a name="l00371"></a>00371 <span class="keywordtype">int</span> templateAfterTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mTemplateAfterTime; }
<a name="l00372"></a>00372 KAAlarm alarm(KAAlarm::Type) <span class="keyword">const</span>;
<a name="l00373"></a>00373 KAAlarm firstAlarm() <span class="keyword">const</span>;
<a name="l00374"></a>00374 KAAlarm nextAlarm(<span class="keyword">const</span> KAAlarm& al)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> nextAlarm(al.type()); }
<a name="l00375"></a>00375 KAAlarm nextAlarm(KAAlarm::Type) <span class="keyword">const</span>;
<a name="l00376"></a>00376 KAAlarm convertDisplayingAlarm() <span class="keyword">const</span>;
<a name="l00377"></a>00377 <span class="keywordtype">bool</span> updateKCalEvent(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>&, <span class="keywordtype">bool</span> checkUid = <span class="keyword">true</span>, <span class="keywordtype">bool</span> original = <span class="keyword">false</span>, <span class="keywordtype">bool</span> cancelCancelledDefer = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00378"></a>00378 Action action()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (Action)mActionType; }
<a name="l00379"></a>00379 <span class="keywordtype">bool</span> displayAction()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mActionType == T_MESSAGE || mActionType == T_FILE; }
<a name="l00380"></a>00380 <span class="keyword">const</span> QString& id()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEventID; }
<a name="l00381"></a>00381 <span class="keywordtype">bool</span> valid()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mAlarmCount && (mAlarmCount != 1 || !mRepeatAtLogin); }
<a name="l00382"></a>00382 <span class="keywordtype">int</span> alarmCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mAlarmCount; }
<a name="l00383"></a>00383 <span class="keyword">const</span> DateTime& startDateTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mStartDateTime; }
<a name="l00384"></a>00384 DateTime mainDateTime(<span class="keywordtype">bool</span> withRepeats = <span class="keyword">false</span>)<span class="keyword"> const</span>
<a name="l00385"></a>00385 <span class="keyword"> </span>{ <span class="keywordflow">return</span> (withRepeats && mNextRepeat && mRepeatInterval)
<a name="l00386"></a>00386 ? mNextMainDateTime.addSecs(mNextRepeat * mRepeatInterval * 60) : mNextMainDateTime; }
<a name="l00387"></a>00387 QDate mainDate()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mNextMainDateTime.date(); }
<a name="l00388"></a>00388 QTime mainTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mNextMainDateTime.time(); }
<a name="l00389"></a>00389 DateTime mainEndRepeatTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (mRepeatCount > 0 && mRepeatInterval)
<a name="l00390"></a>00390 ? mNextMainDateTime.addSecs(mRepeatCount * mRepeatInterval * 60) : mNextMainDateTime; }
<a name="l00391"></a>00391 <span class="keywordtype">int</span> reminder()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mReminderMinutes; }
<a name="l00392"></a>00392 <span class="keywordtype">bool</span> reminderOnceOnly()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mReminderOnceOnly; }
<a name="l00393"></a>00393 <span class="keywordtype">bool</span> reminderDeferral()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDeferral == REMINDER_DEFERRAL; }
<a name="l00394"></a>00394 <span class="keywordtype">int</span> reminderArchived()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mArchiveReminderMinutes; }
<a name="l00395"></a>00395 DateTime deferDateTime()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDeferralTime; }
<a name="l00396"></a>00396 DateTime deferralLimit(DeferLimitType* = 0) <span class="keyword">const</span>;
<a name="l00397"></a>00397 <span class="keywordtype">int</span> deferDefaultMinutes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDeferDefaultMinutes; }
<a name="l00398"></a>00398 DateTime displayDateTime() <span class="keyword">const</span>;
<a name="l00399"></a>00399 <span class="keyword">const</span> QString& messageFileOrCommand()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mText; }
<a name="l00400"></a>00400 QString logFile()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLogFile; }
<a name="l00401"></a>00401 <span class="keywordtype">bool</span> commandXterm()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCommandXterm; }
<a name="l00402"></a>00402 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> kmailSerialNumber()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mKMailSerialNumber; }
<a name="l00403"></a>00403 <span class="keywordtype">bool</span> copyToKOrganizer()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mCopyToKOrganizer; }
<a name="l00404"></a>00404 <span class="keyword">const</span> QString& audioFile()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mAudioFile; }
<a name="l00405"></a>00405 <span class="keywordtype">float</span> soundVolume()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !mAudioFile.isEmpty() ? mSoundVolume : -1; }
<a name="l00406"></a>00406 <span class="keywordtype">float</span> fadeVolume()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !mAudioFile.isEmpty() && mSoundVolume >= 0 && mFadeSeconds ? mFadeVolume : -1; }
<a name="l00407"></a>00407 <span class="keywordtype">int</span> fadeSeconds()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !mAudioFile.isEmpty() && mSoundVolume >= 0 && mFadeVolume >= 0 ? mFadeSeconds : 0; }
<a name="l00408"></a>00408 <span class="keywordtype">bool</span> repeatSound()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRepeatSound && !mAudioFile.isEmpty(); }
<a name="l00409"></a>00409 <span class="keyword">const</span> QString& preAction()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mPreAction; }
<a name="l00410"></a>00410 <span class="keyword">const</span> QString& postAction()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mPostAction; }
<a name="l00411"></a>00411 <span class="keywordtype">bool</span> recurs()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> checkRecur() != KARecurrence::NO_RECUR; }
<a name="l00412"></a>00412 KARecurrence::Type recurType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> checkRecur(); }
<a name="l00413"></a>00413 KARecurrence* recurrence()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRecurrence; }
<a name="l00414"></a>00414 <span class="keywordtype">int</span> recurInterval() <span class="keyword">const</span>; <span class="comment">// recurrence period in units of the recurrence period type (minutes, days, etc)</span>
<a name="l00415"></a>00415 <span class="keywordtype">int</span> longestRecurrenceInterval()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mRecurrence ? mRecurrence->longestInterval() : 0; }
<a name="l00416"></a>00416 QString recurrenceText(<span class="keywordtype">bool</span> brief = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00417"></a>00417 QString repetitionText(<span class="keywordtype">bool</span> brief = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00418"></a>00418 <span class="keywordtype">bool</span> occursAfter(<span class="keyword">const</span> QDateTime& preDateTime, <span class="keywordtype">bool</span> includeRepetitions) <span class="keyword">const</span>;
<a name="l00419"></a>00419 OccurType nextOccurrence(<span class="keyword">const</span> QDateTime& preDateTime, DateTime& result, OccurOption = IGNORE_REPETITION) <span class="keyword">const</span>;
<a name="l00420"></a>00420 OccurType previousOccurrence(<span class="keyword">const</span> QDateTime& afterDateTime, DateTime& result, <span class="keywordtype">bool</span> includeRepetitions = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00421"></a>00421 <span class="keywordtype">int</span> flags() <span class="keyword">const</span>;
<a name="l00422"></a>00422 <span class="keywordtype">bool</span> deferred()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDeferral > 0; }
<a name="l00423"></a>00423 <span class="keywordtype">bool</span> toBeArchived()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mArchive; }
<a name="l00424"></a>00424 <span class="keywordtype">bool</span> enabled()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mEnabled; }
<a name="l00425"></a>00425 <span class="keywordtype">bool</span> updated()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUpdated; }
<a name="l00426"></a>00426 <span class="keywordtype">bool</span> mainExpired()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMainExpired; }
<a name="l00427"></a>00427 <span class="keywordtype">bool</span> expired()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDisplaying && mMainExpired || uidStatus(mEventID) == EXPIRED; }
<a name="l00428"></a>00428 <a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">Status</a> uidStatus()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> uidStatus(mEventID); }
<a name="l00429"></a>00429 <span class="keyword">static</span> <a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">Status</a> uidStatus(<span class="keyword">const</span> QString& uid);
<a name="l00430"></a>00430 <span class="keyword">static</span> QString uid(<span class="keyword">const</span> QString& <span class="keywordtype">id</span>, <a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">Status</a>);
<a name="l00431"></a>00431 <span class="keyword">static</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a> findTemplateName(<a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>&, <span class="keyword">const</span> QString& name);
<a name="l00432"></a>00432
<a name="l00433"></a>00433 <span class="keyword">struct </span>MonthPos
<a name="l00434"></a>00434 {
<a name="l00435"></a>00435 MonthPos() : days(7) { }
<a name="l00436"></a>00436 <span class="keywordtype">int</span> weeknum; <span class="comment">// week in month, or < 0 to count from end of month</span>
<a name="l00437"></a>00437 QBitArray days; <span class="comment">// days in week</span>
<a name="l00438"></a>00438 };
<a name="l00439"></a>00439 <span class="keywordtype">bool</span> setRepetition(<span class="keywordtype">int</span> interval, <span class="keywordtype">int</span> count);
<a name="l00440"></a>00440 <span class="keywordtype">void</span> setNoRecur() { clearRecur(); }
<a name="l00441"></a>00441 <span class="keywordtype">void</span> setRecurrence(<span class="keyword">const</span> KARecurrence&);
<a name="l00442"></a>00442 <span class="keywordtype">bool</span> setRecurMinutely(<span class="keywordtype">int</span> freq, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDateTime& end);
<a name="l00443"></a>00443 <span class="keywordtype">bool</span> setRecurDaily(<span class="keywordtype">int</span> freq, <span class="keyword">const</span> QBitArray& days, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDate& end);
<a name="l00444"></a>00444 <span class="keywordtype">bool</span> setRecurWeekly(<span class="keywordtype">int</span> freq, <span class="keyword">const</span> QBitArray& days, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDate& end);
<a name="l00445"></a>00445 <span class="keywordtype">bool</span> setRecurMonthlyByDate(<span class="keywordtype">int</span> freq, <span class="keyword">const</span> QValueList<int>& days, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDate& end);
<a name="l00446"></a>00446 <span class="keywordtype">bool</span> setRecurMonthlyByPos(<span class="keywordtype">int</span> freq, <span class="keyword">const</span> QValueList<MonthPos>& pos, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDate& end);
<a name="l00447"></a>00447 <span class="keywordtype">bool</span> setRecurAnnualByDate(<span class="keywordtype">int</span> freq, <span class="keyword">const</span> QValueList<int>& months, <span class="keywordtype">int</span> day, KARecurrence::Feb29Type, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDate& end);
<a name="l00448"></a>00448 <span class="keywordtype">bool</span> setRecurAnnualByPos(<span class="keywordtype">int</span> freq, <span class="keyword">const</span> QValueList<MonthPos>& pos, <span class="keyword">const</span> QValueList<int>& months, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDate& end);
<a name="l00449"></a>00449 <span class="comment">// static QValueList<MonthPos> convRecurPos(const QValueList<KCal::RecurrenceRule::WDayPos>&);</span>
<a name="l00450"></a>00450 <span class="preprocessor">#ifdef NDEBUG</span>
<a name="l00451"></a>00451 <span class="preprocessor"></span> <span class="keywordtype">void</span> dumpDebug()<span class="keyword"> const </span>{ }
<a name="l00452"></a>00452 <span class="preprocessor">#else</span>
<a name="l00453"></a>00453 <span class="preprocessor"></span> <span class="keywordtype">void</span> dumpDebug() <span class="keyword">const</span>;
<a name="l00454"></a>00454 <span class="preprocessor">#endif</span>
<a name="l00455"></a>00455 <span class="preprocessor"></span> <span class="keyword">static</span> <span class="keywordtype">int</span> calVersion();
<a name="l00456"></a>00456 <span class="keyword">static</span> QString calVersionString();
<a name="l00457"></a>00457 <span class="keyword">static</span> <span class="keywordtype">bool</span> adjustStartOfDay(<span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1ListBase.html">KCal::Event::List</a>&);
<a name="l00458"></a>00458 <span class="keyword">static</span> <span class="keywordtype">void</span> convertKCalEvents(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Calendar.html">KCal::Calendar</a>&, <span class="keywordtype">int</span> version, <span class="keywordtype">bool</span> adjustSummerTime);
<a name="l00459"></a>00459 <span class="keyword">static</span> <span class="keywordtype">void</span> convertRepetitions(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1CalendarLocal.html">KCal::CalendarLocal</a>&);
<a name="l00460"></a>00460
<a name="l00461"></a>00461 <span class="keyword">private</span>:
<a name="l00462"></a>00462 <span class="keyword">enum</span> DeferType {
<a name="l00463"></a>00463 CANCEL_DEFERRAL = -1, <span class="comment">// there was a deferred alarm, but it has been cancelled</span>
<a name="l00464"></a>00464 NO_DEFERRAL = 0, <span class="comment">// there is no deferred alarm</span>
<a name="l00465"></a>00465 NORMAL_DEFERRAL, <span class="comment">// the main alarm, a recurrence or a repeat is deferred</span>
<a name="l00466"></a>00466 REMINDER_DEFERRAL <span class="comment">// a reminder alarm is deferred</span>
<a name="l00467"></a>00467 };
<a name="l00468"></a>00468
<a name="l00469"></a>00469 <span class="keywordtype">void</span> copy(<span class="keyword">const</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>&);
<a name="l00470"></a>00470 <span class="keywordtype">bool</span> setRecur(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1RecurrenceRule.html#d67adb9f784863d1ecdba2392a2f6bbf">KCal::RecurrenceRule::PeriodType</a>, <span class="keywordtype">int</span> freq, <span class="keywordtype">int</span> count, <span class="keyword">const</span> QDateTime& end, KARecurrence::Feb29Type = KARecurrence::FEB29_FEB29);
<a name="l00471"></a>00471 <span class="keywordtype">void</span> clearRecur();
<a name="l00472"></a>00472 KARecurrence::Type checkRecur() <span class="keyword">const</span>;
<a name="l00473"></a>00473 <span class="keywordtype">void</span> checkRepetition() <span class="keyword">const</span>;
<a name="l00474"></a>00474 OccurType nextRecurrence(<span class="keyword">const</span> QDateTime& preDateTime, DateTime& result) <span class="keyword">const</span>;
<a name="l00475"></a>00475 OccurType previousRecurrence(<span class="keyword">const</span> QDateTime& afterDateTime, DateTime& result) <span class="keyword">const</span>;
<a name="l00476"></a>00476 <span class="keyword">static</span> <span class="keywordtype">bool</span> convertRepetition(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>*);
<a name="l00477"></a>00477 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Alarm.html">KCal::Alarm</a>* initKCalAlarm(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>&, <span class="keyword">const</span> DateTime&, <span class="keyword">const</span> QStringList& types, KAAlarm::Type = KAAlarm::INVALID_ALARM) <span class="keyword">const</span>;
<a name="l00478"></a>00478 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Alarm.html">KCal::Alarm</a>* initKCalAlarm(<a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>&, <span class="keywordtype">int</span> startOffsetSecs, <span class="keyword">const</span> QStringList& types, KAAlarm::Type = KAAlarm::INVALID_ALARM) <span class="keyword">const</span>;
<a name="l00479"></a>00479 <span class="keyword">static</span> DateTime readDateTime(<span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>&, <span class="keywordtype">bool</span> dateOnly, DateTime& start);
<a name="l00480"></a>00480 <span class="keyword">static</span> <span class="keywordtype">void</span> readAlarms(<span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>&, <span class="keywordtype">void</span>* alarmMap);
<a name="l00481"></a>00481 <span class="keyword">static</span> <span class="keywordtype">void</span> readAlarm(<span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Alarm.html">KCal::Alarm</a>&, AlarmData&);
<a name="l00482"></a>00482 <span class="keyword">inline</span> <span class="keywordtype">void</span> set_deferral(DeferType);
<a name="l00483"></a>00483 <span class="keyword">inline</span> <span class="keywordtype">void</span> set_reminder(<span class="keywordtype">int</span> minutes);
<a name="l00484"></a>00484 <span class="keyword">inline</span> <span class="keywordtype">void</span> set_archiveReminder();
<a name="l00485"></a>00485
<a name="l00486"></a>00486 QString mTemplateName; <span class="comment">// alarm template's name, or null if normal event</span>
<a name="l00487"></a>00487 QString mAudioFile; <span class="comment">// ATTACH: audio file to play</span>
<a name="l00488"></a>00488 QString mPreAction; <span class="comment">// command to execute before alarm is displayed</span>
<a name="l00489"></a>00489 QString mPostAction; <span class="comment">// command to execute after alarm window is closed</span>
<a name="l00490"></a>00490 DateTime mStartDateTime; <span class="comment">// DTSTART and DTEND: start and end time for event</span>
<a name="l00491"></a>00491 QDateTime mSaveDateTime; <span class="comment">// CREATED: date event was created, or saved in expired calendar</span>
<a name="l00492"></a>00492 QDateTime mAtLoginDateTime; <span class="comment">// repeat-at-login time</span>
<a name="l00493"></a>00493 DateTime mDeferralTime; <span class="comment">// extra time to trigger alarm (if alarm or reminder deferred)</span>
<a name="l00494"></a>00494 DateTime mDisplayingTime; <span class="comment">// date/time shown in the alarm currently being displayed</span>
<a name="l00495"></a>00495 <span class="keywordtype">int</span> mDisplayingFlags; <span class="comment">// type of alarm which is currently being displayed</span>
<a name="l00496"></a>00496 <span class="keywordtype">int</span> mReminderMinutes; <span class="comment">// how long in advance reminder is to be, or 0 if none</span>
<a name="l00497"></a>00497 <span class="keywordtype">int</span> mArchiveReminderMinutes; <span class="comment">// original reminder period if now expired, or 0 if none</span>
<a name="l00498"></a>00498 <span class="keywordtype">int</span> mDeferDefaultMinutes; <span class="comment">// default number of minutes for deferral dialogue, or 0 to select time control</span>
<a name="l00499"></a>00499 <span class="keywordtype">int</span> mRevision; <span class="comment">// SEQUENCE: revision number of the original alarm, or 0</span>
<a name="l00500"></a>00500 KARecurrence* mRecurrence; <span class="comment">// RECUR: recurrence specification, or 0 if none</span>
<a name="l00501"></a>00501 <span class="keywordtype">int</span> mAlarmCount; <span class="comment">// number of alarms: count of !mMainExpired, mRepeatAtLogin, mDeferral, mReminderMinutes, mDisplaying</span>
<a name="l00502"></a>00502 DeferType mDeferral; <span class="comment">// whether the alarm is an extra deferred/deferred-reminder alarm</span>
<a name="l00503"></a>00503 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> mKMailSerialNumber;<span class="comment">// if email text, message's KMail serial number</span>
<a name="l00504"></a>00504 <span class="keywordtype">int</span> mTemplateAfterTime;<span class="comment">// time not specified: use n minutes after default time, or -1 (applies to templates only)</span>
<a name="l00505"></a>00505 QString mLogFile; <span class="comment">// alarm output is to be logged to this URL</span>
<a name="l00506"></a>00506 <span class="keywordtype">bool</span> mCommandXterm; <span class="comment">// command alarm is to be executed in a terminal window</span>
<a name="l00507"></a>00507 <span class="keywordtype">bool</span> mCopyToKOrganizer; <span class="comment">// KOrganizer should hold a copy of the event</span>
<a name="l00508"></a>00508 <span class="keywordtype">bool</span> mReminderOnceOnly; <span class="comment">// the reminder is output only for the first recurrence</span>
<a name="l00509"></a>00509 <span class="keywordtype">bool</span> mMainExpired; <span class="comment">// main alarm has expired (in which case a deferral alarm will exist)</span>
<a name="l00510"></a>00510 <span class="keywordtype">bool</span> mArchiveRepeatAtLogin; <span class="comment">// if now expired, original event was repeat-at-login</span>
<a name="l00511"></a>00511 <span class="keywordtype">bool</span> mArchive; <span class="comment">// event has triggered in the past, so archive it when closed</span>
<a name="l00512"></a>00512 <span class="keywordtype">bool</span> mEnabled; <span class="comment">// false if event is disabled</span>
<a name="l00513"></a>00513 <span class="keyword">mutable</span> <span class="keywordtype">bool</span> mUpdated; <span class="comment">// event has been updated but not written to calendar file</span>
<a name="l00514"></a>00514 };
<a name="l00515"></a>00515
<a name="l00516"></a>00516 <span class="preprocessor">#endif // KALARMEVENT_H</span>
</pre></div></div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kalarm</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classAlarmCalendar.html">alarmcalendar</option>, <option value="classKAEvent.html">kaevent</option>, <option value="classKAlarmIface.html">kalarmiface</option>, <option value="classMainWindowBase.html">mainwindowbase</option>, <option value="classMessageWin.html">messagewin</option>, <option value="classPickFileRadio.html">pickfileradio</option>, <option value="classStartOfDayTimer.html">startofdaytimer</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../akregator/html/index.html">akregator</a></li><li> <a href="../../akregator/src/html/index.html">src</a></li><li> <a href="../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../kandy/html/index.html">kandy</a></li><li><a href="../../karm/html/index.html">karm</a></li><li><a href="../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../kgantt/html/index.html">kgantt</a></li><li><a href="../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../kmail/html/index.html">kmail</a></li><li><a href="../../knotes/html/index.html">knotes</a></li><li><a href="../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../kontact/html/index.html">kontact</a></li><li><a href="../../korganizer/html/index.html">korganizer</a></li><li><a href="../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../libkcal/html/index.html">libkcal</a></li><li><a href="../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../libkmime/html/index.html">libkmime</a></li><li><a href="../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
