<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: r_calendar.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>r_calendar.h</h1><a href="r__calendar_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"></span><span class="comment">/// \file r_calendar.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Blackberry database record parser class for calendar records.</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_RECORD_CALENDAR_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_RECORD_CALENDAR_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="r__recur__base_8h.html" title="Base class for recurring calendar event data.">r_recur_base.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <iosfwd></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <string></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <vector></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <map></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <stdint.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>Barry {
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">// forward declarations</span>
<a name="l00037"></a>00037 <span class="keyword">class </span>IConverter;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">//</span>
<a name="l00040"></a>00040 <span class="comment">// NOTE: All classes here must be container-safe! Perhaps add sorting</span>
<a name="l00041"></a>00041 <span class="comment">// operators in the future.</span>
<a name="l00042"></a>00042 <span class="comment">//</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment">/// \addtogroup RecordParserClasses</span>
<a name="l00047"></a>00047 <span class="comment">/// @{</span>
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a><a class="code" href="classBarry_1_1Calendar.html">00049</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Calendar.html">Calendar</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1RecurBase.html">RecurBase</a>
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a>00052 <span class="keyword">typedef</span> std::vector<UnknownField> UnknownsType;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 uint8_t RecType;
<a name="l00055"></a>00055 uint32_t RecordId;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// general data</span>
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> AllDayEvent;
<a name="l00059"></a>00059 std::string Subject;
<a name="l00060"></a>00060 std::string Notes;
<a name="l00061"></a>00061 std::string Location;
<a name="l00062"></a>00062 time_t NotificationTime; <span class="comment">// 0 means notification is off</span>
<a name="l00063"></a>00063 time_t StartTime;
<a name="l00064"></a>00064 time_t EndTime;
<a name="l00065"></a>00065 EmailAddressList Organizer;
<a name="l00066"></a>00066 EmailAddressList AcceptedBy;
<a name="l00067"></a>00067 EmailAddressList Invited; <span class="comment">// list of invited people (email a</span>
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment"> ///</span>
<a name="l00070"></a>00070 <span class="comment"> /// Free Busy Flag</span>
<a name="l00071"></a>00071 <span class="comment"> ///</span>
<a name="l00072"></a>00072 <span class="comment"> /// This lists the available settings found in the device.</span>
<a name="l00073"></a>00073 <span class="comment"> /// This list is based on information from MS Outlook 2007</span>
<a name="l00074"></a>00074 <span class="comment"> /// (Free ==0 and Busy == 2)</span>
<a name="l00075"></a>00075 <span class="comment"> /// This is FBTYPE in RFC2445 and is defined as</span>
<a name="l00076"></a>00076 <span class="comment"> /// FREE, BUSY, BUSY-UNAVAILABLE and BUSY-TENTATIVE</span>
<a name="l00077"></a>00077 <span class="comment"> ///</span>
<a name="l00078"></a><a class="code" href="classBarry_1_1Calendar.html#a5f691272677f851e2d597710b60dbe11">00078</a> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="classBarry_1_1Calendar.html#a5f691272677f851e2d597710b60dbe11" title="Free Busy Flag.">FreeBusyFlagType</a> {
<a name="l00079"></a>00079 Free = 0,
<a name="l00080"></a>00080 Tentative,
<a name="l00081"></a>00081 Busy,
<a name="l00082"></a>00082 OutOfOffice
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084 FreeBusyFlagType FreeBusyFlag;
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> ///</span>
<a name="l00087"></a>00087 <span class="comment"> /// Class Flag</span>
<a name="l00088"></a>00088 <span class="comment"> ///</span>
<a name="l00089"></a>00089 <span class="comment"> /// This is also called classification in Evolution and it</span>
<a name="l00090"></a>00090 <span class="comment"> /// is the equivilant of public or private in outlook</span>
<a name="l00091"></a>00091 <span class="comment"> /// Private is set to 0x2 in Outlook</span>
<a name="l00092"></a>00092 <span class="comment"> /// RFC2445 CLASS is PUBLIC, PRIVATE, CONFIDENTIAL</span>
<a name="l00093"></a>00093 <span class="comment"> ///</span>
<a name="l00094"></a><a class="code" href="classBarry_1_1Calendar.html#a41c7f81327d36785c859674a17807e16">00094</a> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="classBarry_1_1Calendar.html#a41c7f81327d36785c859674a17807e16" title="Class Flag.">ClassFlagType</a> {
<a name="l00095"></a>00095 Public = 0,
<a name="l00096"></a>00096 Confidential,
<a name="l00097"></a>00097 Private
<a name="l00098"></a>00098 };
<a name="l00099"></a>00099
<a name="l00100"></a>00100 ClassFlagType ClassFlag;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 uint64_t CalendarID; <span class="comment">// Calendar ID (usefull if devices have several calendars)</span>
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> TimeZoneCode; <span class="comment">// the time zone originally used</span>
<a name="l00105"></a>00105 <span class="comment">// for the recurrence data...</span>
<a name="l00106"></a>00106 <span class="comment">// seems to have little use, but</span>
<a name="l00107"></a>00107 <span class="comment">// set to your current time zone</span>
<a name="l00108"></a>00108 <span class="comment">// as a good default</span>
<a name="l00109"></a>00109 <span class="keywordtype">bool</span> TimeZoneValid; <span class="comment">// true if the record contained a</span>
<a name="l00110"></a>00110 <span class="comment">// time zone code</span>
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// unknown</span>
<a name="l00113"></a>00113 UnknownsType Unknowns;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">protected</span>:
<a name="l00116"></a>00116 <span class="keyword">static</span> FreeBusyFlagType FreeBusyFlagProto2Rec(uint8_t f);
<a name="l00117"></a>00117 <span class="keyword">static</span> uint8_t FreeBusyFlagRec2Proto(FreeBusyFlagType f);
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="keyword">static</span> ClassFlagType ClassFlagProto2Rec(uint8_t f);
<a name="l00120"></a>00120 <span class="keyword">static</span> uint8_t ClassFlagRec2Proto(ClassFlagType f);
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DumpSpecialFields(std::ostream &os) <span class="keyword">const</span>;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keyword">public</span>:
<a name="l00125"></a>00125 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* ParseField(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *begin,
<a name="l00126"></a>00126 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *end, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic = 0);
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">public</span>:
<a name="l00129"></a>00129 <a class="code" href="classBarry_1_1Calendar.html">Calendar</a>();
<a name="l00130"></a>00130 ~<a class="code" href="classBarry_1_1Calendar.html">Calendar</a>();
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="comment">// Parser / Builder API (see parser.h / builder.h)</span>
<a name="l00133"></a>00133 uint8_t GetRecType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecType; }
<a name="l00134"></a>00134 uint32_t GetUniqueId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> RecordId; }
<a name="l00135"></a>00135 <span class="keywordtype">void</span> SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
<a name="l00136"></a>00136 <span class="keywordtype">void</span> ParseHeader(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset);
<a name="l00137"></a>00137 <span class="keywordtype">void</span> ParseFields(<span class="keyword">const</span> Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic = 0);
<a name="l00138"></a>00138 <span class="keywordtype">void</span> BuildHeader(Data &data, <span class="keywordtype">size_t</span> &offset) <span class="keyword">const</span>;
<a name="l00139"></a>00139 <span class="keywordtype">void</span> BuildFields(Data &data, <span class="keywordtype">size_t</span> &offset, <span class="keyword">const</span> IConverter *ic = 0) <span class="keyword">const</span>;
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keywordtype">void</span> Clear();
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">// sorting</span>
<a name="l00146"></a>00146 <span class="keywordtype">bool</span> operator<(<span class="keyword">const</span> Calendar &other) <span class="keyword">const</span>;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">// database name</span>
<a name="l00149"></a>00149 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * GetDBName() { <span class="keywordflow">return</span> <span class="stringliteral">"Calendar"</span>; }
<a name="l00150"></a>00150 <span class="keyword">static</span> uint8_t GetDefaultRecType() { <span class="keywordflow">return</span> 5; } <span class="comment">// or 0?</span>
<a name="l00151"></a>00151 };
<a name="l00152"></a>00152
<a name="l00153"></a>00153 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<<(std::ostream &os, <span class="keyword">const</span> Calendar &msg) {
<a name="l00154"></a>00154 msg.Dump(os);
<a name="l00155"></a>00155 <span class="keywordflow">return</span> os;
<a name="l00156"></a>00156 }
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00159"></a><a class="code" href="classBarry_1_1CalendarAll.html">00159</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1CalendarAll.html">CalendarAll</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Calendar.html">Calendar</a>
<a name="l00160"></a>00160 {
<a name="l00161"></a>00161 <span class="keyword">protected</span>:
<a name="l00162"></a>00162 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DumpSpecialFields(std::ostream &os) <span class="keyword">const</span>;
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="keyword">public</span>:
<a name="l00165"></a>00165 std::string MailAccount;
<a name="l00166"></a>00166
<a name="l00167"></a>00167 <span class="keyword">public</span>:
<a name="l00168"></a>00168 <span class="comment">// Parser / Builder API (see parser.h / builder.h)</span>
<a name="l00169"></a>00169 <span class="keywordtype">void</span> ParseHeader(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &data, <span class="keywordtype">size_t</span> &offset);
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keywordtype">void</span> Clear();
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">public</span>:
<a name="l00174"></a>00174 <span class="comment">// database name</span>
<a name="l00175"></a>00175 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * GetDBName() { <span class="keywordflow">return</span> <span class="stringliteral">"Calendar - All"</span>; }
<a name="l00176"></a>00176 };
<a name="l00177"></a>00177
<a name="l00178"></a>00178 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<<(std::ostream &os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1CalendarAll.html">CalendarAll</a> &msg) {
<a name="l00179"></a>00179 msg.Dump(os);
<a name="l00180"></a>00180 <span class="keywordflow">return</span> os;
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="comment"></span>
<a name="l00184"></a>00184 <span class="comment">/// @}</span>
<a name="l00185"></a>00185 <span class="comment"></span>
<a name="l00186"></a>00186 } <span class="comment">// namespace Barry</span>
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="preprocessor">#endif</span>
<a name="l00189"></a>00189 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
