<?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>KHolidays::LunarPhase Class Reference</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"><b>KHolidays</b></li><li class="navelem"><a class="el" href="classKHolidays_1_1LunarPhase.html">LunarPhase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classKHolidays_1_1LunarPhase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KHolidays::LunarPhase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="lunarphase_8h_source.html">lunarphase.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a55afba64aa078d68dac385fe144a85e2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2">Phase</a> { <br/>
  <a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2af4907e0a05647e540d38a96d65a0bc83">NewMoon</a>,
<a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2a182adc1d93234560bc4f2050e45b1d47">FirstQuarter</a>,
<a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2a8c8a08f9b072028e23878e5aa7d82bcd">LastQuarter</a>,
<a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2a0baad3429b9d3fdf7e55ce6ea571d082">FullMoon</a>,
<br/>
  <a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2a32a0aa410419112797252ba675f49d6d">None</a>
<br/>
}</td></tr>
<tr class="separator:a55afba64aa078d68dac385fe144a85e2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a36dc746eb4106d3c10f695f4680d5cbe"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2">Phase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKHolidays_1_1LunarPhase.html#a36dc746eb4106d3c10f695f4680d5cbe">phaseAtDate</a> (const QDate &date)</td></tr>
<tr class="separator:a36dc746eb4106d3c10f695f4680d5cbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2649d6c1b7138dc1ff82d8feb27eeeb"><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKHolidays_1_1LunarPhase.html#ae2649d6c1b7138dc1ff82d8feb27eeeb">phaseName</a> (<a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2">Phase</a> phase)</td></tr>
<tr class="separator:ae2649d6c1b7138dc1ff82d8feb27eeeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a323272a53c3ed31991eda9726125bc47"><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKHolidays_1_1LunarPhase.html#a323272a53c3ed31991eda9726125bc47">phaseNameAtDate</a> (const QDate &date)</td></tr>
<tr class="separator:a323272a53c3ed31991eda9726125bc47"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents and manages a Lunar Phase. </p>
<p>A Lunar Phase can be one of the following:</p>
<ul>
<li>"new": the moon is not visible; or traditionally: first visible crescent of the Moon. For religious purposes, the new month begins when the first crescent moon can be seen. Thus, it is impossible to be certain in advance of when months will begin; in particular, the exact date on which Ramadan will begin is not known in advance. In Saudi Arabia, observers are sent up in airplanes if the weather is cloudy when the new moon is expected.</li>
<li>"first quarter": the right 50% of the moon is visible.</li>
<li>"full": the moon is fully visible.</li>
<li>"last quarter": the left 50% of the moon is visible.</li>
</ul>
<p>A very good description of the lunar phases can be read at the Wikipedia, <a href="http://en.wikipedia.org/wiki/Lunar_phase">http://en.wikipedia.org/wiki/Lunar_phase</a></p>
<p>Note that crescent and gibbous phases are not currently supported. </p>
<p>Definition at line <a class="el" href="lunarphase_8h_source.html#l00054">54</a> of file <a class="el" href="lunarphase_8h_source.html">lunarphase.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a55afba64aa078d68dac385fe144a85e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2">KHolidays::LunarPhase::Phase</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Phases of the moon, in traditional English notation. </p>
<p>The phase <code>None</code> is used only as an error indicator, for instance in phase(). </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a55afba64aa078d68dac385fe144a85e2af4907e0a05647e540d38a96d65a0bc83"></a>NewMoon</em> </td><td class="fielddoc">
<p>New moon phase. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a55afba64aa078d68dac385fe144a85e2a182adc1d93234560bc4f2050e45b1d47"></a>FirstQuarter</em> </td><td class="fielddoc">
<p>First quarter of moon phase. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a55afba64aa078d68dac385fe144a85e2a8c8a08f9b072028e23878e5aa7d82bcd"></a>LastQuarter</em> </td><td class="fielddoc">
<p>Last quarter of moon phase. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a55afba64aa078d68dac385fe144a85e2a0baad3429b9d3fdf7e55ce6ea571d082"></a>FullMoon</em> </td><td class="fielddoc">
<p>Full moon phase. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a55afba64aa078d68dac385fe144a85e2a32a0aa410419112797252ba675f49d6d"></a>None</em> </td><td class="fielddoc">
<p>Indication for error. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="lunarphase_8h_source.html#l00062">62</a> of file <a class="el" href="lunarphase_8h_source.html">lunarphase.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a36dc746eb4106d3c10f695f4680d5cbe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2">LunarPhase::Phase</a> LunarPhase::phaseAtDate </td>
<td>(</td>
<td class="paramtype">const QDate & </td>
<td class="paramname"><em>date</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the lunar phase for the specified Gregorian date. </p>
<p>The enum 'None' is returned if one of the supported phases does not occur on the date.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">date</td><td>compute the lunar phase for the specified Gregorian date. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp_source.html#l00062">62</a> of file <a class="el" href="lunarphase_8cpp_source.html">lunarphase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae2649d6c1b7138dc1ff82d8feb27eeeb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString LunarPhase::phaseName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKHolidays_1_1LunarPhase.html#a55afba64aa078d68dac385fe144a85e2">LunarPhase::Phase</a> </td>
<td class="paramname"><em>phase</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the string representation of phase. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">phase</td><td>the lunar phase. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp_source.html#l00045">45</a> of file <a class="el" href="lunarphase_8cpp_source.html">lunarphase.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a323272a53c3ed31991eda9726125bc47"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString LunarPhase::phaseNameAtDate </td>
<td>(</td>
<td class="paramtype">const QDate & </td>
<td class="paramname"><em>date</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the lunar phase as a text string for the specified date. </p>
<p>A null string is returned if one of the supported phases does not occur on the date.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">date</td><td>compute the lunar phase for the specified Gregorian date. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp_source.html#l00040">40</a> of file <a class="el" href="lunarphase_8cpp_source.html">lunarphase.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="lunarphase_8h_source.html">lunarphase.h</a></li>
<li><a class="el" href="lunarphase_8cpp_source.html">lunarphase.cpp</a></li>
</ul>
</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:07 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>
