<?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>KAlarmCal::KAAlarm 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>KAlarm Library</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KAlarmCal</b></li><li class="navelem"><a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classKAlarmCal_1_1KAAlarm-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KAlarmCal::KAAlarm Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="kaevent_8h_source.html">kaevent.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:a88c1ff85d1782100d60040aa53f3c0b2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2">Action</a> { <br/>
  <a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2a0a52cc89b2bb584c15ed9d124699c8bb">MESSAGE</a>,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2a19d6ada4051b513d53d4dcc50a9e58fe">FILE</a>,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2aea8767d653dc7a9a7e91b8d7dd3d4578">COMMAND</a>,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2a0401a102b438469e50f7a349bc3b54c6">EMAIL</a>,
<br/>
  <a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2a365e8465035366e76bf0a778bd944d60">AUDIO</a>
<br/>
}</td></tr>
<tr class="separator:a88c1ff85d1782100d60040aa53f3c0b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afae6ed98f38fddc638b3c2712bcaf175"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175">Type</a> { <br/>
  <a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175a2ec05c3bbfb42f49f71a7201f2f8f22c">INVALID_ALARM</a> = 0,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175ae0cfee5c8f22a5004f3685470db9fb00">MAIN_ALARM</a> = 1,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175a106999216c392b6622c71f2dbc77be90">REMINDER_ALARM</a> = 0x02,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175a03abc42fc1fefa7bfd8257f0d49ed5b1">DEFERRED_ALARM</a> = 0x04,
<br/>
  <a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175a1ae4259122a2349176f542722e8ea3ec">DEFERRED_REMINDER_ALARM</a> = REMINDER_ALARM | DEFERRED_ALARM,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175afeb88f0d4b301213d8c7d2834ccd19f1">AT_LOGIN_ALARM</a> = 0x10,
