<?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/lib: DailyTimer Class Reference (kalarm/lib)</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="../../html/index.html">kalarm</a> / <a href=".">lib</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/lib</h2>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>DailyTimer Class Reference</h1><!-- doxytag: class="DailyTimer" --><!-- doxytag: inherits="SynchTimer" --><code>#include <<a class="el" href="synchtimer_8h-source.html">synchtimer.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for DailyTimer:</div>
<div class="dynsection">
<p><center><img src="classDailyTimer.png" usemap="#DailyTimer_map" border="0" alt=""></center>
<map name="DailyTimer_map">
<area href="classSynchTimer.html" alt="SynchTimer" shape="rect" coords="0,0,79,24">
</map>
</div>
<p>
<a href="classDailyTimer-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classDailyTimer.html" title="DailyTimer is an application-wide timer synchronised to a specified time of day,...">DailyTimer</a> is an application-wide timer synchronised to a specified time of day, local time.
<p>
Daily timers come in two flavours: fixed, which can only be accessed through static methods, and variable, whose time can be adjusted and which are accessed through non-static methods.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>David Jarvie <<a href="mailto:software@astrojar.org.uk">software@astrojar.org.uk</a>> </dd></dl>
<p>Definition at line <a class="el" href="synchtimer_8h-source.html#l00115">115</a> of file <a class="el" href="synchtimer_8h-source.html">synchtimer.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDailyTimer.html#9bce14be3656e703a7b1fecfba4bb8b3">changeTime</a> (const QTime &newTimeOfDay, bool triggerMissed=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classDailyTimer.html#ad7b5ff4fab7f33b89d7c7315a7bbfb9">timeOfDay</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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDailyTimer.html#efea5a994f005292af7b674efbb5ff3c">connect</a> (const QTime &timeOfDay, QObject *receiver, const char *member)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDailyTimer.html#5ca372ed852354a69b2453d98fe560f0">disconnect</a> (const QTime &timeOfDay, QObject *receiver, const char *member=0)</td></tr>
<tr><td colspan="2"><br><h2>Protected Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a026053433b9d58c5f4dfd387a302745"></a><!-- doxytag: member="DailyTimer::slotTimer" ref="a026053433b9d58c5f4dfd387a302745" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>slotTimer</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDailyTimer.html#723fc7a240b88430dfaf2335d4df2ffa">DailyTimer</a> (const QTime &, bool fixed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a355a718b1a0f49f6d27ba56bff50a"></a><!-- doxytag: member="DailyTimer::start" ref="a6a355a718b1a0f49f6d27ba56bff50a" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>start</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDailyTimer.html">DailyTimer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDailyTimer.html#a9527b0e04cd0081f02a9f674d4b2280">fixedInstance</a> (const QTime &timeOfDay, bool create=true)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="723fc7a240b88430dfaf2335d4df2ffa"></a><!-- doxytag: member="DailyTimer::DailyTimer" ref="723fc7a240b88430dfaf2335d4df2ffa" args="(const QTime &, bool fixed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DailyTimer::DailyTimer </td>
<td>(</td>
<td class="paramtype">const QTime & </td>
<td class="paramname"> <em>timeOfDay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>fixed</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct an instance.
<p>
The constructor is protected to ensure that for variable timers, only derived classes can construct instances. This ensures that multiple timers are not created for the same use.
<p>Definition at line <a class="el" href="synchtimer_8cpp-source.html#l00124">124</a> of file <a class="el" href="synchtimer_8cpp-source.html">synchtimer.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="efea5a994f005292af7b674efbb5ff3c"></a><!-- doxytag: member="DailyTimer::connect" ref="efea5a994f005292af7b674efbb5ff3c" args="(const QTime &timeOfDay, QObject *receiver, const char *member)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void DailyTimer::connect </td>
<td>(</td>
<td class="paramtype">const QTime & </td>
<td class="paramname"> <em>timeOfDay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"> <em>receiver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>member</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect to the timer signal which triggers at the given fixed time of day.
<p>
A new timer is created if necessary. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeOfDay</em> </td><td>Time at which the timer is to trigger. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>receiver</em> </td><td>Receiving object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>member</em> </td><td>Slot to activate. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="synchtimer_8h-source.html#l00126">126</a> of file <a class="el" href="synchtimer_8h-source.html">synchtimer.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="5ca372ed852354a69b2453d98fe560f0"></a><!-- doxytag: member="DailyTimer::disconnect" ref="5ca372ed852354a69b2453d98fe560f0" args="(const QTime &timeOfDay, QObject *receiver, const char *member=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DailyTimer::disconnect </td>
<td>(</td>
<td class="paramtype">const QTime & </td>
<td class="paramname"> <em>timeOfDay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QObject * </td>
<td class="paramname"> <em>receiver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>member</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disconnect from the timer signal which triggers at the given fixed time of day.
<p>
If there are no remaining connections to that timer, it is destroyed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeOfDay</em> </td><td>Time at which the timer triggers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>receiver</em> </td><td>Receiving object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>member</em> </td><td>Slot to disconnect. If null, all slots belonging to <code>receiver</code> will be disconnected. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="synchtimer_8cpp-source.html#l00150">150</a> of file <a class="el" href="synchtimer_8cpp-source.html">synchtimer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="9bce14be3656e703a7b1fecfba4bb8b3"></a><!-- doxytag: member="DailyTimer::changeTime" ref="9bce14be3656e703a7b1fecfba4bb8b3" args="(const QTime &newTimeOfDay, bool triggerMissed=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DailyTimer::changeTime </td>
<td>(</td>
<td class="paramtype">const QTime & </td>
<td class="paramname"> <em>newTimeOfDay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>triggerMissed</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the time at which this variable timer triggers.
<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>newTimeOfDay</em> </td><td>New time at which the timer should trigger. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>triggerMissed</em> </td><td>If true, and if <code>newTimeOfDay</code> < <code>oldTimeOfDay</code>, and if the current time is between <code>newTimeOfDay</code> and <code>oldTimeOfDay</code>, the timer will be triggered immediately so as to avoid missing today's trigger. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="synchtimer_8cpp-source.html#l00163">163</a> of file <a class="el" href="synchtimer_8cpp-source.html">synchtimer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ad7b5ff4fab7f33b89d7c7315a7bbfb9"></a><!-- doxytag: member="DailyTimer::timeOfDay" ref="ad7b5ff4fab7f33b89d7c7315a7bbfb9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QTime DailyTimer::timeOfDay </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current time of day at which this variable timer triggers.
<p>
<p>Definition at line <a class="el" href="synchtimer_8h-source.html#l00144">144</a> of file <a class="el" href="synchtimer_8h-source.html">synchtimer.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a9527b0e04cd0081f02a9f674d4b2280"></a><!-- doxytag: member="DailyTimer::fixedInstance" ref="a9527b0e04cd0081f02a9f674d4b2280" args="(const QTime &timeOfDay, bool create=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classDailyTimer.html">DailyTimer</a> * DailyTimer::fixedInstance </td>
<td>(</td>
<td class="paramtype">const QTime & </td>
<td class="paramname"> <em>timeOfDay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>create</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the instance which triggers at the specified fixed time of day, optionally creating a new instance if necessary.
<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>timeOfDay</em> </td><td>Time at which the timer triggers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>create</em> </td><td>If true, create a new instance if none already exists for <code>timeOfDay</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The instance for <code>timeOfDay</code>, or 0 if it does not exist. </dd></dl>
<p>Definition at line <a class="el" href="synchtimer_8cpp-source.html#l00138">138</a> of file <a class="el" href="synchtimer_8cpp-source.html">synchtimer.cpp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="synchtimer_8h-source.html">synchtimer.h</a><li><a class="el" href="synchtimer_8cpp-source.html">synchtimer.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>kalarm/lib</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="classButtonGroup.html">buttongroup</option>, <option value="classCheckBox.html">checkbox</option>, <option value="classColourCombo.html">colourcombo</option>, <option value="classColourList.html">colourlist</option>, <option value="classComboBox.html">combobox</option>, <option value="classDailyTimer.html">dailytimer</option>, <option value="classDateEdit.html">dateedit</option>, <option value="classDateTime.html">datetime</option>, <option value="classLabel.html">label</option>, <option value="classLineEdit.html">lineedit</option>, <option value="classMessageBox.html">messagebox</option>, <option value="classMidnightTimer.html">midnighttimer</option>, <option value="classMinuteTimer.html">minutetimer</option>, <option value="classPushButton.html">pushbutton</option>, <option value="classRadioButton.html">radiobutton</option>, <option value="classShellProcess.html">shellprocess</option>, <option value="classSlider.html">slider</option>, <option value="classSpinBox.html">spinbox</option>, <option value="classSpinBox2.html">spinbox2</option>, <option value="classSynchTimer.html">synchtimer</option>, <option value="classTimeEdit.html">timeedit</option>, <option value="classTimePeriod.html">timeperiod</option>, <option value="classTimeSpinBox.html">timespinbox</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>
