<?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: alarmcalendar.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>alarmcalendar.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * alarmcalendar.h - KAlarm calendar file access</span>
<a name="l00003"></a>00003 <span class="comment"> * Program: kalarm</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright © 2001-2006 by David Jarvie <software@astrojar.org.uk></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 ALARMCALENDAR_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define ALARMCALENDAR_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <qobject.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <kurl.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <libkcal/calendarlocal.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="alarmevent_8h.html" title="represents calendar alarms and events">alarmevent.h</a>"</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span>KConfig;
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00036"></a><a class="code" href="classAlarmCalendar.html">00036</a> <span class="keyword">class </span><a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a> : <span class="keyword">public</span> QObject
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 Q_OBJECT
<a name="l00039"></a>00039 <span class="keyword">public</span>:
<a name="l00040"></a>00040 <span class="keyword">virtual</span> ~<a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>();
<a name="l00041"></a>00041 <span class="keywordtype">bool</span> valid()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUrl.isValid(); }
<a name="l00042"></a>00042 <a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">KAEvent::Status</a> type()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mType; }
<a name="l00043"></a>00043 <span class="keywordtype">bool</span> open();
<a name="l00044"></a>00044 <span class="keywordtype">int</span> load();
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> reload();
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> save();
<a name="l00047"></a>00047 <span class="keywordtype">void</span> close();
<a name="l00048"></a>00048 <span class="keywordtype">void</span> startUpdate();
<a name="l00049"></a>00049 <span class="keywordtype">bool</span> endUpdate();
<a name="l00050"></a>00050 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>* event(<span class="keyword">const</span> QString& uniqueID);
<a name="l00051"></a>00051 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1ListBase.html">KCal::Event::List</a> events();
<a name="l00052"></a>00052 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1ListBase.html">KCal::Event::List</a> eventsWithAlarms(<span class="keyword">const</span> QDateTime& from, <span class="keyword">const</span> QDateTime& to);
<a name="l00053"></a>00053 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>* addEvent(<a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>&, <span class="keywordtype">bool</span> useEventID = <span class="keyword">false</span>);
<a name="l00054"></a>00054 <span class="keywordtype">void</span> updateEvent(<span class="keyword">const</span> <a class="code" href="classKAEvent.html" title="KAEvent corresponds to a KCal::Event instance.">KAEvent</a>&);
<a name="l00055"></a>00055 <span class="keywordtype">bool</span> deleteEvent(<span class="keyword">const</span> QString& eventID, <span class="keywordtype">bool</span> save = <span class="keyword">false</span>);
<a name="l00056"></a>00056 <span class="keywordtype">void</span> emitEmptyStatus();
<a name="l00057"></a>00057 <span class="keywordtype">void</span> purgeAll() { purge(0); }
<a name="l00058"></a>00058 <span class="keywordtype">void</span> setPurgeDays(<span class="keywordtype">int</span> days);
<a name="l00059"></a>00059 <span class="keywordtype">void</span> purgeIfQueued(); <span class="comment">// must only be called from KAlarmApp::processQueue()</span>
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> isOpen()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mOpen; }
<a name="l00061"></a>00061 QString path()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUrl.prettyURL(); }
<a name="l00062"></a>00062 QString urlString()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUrl.url(); }
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">static</span> QString icalProductId();
<a name="l00065"></a>00065 <span class="keyword">static</span> <span class="keywordtype">bool</span> initialiseCalendars();
<a name="l00066"></a>00066 <span class="keyword">static</span> <span class="keywordtype">void</span> terminateCalendars();
<a name="l00067"></a>00067 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* activeCalendar() { <span class="keywordflow">return</span> mCalendars[ACTIVE]; }
<a name="l00068"></a>00068 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* expiredCalendar() { <span class="keywordflow">return</span> mCalendars[EXPIRED]; }
<a name="l00069"></a>00069 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* displayCalendar() { <span class="keywordflow">return</span> mCalendars[DISPLAY]; }
<a name="l00070"></a>00070 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* templateCalendar() { <span class="keywordflow">return</span> mCalendars[TEMPLATE]; }
<a name="l00071"></a>00071 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* activeCalendarOpen() { <span class="keywordflow">return</span> calendarOpen(ACTIVE); }
<a name="l00072"></a>00072 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* expiredCalendarOpen() { <span class="keywordflow">return</span> calendarOpen(EXPIRED); }
<a name="l00073"></a>00073 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* displayCalendarOpen() { <span class="keywordflow">return</span> calendarOpen(DISPLAY); }
<a name="l00074"></a>00074 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* templateCalendarOpen() { <span class="keywordflow">return</span> calendarOpen(TEMPLATE); }
<a name="l00075"></a>00075 <span class="keyword">static</span> <span class="keywordtype">bool</span> importAlarms(QWidget*);
<a name="l00076"></a>00076 <span class="keyword">static</span> <span class="keyword">const</span> <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1Event.html">KCal::Event</a>* getEvent(<span class="keyword">const</span> QString& uniqueID);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keyword">enum</span> CalID { ACTIVE, EXPIRED, DISPLAY, TEMPLATE, NCALS };
<a name="l00079"></a>00079
<a name="l00080"></a>00080 signals:
<a name="l00081"></a>00081 <span class="keywordtype">void</span> calendarSaved(<a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>*);
<a name="l00082"></a>00082 <span class="keywordtype">void</span> purged();
<a name="l00083"></a>00083 <span class="keywordtype">void</span> emptyStatus(<span class="keywordtype">bool</span> empty);
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">private</span> slots:
<a name="l00086"></a>00086 <span class="keywordtype">void</span> slotPurge();
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">private</span>:
<a name="l00089"></a>00089 <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>(<span class="keyword">const</span> QString& file, CalID, <span class="keyword">const</span> QString& icalFile = QString::null,
<a name="l00090"></a>00090 <span class="keyword">const</span> QString& configKey = QString::null);
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> create();
<a name="l00092"></a>00092 <span class="keywordtype">bool</span> saveCal(<span class="keyword">const</span> QString& newFile = QString::null);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> purge(<span class="keywordtype">int</span> daysToKeep);
<a name="l00094"></a>00094 <span class="keywordtype">void</span> startPurgeTimer();
<a name="l00095"></a>00095 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* createCalendar(CalID, KConfig*, QString& writePath, <span class="keyword">const</span> QString& configKey = QString::null);
<a name="l00096"></a>00096 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* calendarOpen(CalID);
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">static</span> <a class="code" href="classAlarmCalendar.html" title="Provides read and write access to calendar files.">AlarmCalendar</a>* mCalendars[NCALS]; <span class="comment">// the calendars</span>
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <a class="codeRef" doxygen="libkcal.tag:../../libkcal/html/" href="../../libkcal/html/classKCal_1_1CalendarLocal.html">KCal::CalendarLocal</a>* mCalendar;
<a name="l00101"></a>00101 KURL mUrl; <span class="comment">// URL of current calendar file</span>
<a name="l00102"></a>00102 KURL mICalUrl; <span class="comment">// URL of iCalendar file</span>
<a name="l00103"></a>00103 QString mLocalFile; <span class="comment">// calendar file, or local copy if it's a remote file</span>
<a name="l00104"></a>00104 QString mConfigKey; <span class="comment">// config file key for this calendar's URL</span>
<a name="l00105"></a>00105 <a class="code" href="classKAEvent.html#6699b6a06aa2aec3f59ea0ca29f7365c" title="The category of an event, indicated by the middle part of its UID.">KAEvent::Status</a> mType; <span class="comment">// what type of events the calendar file is for</span>
<a name="l00106"></a>00106 <span class="keywordtype">int</span> mPurgeDays; <span class="comment">// how long to keep alarms, 0 = don't keep, -1 = keep indefinitely</span>
<a name="l00107"></a>00107 <span class="keywordtype">bool</span> mOpen; <span class="comment">// true if the calendar file is open</span>
<a name="l00108"></a>00108 <span class="keywordtype">int</span> mPurgeDaysQueued; <span class="comment">// >= 0 to purge the calendar when called from KAlarmApp::processLoop()</span>
<a name="l00109"></a>00109 <span class="keywordtype">int</span> mUpdateCount; <span class="comment">// nesting level of group of calendar update calls</span>
<a name="l00110"></a>00110 <span class="keywordtype">bool</span> mUpdateSave; <span class="comment">// save() was called while mUpdateCount > 0</span>
<a name="l00111"></a>00111 <span class="keywordtype">bool</span> mVCal; <span class="comment">// true if calendar file is in VCal format</span>
<a name="l00112"></a>00112 };
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="preprocessor">#endif // ALARMCALENDAR_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>