<a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175a494e087d8455865a51b9f9336e43fc6f">DISPLAYING_ALARM</a> = 0x20
<br/>
}</td></tr>
<tr class="separator:afae6ed98f38fddc638b3c2712bcaf175"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a206c922ddab987b44a4c254be75492ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a206c922ddab987b44a4c254be75492ce">KAAlarm</a> ()</td></tr>
<tr class="separator:a206c922ddab987b44a4c254be75492ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ab12d8f8f7b089acb85359deb945529"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a6ab12d8f8f7b089acb85359deb945529">KAAlarm</a> (const <a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a> &other)</td></tr>
<tr class="separator:a6ab12d8f8f7b089acb85359deb945529"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad64744b21b85362e360fa63343d3902e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#ad64744b21b85362e360fa63343d3902e">~KAAlarm</a> ()</td></tr>
<tr class="separator:ad64744b21b85362e360fa63343d3902e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ad6701b4b19502ec4d2c9611727fb18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2">Action</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a4ad6701b4b19502ec4d2c9611727fb18">action</a> () const </td></tr>
<tr class="separator:a4ad6701b4b19502ec4d2c9611727fb18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa161ef7a04853a1a1314d2ad11fa25e5"><td class="memItemLeft" align="right" valign="top">QDate </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#aa161ef7a04853a1a1314d2ad11fa25e5">date</a> () const </td></tr>
<tr class="separator:aa161ef7a04853a1a1314d2ad11fa25e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b2cb98df3c13d77874fcf657cb5ff51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKAlarmCal_1_1DateTime.html">DateTime</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a9b2cb98df3c13d77874fcf657cb5ff51">dateTime</a> (bool withRepeats=false) const </td></tr>
<tr class="separator:a9b2cb98df3c13d77874fcf657cb5ff51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1dd29d24d75e841377924ca78ae453fa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a1dd29d24d75e841377924ca78ae453fa">deferred</a> () const </td></tr>
<tr class="separator:a1dd29d24d75e841377924ca78ae453fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a203db4d8be8f3afe6ef441b0375b75f6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a203db4d8be8f3afe6ef441b0375b75f6">isReminder</a> () const </td></tr>
<tr class="separator:a203db4d8be8f3afe6ef441b0375b75f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a190c61b815e2ec65756c7112d28d3a27"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a190c61b815e2ec65756c7112d28d3a27">isValid</a> () const </td></tr>
<tr class="separator:a190c61b815e2ec65756c7112d28d3a27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa35ef6a919404d7830f8d0dd3c8e2494"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#aa35ef6a919404d7830f8d0dd3c8e2494">operator=</a> (const <a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a> &other)</td></tr>
<tr class="separator:aa35ef6a919404d7830f8d0dd3c8e2494"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99d08e99fd55fd9e576f9f8ff90fe0c8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a99d08e99fd55fd9e576f9f8ff90fe0c8">repeatAtLogin</a> () const </td></tr>
<tr class="separator:a99d08e99fd55fd9e576f9f8ff90fe0c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33ebf7f95b1ec3afb83a1f09377ca178"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a33ebf7f95b1ec3afb83a1f09377ca178">setTime</a> (const <a class="el" href="classKAlarmCal_1_1DateTime.html">DateTime</a> &dt)</td></tr>
<tr class="separator:a33ebf7f95b1ec3afb83a1f09377ca178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4339ce734fdf88f521bafe4fb9934f6f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a4339ce734fdf88f521bafe4fb9934f6f">setTime</a> (const KDateTime &dt)</td></tr>
<tr class="separator:a4339ce734fdf88f521bafe4fb9934f6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada49cd2ddd69d8f801282239633ef3ea"><td class="memItemLeft" align="right" valign="top">QTime </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#ada49cd2ddd69d8f801282239633ef3ea">time</a> () const </td></tr>
<tr class="separator:ada49cd2ddd69d8f801282239633ef3ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaab55a2ca61055c68898f6c6dfd45227"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#aaab55a2ca61055c68898f6c6dfd45227">timedDeferral</a> () const </td></tr>
<tr class="separator:aaab55a2ca61055c68898f6c6dfd45227"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ead09ea7217109cb5e97260f321d39a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a7ead09ea7217109cb5e97260f321d39a">type</a> () const </td></tr>
<tr class="separator:a7ead09ea7217109cb5e97260f321d39a"><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:a581975376009b0eef160e7c3d8e71a17"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a581975376009b0eef160e7c3d8e71a17">debugType</a> (<a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175">Type</a>)</td></tr>
<tr class="separator:a581975376009b0eef160e7c3d8e71a17"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classKAlarmCal_1_1KAAlarm.html" title="KAAlarm represents individual alarms within a KAEvent.">KAAlarm</a> represents individual alarms within a <a class="el" href="classKAlarmCal_1_1KAEvent.html" title="KAEvent represents a KAlarm event.">KAEvent</a>. </p>
<p>The <a class="el" href="classKAlarmCal_1_1KAAlarm.html" title="KAAlarm represents individual alarms within a KAEvent.">KAAlarm</a> class represents one of the main or subsidiary alarms in a <a class="el" href="classKAlarmCal_1_1KAEvent.html" title="KAEvent represents a KAlarm event.">KAEvent</a> instance. It contains the alarm's type and trigger time.</p>
<p>Note that valid <a class="el" href="classKAlarmCal_1_1KAAlarm.html" title="KAAlarm represents individual alarms within a KAEvent.">KAAlarm</a> instances can only be created by the <a class="el" href="classKAlarmCal_1_1KAEvent.html" title="KAEvent represents a KAlarm event.">KAEvent</a> class.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKAlarmCal_1_1KAEvent.html#af82b6e6359cb95968e34da3df566797b" title="Return the alarm of a specified type.">KAEvent::alarm()</a>, <a class="el" href="classKAlarmCal_1_1KAEvent.html#acac979eacf18be4a57ceda4428739f54" title="Return the main alarm for the event.">KAEvent::firstAlarm()</a>, <a class="el" href="classKAlarmCal_1_1KAEvent.html#ab4fb65de1c6a39b727eb93b30b2a7bc6" title="Return the next alarm for the event, after the specified alarm.">KAEvent::nextAlarm()</a>.</dd></dl>
<dl class="section author"><dt>Author</dt><dd>David Jarvie <a href="#" onclick="location.href='mai'+'lto:'+'dja'+'rv'+'ie@'+'kd'+'e.o'+'rg'; return false;">djarv<span style="display: none;">.nosp@m.</span>ie@k<span style="display: none;">.nosp@m.</span>de.or<span style="display: none;">.nosp@m.</span>g</a> </dd></dl>
<p>Definition at line <a class="el" href="kaevent_8h_source.html#l00078">78</a> of file <a class="el" href="kaevent_8h_source.html">kaevent.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a88c1ff85d1782100d60040aa53f3c0b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2">KAlarmCal::KAAlarm::Action</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The basic <a class="el" href="classKAlarmCal_1_1KAAlarm.html" title="KAAlarm represents individual alarms within a KAEvent.">KAAlarm</a> action types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a88c1ff85d1782100d60040aa53f3c0b2a0a52cc89b2bb584c15ed9d124699c8bb"></a>MESSAGE</em> </td><td class="fielddoc">
<p>KCal::Alarm::Display type: display a text message. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a88c1ff85d1782100d60040aa53f3c0b2a19d6ada4051b513d53d4dcc50a9e58fe"></a>FILE</em> </td><td class="fielddoc">
<p>KCal::Alarm::Display type: display a file (URL given by the alarm text) </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a88c1ff85d1782100d60040aa53f3c0b2aea8767d653dc7a9a7e91b8d7dd3d4578"></a>COMMAND</em> </td><td class="fielddoc">
<p>KCal::Alarm::Procedure type: execute a shell command. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a88c1ff85d1782100d60040aa53f3c0b2a0401a102b438469e50f7a349bc3b54c6"></a>EMAIL</em> </td><td class="fielddoc">
<p>KCal::Alarm::Email type: send an email. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a88c1ff85d1782100d60040aa53f3c0b2a365e8465035366e76bf0a778bd944d60"></a>AUDIO</em> </td><td class="fielddoc">
<p>KCal::Alarm::Audio type: play a sound file. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="kaevent_8h_source.html#l00082">82</a> of file <a class="el" href="kaevent_8h_source.html">kaevent.h</a>.</p>
</div>
</div>
<a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175">KAlarmCal::KAAlarm::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Alarm types. </p>
<p><a class="el" href="classKAlarmCal_1_1KAAlarm.html" title="KAAlarm represents individual alarms within a KAEvent.">KAAlarm</a>'s of different types may be contained in a <a class="el" href="classKAlarmCal_1_1KAEvent.html" title="KAEvent represents a KAlarm event.">KAEvent</a>, each <a class="el" href="classKAlarmCal_1_1KAAlarm.html" title="KAAlarm represents individual alarms within a KAEvent.">KAAlarm</a> defining a different component of the overall alarm. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175a2ec05c3bbfb42f49f71a7201f2f8f22c"></a>INVALID_ALARM</em> </td><td class="fielddoc">
<p>Not an alarm. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175ae0cfee5c8f22a5004f3685470db9fb00"></a>MAIN_ALARM</em> </td><td class="fielddoc">
<p>THE real alarm. Must be the first in the enumeration. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175a106999216c392b6622c71f2dbc77be90"></a>REMINDER_ALARM</em> </td><td class="fielddoc">
<p>Reminder in advance of/after the main alarm. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175a03abc42fc1fefa7bfd8257f0d49ed5b1"></a>DEFERRED_ALARM</em> </td><td class="fielddoc">
<p>Deferred alarm. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175a1ae4259122a2349176f542722e8ea3ec"></a>DEFERRED_REMINDER_ALARM</em> </td><td class="fielddoc">
<p>Deferred reminder alarm. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175afeb88f0d4b301213d8c7d2834ccd19f1"></a>AT_LOGIN_ALARM</em> </td><td class="fielddoc">
<p>Additional repeat-at-login trigger. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="afae6ed98f38fddc638b3c2712bcaf175a494e087d8455865a51b9f9336e43fc6f"></a>DISPLAYING_ALARM</em> </td><td class="fielddoc">
<p>Copy of the alarm currently being displayed. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="kaevent_8h_source.html#l00095">95</a> of file <a class="el" href="kaevent_8h_source.html">kaevent.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a206c922ddab987b44a4c254be75492ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KAlarmCal::KAAlarm::KAAlarm </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor, which creates an invalid instance. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06100">6100</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6ab12d8f8f7b089acb85359deb945529"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KAlarmCal::KAAlarm::KAAlarm </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06113">6113</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad64744b21b85362e360fa63343d3902e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KAlarmCal::KAAlarm::~KAAlarm </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06118">6118</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4ad6701b4b19502ec4d2c9611727fb18"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#a88c1ff85d1782100d60040aa53f3c0b2">KAAlarm::Action</a> KAlarmCal::KAAlarm::action </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the action type for the alarm. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06130">6130</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa161ef7a04853a1a1314d2ad11fa25e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDate KAlarmCal::KAAlarm::date </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the trigger date for the alarm. </p>
<p>Sub-repetitions are ignored: if a sub-repetition is due next, the last main recurrence will be returned instead. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06152">6152</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9b2cb98df3c13d77874fcf657cb5ff51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKAlarmCal_1_1DateTime.html">DateTime</a> KAlarmCal::KAAlarm::dateTime </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>withRepeats</em> = <code>false</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the trigger time for the alarm. </p>
<p>Sub-repetitions can optionally be ignored; in this case, if a sub-repetition is due next, the last main recurrence will be returned instead. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">withRepeats</td><td>if true, returns the next sub-repetition time where appropriate; if false, ignores sub-repetitions. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06145">6145</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a581975376009b0eef160e7c3d8e71a17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * KAlarmCal::KAAlarm::debugType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175">Type</a> </td>
<td class="paramname"><em>type</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 an alarm type as a string. </p>
<dl class="section return"><dt>Returns</dt><dd>alarm type string, or the empty string if debug output is disabled. </dd></dl>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06195">6195</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1dd29d24d75e841377924ca78ae453fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KAlarmCal::KAAlarm::deferred </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether this is a deferred alarm. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06172">6172</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a203db4d8be8f3afe6ef441b0375b75f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KAlarmCal::KAAlarm::isReminder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether this is a reminder alarm. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06167">6167</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a190c61b815e2ec65756c7112d28d3a27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KAlarmCal::KAAlarm::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether the alarm is valid, i.e. </p>
<p>whether it contains any alarm data. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06135">6135</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa35ef6a919404d7830f8d0dd3c8e2494"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a> & KAlarmCal::KAAlarm::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKAlarmCal_1_1KAAlarm.html">KAAlarm</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06123">6123</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a99d08e99fd55fd9e576f9f8ff90fe0c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KAlarmCal::KAAlarm::repeatAtLogin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether this is a repeat-at-login alarm. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06162">6162</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a33ebf7f95b1ec3afb83a1f09377ca178"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KAlarmCal::KAAlarm::setTime </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKAlarmCal_1_1DateTime.html">DateTime</a> & </td>
<td class="paramname"><em>dt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the alarm's trigger time. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06182">6182</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4339ce734fdf88f521bafe4fb9934f6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KAlarmCal::KAAlarm::setTime </td>
<td>(</td>
<td class="paramtype">const KDateTime & </td>
<td class="paramname"><em>dt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the alarm's trigger time. </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06187">6187</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ada49cd2ddd69d8f801282239633ef3ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QTime KAlarmCal::KAAlarm::time </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the trigger time-of-day for the alarm. </p>
<p>Sub-repetitions are ignored: if a sub-repetition is due next, the last main recurrence will be returned instead. </p>
<dl class="section return"><dt>Returns</dt><dd>trigger time-of-day. If the alarm is date-only, this will be the user-defined start-of-day time. </dd></dl>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06157">6157</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaab55a2ca61055c68898f6c6dfd45227"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KAlarmCal::KAAlarm::timedDeferral </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether in the case of a deferred alarm, it is timed (as opposed to date-only). </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a timed deferral alarm, <code>false</code> if date-only or not a deferred alarm. </dd></dl>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06177">6177</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7ead09ea7217109cb5e97260f321d39a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKAlarmCal_1_1KAAlarm.html#afae6ed98f38fddc638b3c2712bcaf175">KAAlarm::Type</a> KAlarmCal::KAAlarm::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the alarm's type (main, reminder, etc.). </p>
<p>Definition at line <a class="el" href="kaevent_8cpp_source.html#l06140">6140</a> of file <a class="el" href="kaevent_8cpp_source.html">kaevent.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kaevent_8h_source.html">kaevent.h</a></li>
<li><a class="el" href="kaevent_8cpp_source.html">kaevent.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:49:52 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">KAlarm Library</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "KAlarm 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="classKAlarmCal_1_1AlarmText.html">kalarmcal::alarmtext</option>, <option value="classKAlarmCal_1_1CollectionAttribute.html">kalarmcal::collectionattribute</option>, <option value="classKAlarmCal_1_1CompatibilityAttribute.html">kalarmcal::compatibilityattribute</option>, <option value="classKAlarmCal_1_1DateTime.html">kalarmcal::datetime</option>, <option value="classKAlarmCal_1_1EventAttribute.html">kalarmcal::eventattribute</option>, <option value="classKAlarmCal_1_1KAAlarm.html">kalarmcal::kaalarm</option>, <option value="classKAlarmCal_1_1KAEvent.html">kalarmcal::kaevent</option>, <option value="classKAlarmCal_1_1KARecurrence.html">kalarmcal::karecurrence</option>, <option value="classKAlarmCal_1_1Repetition.html">kalarmcal::repetition</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>
