<?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" xml:lang="en">
<head>
<title>holidayparserdriver_p.h Source File</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<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" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../favicon.ico" /><link rel="icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>KHolidays Library</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_7d1f8f4788b4980602abcfcd1bfe22cd.html">kholidays</a></li><li class="navelem"><a class="el" href="dir_e5229cbffbc67e85dc8d9aeebaeedcfd.html">parsers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">holidayparserdriver_p.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> This file is part of the kholidays library.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright 2010 John Layt <john@layt.net></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> modify it under the terms of the GNU Library General Public</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> version 2 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> GNU Library General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> You should have received a copy of the GNU Library General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to the</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef KHOLIDAYS_HOLIDAYPARSERDRIVER_P_H</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define KHOLIDAYS_HOLIDAYPARSERDRIVER_P_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <QDate></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <QString></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "holiday.h"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>KCalendarSystem;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>KHolidays {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="classKHolidays_1_1HolidayParserDriver.html"> 44</a></span> <span class="keyword">class </span><a class="code" href="classKHolidays_1_1HolidayParserDriver.html" title="HolidayParserDriver abstract base class.">HolidayParserDriver</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">explicit</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a92ea754434396faffda1cddbd7073395" title="Constructor of abstract holiday file parser driver class.">HolidayParserDriver</a>( <span class="keyword">const</span> QString &filePath );</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">virtual</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a254f1949111fa797a1c68a5c1b682df8" title="Destructor.">~HolidayParserDriver</a>();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">virtual</span> QString <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#aaab8e0e2240a7c67173901c1864fde8e" title="Return the ISO 3166 country/region code of the file.">fileCountryCode</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> QString <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a4f5ed4137fad9b6a82f5f818c7a2ea85" title="Return the ISO 639-1 language code of the file.">fileLanguageCode</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">virtual</span> QString <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a4514d53e9a72e1c3f3246afabbb0243a" title="Return the untranslated name of the file.">fileName</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">virtual</span> QString <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#aeab3dd042ee7aef594e0e4816c088963" title="Return the untranslated description of the file if available.">fileDescription</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">virtual</span> Holiday::List <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a83c8b05e7209bb2f0a2e3f6108a90f48" title="Return a list of holidays falling between any two dates.">parseHolidays</a>( <span class="keyword">const</span> QDate &startDate, <span class="keyword">const</span> QDate &endDate,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  Holiday::MultidayMode multidayMode );</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">virtual</span> Holiday::List <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a83c8b05e7209bb2f0a2e3f6108a90f48" title="Return a list of holidays falling between any two dates.">parseHolidays</a>( <span class="keyword">const</span> QDate &date, Holiday::MultidayMode multidayMode );</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">virtual</span> Holiday::List <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a83c8b05e7209bb2f0a2e3f6108a90f48" title="Return a list of holidays falling between any two dates.">parseHolidays</a>( <span class="keywordtype">int</span> calendarYear, <span class="keyword">const</span> QString &calendarType,</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  Holiday::MultidayMode multidayMode );</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a092c23aafe8d91c853af845881c681b1" title="Standard error message handling.">error</a>( <span class="keyword">const</span> QString &errorMessage );</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a6b558f1f9ec8b4511861beca250d412b" title="Actually parse the file, must be re-implemented by derived classes.">parse</a>();</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#af7f762e4fb1b5ee93092e6c364142c21" title="Parse the file for metadata only and populate the metadata variables.">parseMetadata</a>();</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a520b79ab034da2392996365020ef92c5" title="Set the calendar system to use.">setParseCalendar</a>( <span class="keyword">const</span> QString &calendarType );</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKHolidays_1_1HolidayParserDriver.html#a0292751f1f3c54650bcbd9764eeab772" title="Initialise parse year variables for calendar system.">setParseStartEnd</a>();</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  QString m_filePath; <span class="comment">// File to be parsed</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  QString m_fileCountryCode; <span class="comment">// File country code in ISO 3166-2 standard</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  QString m_fileLanguageCode; <span class="comment">// File language</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  QString m_fileName; <span class="comment">// File name</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  QString m_fileDescription; <span class="comment">// File description</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  QDate m_requestStart; <span class="comment">// First day of period being requested</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  QDate m_requestEnd; <span class="comment">// Last day of period being requested</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  Holiday::List m_resultList; <span class="comment">// List of requested holidays</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  KCalendarSystem *m_parseCalendar; <span class="comment">// Calendar system being parsed</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">int</span> m_parseYear; <span class="comment">// Year currently being parsed</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keywordtype">int</span> m_parseStartYear; <span class="comment">// First year to parse in parse calendar</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordtype">int</span> m_parseEndYear; <span class="comment">// Last year to parse in parse calendar</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  Holiday::MultidayMode m_multidayMode; <span class="comment">// How to return multiday holidays</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> };</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> }</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor">#endif // KHOLIDAYS_HOLIDAYPARSERDRIVER_P_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:06 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">KHolidays Library</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "KHolidays Library"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</a></li><li><a href="pages.html">Related Pages</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="classKHolidays_1_1HolidayParserDriver.html">kholidays::holidayparserdriver</option>, <option value="classKHolidays_1_1HolidayParserDriverPlan.html">kholidays::holidayparserdriverplan</option>, <option value="classKHolidays_1_1HolidayParserDriverPlanOld.html">kholidays::holidayparserdriverplanold</option>, <option value="classKHolidays_1_1HolidayParserPlan.html">kholidays::holidayparserplan</option>, <option value="classKHolidays_1_1HolidayScannerPlan.html">kholidays::holidayscannerplan</option>, <option value="classKHolidays_1_1location.html">kholidays::location</option>, <option value="classKHolidays_1_1LunarPhase.html">kholidays::lunarphase</option>, <option value="classKHolidays_1_1position.html">kholidays::position</option>, <option value="classKHolidays_1_1slice.html">kholidays::slice</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../kblog/html/index.html">kblog</a></li><li><a href="../../kcal/html/index.html">kcal</a></li><li><a href="../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../kholidays/html/index.html">kholidays</a></li><li><a href="../../kimap/html/index.html">kimap</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../kldap/html/index.html">kldap</a></li><li><a href="../../kmbox/html/index.html">kmbox</a></li><li><a href="../../kmime/html/index.html">kmime</a></li><li><a href="../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../ktnef/html/index.html">ktnef</a></li><li><a href="../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../microblog/html/index.html">microblog</a></li><li><a href="../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../syndication/html/index.html">syndication</a></li><li> <a href="../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
