<?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>libkholidays: LunarPhase Class Reference (libkholidays)</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=".">libkholidays</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>libkholidays</h2>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>LunarPhase Class Reference</h1><!-- doxytag: class="LunarPhase" --><code>#include <<a class="el" href="lunarphase_8h-source.html">lunarphase.h</a>></code>
<p>
<p>
<a href="classLunarPhase-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Represents and manages a Lunar Phase.
<p>
A Lunar Phase can be one of the following:<p>
+ "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. + "first quarter": the right 50% of the moon is visible. + "full": the moon is fully visible. + "last quarter": the left 50% of the moon is visible.<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>
In the southern hemisphere the order of the phases is reversed. So, to be accurate we need to know the hemisphere.<p>
Note that crescent and gibbous phases are not currently supported.
<p>Definition at line <a class="el" href="lunarphase_8h-source.html#l00065">65</a> of file <a class="el" href="lunarphase_8h-source.html">lunarphase.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>Phase</b> { <br>
<b>New</b>,
<b>FirstQ</b>,
<b>LastQ</b>,
<b>Full</b>,
<br>
<b>None</b>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>Hemisphere</b> { <b>Northern</b>,
<b>Southern</b>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae1d9d1aa9d08c4415c4268c060b2788"></a><!-- doxytag: member="LunarPhase::LunarPhase" ref="ae1d9d1aa9d08c4415c4268c060b2788" args="(Hemisphere hemisphere=Northern)" -->
</td><td class="memItemRight" valign="bottom"><b>LunarPhase</b> (Hemisphere hemisphere=Northern)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Phase </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#0000f90da9f3213756589d82dc8ef528">phase</a> (const QDate &date) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#363eacce10dfacbab85f6d7cc52a0fe6">phaseStr</a> (const QDate &date) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#6c4096be9374cc33bb14adb770e817dd">setHemisphere</a> (Hemisphere hemisphere=Northern)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Hemisphere </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#c63caa605e4c5a397d4d9fdb8ca970b4">hemisphere</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#4caa068aac19a40b136e2f119a9a886f">hemisphereStr</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#ea28e770ecd2312f5c81ba14f2cc1312">hemisphereName</a> (Hemisphere hemisphere)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classLunarPhase.html#e2649d6c1b7138dc1ff82d8feb27eeeb">phaseName</a> (Phase phase)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0000f90da9f3213756589d82dc8ef528"></a><!-- doxytag: member="LunarPhase::phase" ref="0000f90da9f3213756589d82dc8ef528" args="(const QDate &date) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LunarPhase::Phase LunarPhase::phase </td>
<td>(</td>
<td class="paramtype">const QDate & </td>
<td class="paramname"> <em>date</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the lunar phase for the specified Gregorian date.
<p>
The enum 'None' is returned if one of the supported phases does not occur on the date.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>date</em> </td><td>compute the lunar phase for the specified Gregorian date. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00106">106</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="363eacce10dfacbab85f6d7cc52a0fe6"></a><!-- doxytag: member="LunarPhase::phaseStr" ref="363eacce10dfacbab85f6d7cc52a0fe6" args="(const QDate &date) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LunarPhase::phaseStr </td>
<td>(</td>
<td class="paramtype">const QDate & </td>
<td class="paramname"> <em>date</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the lunar phase as a text string for the specified date.
<p>
A null string is returned if one of the supported phases does not occur on the date.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>date</em> </td><td>compute the lunar phase for the specified Gregorian date. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00079">79</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6c4096be9374cc33bb14adb770e817dd"></a><!-- doxytag: member="LunarPhase::setHemisphere" ref="6c4096be9374cc33bb14adb770e817dd" args="(Hemisphere hemisphere=Northern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LunarPhase::setHemisphere </td>
<td>(</td>
<td class="paramtype">Hemisphere </td>
<td class="paramname"> <em>hemisphere</em> = <code>Northern</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the hemisphere.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hemisphere</em> </td><td>Hemisphere </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00051">51</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c63caa605e4c5a397d4d9fdb8ca970b4"></a><!-- doxytag: member="LunarPhase::hemisphere" ref="c63caa605e4c5a397d4d9fdb8ca970b4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LunarPhase::Hemisphere LunarPhase::hemisphere </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the hemisphere.
<p>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00056">56</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="4caa068aac19a40b136e2f119a9a886f"></a><!-- doxytag: member="LunarPhase::hemisphereStr" ref="4caa068aac19a40b136e2f119a9a886f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LunarPhase::hemisphereStr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return hemisphere as a clear text string.
<p>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00061">61</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ea28e770ecd2312f5c81ba14f2cc1312"></a><!-- doxytag: member="LunarPhase::hemisphereName" ref="ea28e770ecd2312f5c81ba14f2cc1312" args="(Hemisphere hemisphere)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LunarPhase::hemisphereName </td>
<td>(</td>
<td class="paramtype">LunarPhase::Hemisphere </td>
<td class="paramname"> <em>hemisphere</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the string representation of hemisphere.
<p>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00066">66</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e2649d6c1b7138dc1ff82d8feb27eeeb"></a><!-- doxytag: member="LunarPhase::phaseName" ref="e2649d6c1b7138dc1ff82d8feb27eeeb" args="(Phase phase)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString LunarPhase::phaseName </td>
<td>(</td>
<td class="paramtype">LunarPhase::Phase </td>
<td class="paramname"> <em>phase</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the string representation of phase.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>phase</em> </td><td>the lunar phase. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="lunarphase_8cpp-source.html#l00084">84</a> of file <a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a>.</p>
</div>
</div><p>
<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><a class="el" href="lunarphase_8cpp-source.html">lunarphase.cpp</a></ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkholidays</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</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="classLunarPhase.html">lunarphase</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>
