class_q_alarms.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>QAlarm: QAlarms Class Reference</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javaScript" src="search/search.js"></script>
  9. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10. </head>
  11. <body onload='searchBox.OnSelectItem(0);'>
  12. <!-- Generated by Doxygen 1.7.1 -->
  13. <script type="text/javascript"><!--
  14. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15. --></script>
  16. <div class="navigation" id="top">
  17. <div class="tabs">
  18. <ul class="tablist">
  19. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  20. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  21. <li><a href="files.html"><span>Files</span></a></li>
  22. <li id="searchli">
  23. <div id="MSearchBox" class="MSearchBoxInactive">
  24. <span class="left">
  25. <img id="MSearchSelect" src="search/mag_sel.png"
  26. onmouseover="return searchBox.OnSearchSelectShow()"
  27. onmouseout="return searchBox.OnSearchSelectHide()"
  28. alt=""/>
  29. <input type="text" id="MSearchField" value="Search" accesskey="S"
  30. onfocus="searchBox.OnSearchFieldFocus(true)"
  31. onblur="searchBox.OnSearchFieldFocus(false)"
  32. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  33. </span><span class="right">
  34. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  35. </span>
  36. </div>
  37. </li>
  38. </ul>
  39. </div>
  40. <div class="tabs2">
  41. <ul class="tablist">
  42. <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  43. <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
  44. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  45. </ul>
  46. </div>
  47. </div>
  48. <div class="header">
  49. <div class="summary">
  50. <a href="#pub-types">Public Types</a> &#124;
  51. <a href="#pub-methods">Public Member Functions</a> </div>
  52. <div class="headertitle">
  53. <h1>QAlarms Class Reference</h1> </div>
  54. </div>
  55. <div class="contents">
  56. <!-- doxytag: class="QAlarms" -->
  57. <p>The <a class="el" href="class_q_alarms.html" title="The QAlarms class can be used to set, remove and modifying alarms.">QAlarms</a> class can be used to set, remove and modifying alarms.
  58. <a href="#_details">More...</a></p>
  59. <p><a href="class_q_alarms-members.html">List of all members.</a></p>
  60. <table class="memberdecls">
  61. <tr><td colspan="2"><h2><a name="pub-types"></a>
  62. Public Types</h2></td></tr>
  63. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">Error</a> { <br/>
  64. &nbsp;&nbsp;<a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641aed61c121138ed9a576e4f45776039813">NoError</a> = 0,
  65. <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641a3b462e3e8c58211c88a13711aeace4ea">OutOfMemoryError</a>,
  66. <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641a77fcea46be54bce17ced56926eb2c5a8">NotFoundError</a>,
  67. <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641a6a62ccbec971aad43d561502ce9284cf">CouldNotConnectError</a>,
  68. <br/>
  69. &nbsp;&nbsp;<a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641ac6e8a2f09fae66dc22570249f1ccfa76">AccessDeniedError</a>,
  70. <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641afd3af8ab3ba9860c27055bc24773b986">UnknownError</a> = -1
  71. <br/>
  72. }</td></tr>
  73. <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>Weekday</b> { <br/>
  74. &nbsp;&nbsp;<b>Monday</b> = 1,
  75. <b>Tuesday</b> = 2,
  76. <b>Wednesday</b> = 4,
  77. <b>Thursday</b> = 8,
  78. <br/>
  79. &nbsp;&nbsp;<b>Friday</b> = 16,
  80. <b>Saturday</b> = 32,
  81. <b>Sunday</b> = 64
  82. <br/>
  83. }</td></tr>
  84. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  85. Public Member Functions</h2></td></tr>
  86. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a41577cc0e9ab11d9f60eb4597cbc1bfc">QAlarms</a> (QObject *parent=0)</td></tr>
  87. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a2af1d9fecfc4cf6b64db4945e7cbe738">~QAlarms</a> ()</td></tr>
  88. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_q_alarm.html">QAlarm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#aa4d40972e7edcd41341817a2b2ed9430">alarm</a> (int alarmId) const </td></tr>
  89. <tr><td class="memItemLeft" align="right" valign="top">QList&lt; int &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a3ba9bb44f81b5350da5bc8bf7222beda">alarmIds</a> () const </td></tr>
  90. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a0ff12e30a134eecce5acd7bba02198bb">addAlarm</a> (<a class="el" href="class_q_alarm.html">QAlarm</a> &amp;alarmData)</td></tr>
  91. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a216ba96e3020b79979b7ac57199f1d11">deleteAlarm</a> (int alarmId)</td></tr>
  92. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a22ad1f3f0ed98965f06bc0d109a1378c">setEnabled</a> (int alarmId, bool status)</td></tr>
  93. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#a61a6e54e015bad8c54cb13c890eb9107">isEnabled</a> (int alarmId) const </td></tr>
  94. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error</a> () const </td></tr>
  95. </table>
  96. <hr/><a name="_details"></a><h2>Detailed Description</h2>
  97. <p>The <a class="el" href="class_q_alarms.html" title="The QAlarms class can be used to set, remove and modifying alarms.">QAlarms</a> class can be used to set, remove and modifying alarms. </p>
  98. <p>The <a class="el" href="class_q_alarm.html">QAlarm</a> class stores alarm data. If category is not set, default value is clock alarm. </p>
  99. <hr/><h2>Member Enumeration Documentation</h2>
  100. <a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641"></a><!-- doxytag: member="QAlarms::Error" ref="afe9c89b1d64c2a729a3c506fa1766641" args="" -->
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname">enum <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a></td>
  106. </tr>
  107. </table>
  108. </div>
  109. <div class="memdoc">
  110. <p>This enum defines the possible errors for a <a class="el" href="class_q_alarms.html" title="The QAlarms class can be used to set, remove and modifying alarms.">QAlarms</a> object. </p>
  111. <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
  112. <tr><td valign="top"><em><a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641aed61c121138ed9a576e4f45776039813"></a><!-- doxytag: member="NoError" ref="afe9c89b1d64c2a729a3c506fa1766641aed61c121138ed9a576e4f45776039813" args="" -->NoError</em>&nbsp;</td><td>
  113. <p>No error occured. </p>
  114. </td></tr>
  115. <tr><td valign="top"><em><a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641a3b462e3e8c58211c88a13711aeace4ea"></a><!-- doxytag: member="OutOfMemoryError" ref="afe9c89b1d64c2a729a3c506fa1766641a3b462e3e8c58211c88a13711aeace4ea" args="" -->OutOfMemoryError</em>&nbsp;</td><td>
  116. <p>Not enough memory. </p>
  117. </td></tr>
  118. <tr><td valign="top"><em><a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641a77fcea46be54bce17ced56926eb2c5a8"></a><!-- doxytag: member="NotFoundError" ref="afe9c89b1d64c2a729a3c506fa1766641a77fcea46be54bce17ced56926eb2c5a8" args="" -->NotFoundError</em>&nbsp;</td><td>
  119. <p>Not enough memory. </p>
  120. </td></tr>
  121. <tr><td valign="top"><em><a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641a6a62ccbec971aad43d561502ce9284cf"></a><!-- doxytag: member="CouldNotConnectError" ref="afe9c89b1d64c2a729a3c506fa1766641a6a62ccbec971aad43d561502ce9284cf" args="" -->CouldNotConnectError</em>&nbsp;</td><td>
  122. <p>Not enough memory. </p>
  123. </td></tr>
  124. <tr><td valign="top"><em><a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641ac6e8a2f09fae66dc22570249f1ccfa76"></a><!-- doxytag: member="AccessDeniedError" ref="afe9c89b1d64c2a729a3c506fa1766641ac6e8a2f09fae66dc22570249f1ccfa76" args="" -->AccessDeniedError</em>&nbsp;</td><td>
  125. <p>Not enough memory. </p>
  126. </td></tr>
  127. <tr><td valign="top"><em><a class="anchor" id="afe9c89b1d64c2a729a3c506fa1766641afd3af8ab3ba9860c27055bc24773b986"></a><!-- doxytag: member="UnknownError" ref="afe9c89b1d64c2a729a3c506fa1766641afd3af8ab3ba9860c27055bc24773b986" args="" -->UnknownError</em>&nbsp;</td><td>
  128. <p>Unknown error. </p>
  129. </td></tr>
  130. </table>
  131. </dd>
  132. </dl>
  133. </div>
  134. </div>
  135. <hr/><h2>Constructor &amp; Destructor Documentation</h2>
  136. <a class="anchor" id="a41577cc0e9ab11d9f60eb4597cbc1bfc"></a><!-- doxytag: member="QAlarms::QAlarms" ref="a41577cc0e9ab11d9f60eb4597cbc1bfc" args="(QObject *parent=0)" -->
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">QAlarms::QAlarms </td>
  142. <td>(</td>
  143. <td class="paramtype">QObject *&nbsp;</td>
  144. <td class="paramname"> <em>parent</em> = <code>0</code></td>
  145. <td>&nbsp;)&nbsp;</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </div>
  150. <div class="memdoc">
  151. <p>Constructs an <a class="el" href="class_q_alarms.html" title="The QAlarms class can be used to set, remove and modifying alarms.">QAlarms</a> object with the given parent.</p>
  152. <p>Call <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> to get a value of <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a> that indicates if an error occurred during construction. </p>
  153. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> </dd></dl>
  154. </div>
  155. </div>
  156. <a class="anchor" id="a2af1d9fecfc4cf6b64db4945e7cbe738"></a><!-- doxytag: member="QAlarms::~QAlarms" ref="a2af1d9fecfc4cf6b64db4945e7cbe738" args="()" -->
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">QAlarms::~QAlarms </td>
  162. <td>(</td>
  163. <td class="paramname"></td>
  164. <td>&nbsp;)&nbsp;</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </div>
  169. <div class="memdoc">
  170. <p>Destroys the <a class="el" href="class_q_alarms.html" title="The QAlarms class can be used to set, remove and modifying alarms.">QAlarms</a> object. </p>
  171. </div>
  172. </div>
  173. <hr/><h2>Member Function Documentation</h2>
  174. <a class="anchor" id="a0ff12e30a134eecce5acd7bba02198bb"></a><!-- doxytag: member="QAlarms::addAlarm" ref="a0ff12e30a134eecce5acd7bba02198bb" args="(QAlarm &amp;alarmData)" -->
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">bool QAlarms::addAlarm </td>
  180. <td>(</td>
  181. <td class="paramtype"><a class="el" href="class_q_alarm.html">QAlarm</a> &amp;&nbsp;</td>
  182. <td class="paramname"> <em>alarmData</em></td>
  183. <td>&nbsp;)&nbsp;</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div>
  188. <div class="memdoc">
  189. <p>This sets an alarm. If the <a class="el" href="class_q_alarm.html">QAlarm</a> cataegory is not set, the alarm category is set to KClockAlarm. On return, alarm gets an unique identifier to identify the alarm.</p>
  190. <dl><dt><b>Parameters:</b></dt><dd>
  191. <table border="0" cellspacing="2" cellpadding="0">
  192. <tr><td valign="top"></td><td valign="top"><em>alarmData</em>&nbsp;</td><td>An <a class="el" href="class_q_alarm.html">QAlarm</a> object </td></tr>
  193. </table>
  194. </dd>
  195. </dl>
  196. <dl class="return"><dt><b>Returns:</b></dt><dd>If false is returned, an error has occurred. Call <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> to get the <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a> value that indicates which error occurred </dd></dl>
  197. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#a216ba96e3020b79979b7ac57199f1d11">deleteAlarm()</a>, <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> </dd></dl>
  198. </div>
  199. </div>
  200. <a class="anchor" id="aa4d40972e7edcd41341817a2b2ed9430"></a><!-- doxytag: member="QAlarms::alarm" ref="aa4d40972e7edcd41341817a2b2ed9430" args="(int alarmId) const " -->
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname"><a class="el" href="class_q_alarm.html">QAlarm</a> QAlarms::alarm </td>
  206. <td>(</td>
  207. <td class="paramtype">int&nbsp;</td>
  208. <td class="paramname"> <em>alarmId</em></td>
  209. <td>&nbsp;)&nbsp;</td>
  210. <td> const</td>
  211. </tr>
  212. </table>
  213. </div>
  214. <div class="memdoc">
  215. <p>Gets the alarm specified by the alarmId</p>
  216. <dl><dt><b>Parameters:</b></dt><dd>
  217. <table border="0" cellspacing="2" cellpadding="0">
  218. <tr><td valign="top"></td><td valign="top"><em>alarmId</em>&nbsp;</td><td>Alarm's id </td></tr>
  219. </table>
  220. </dd>
  221. </dl>
  222. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="class_q_alarm.html">QAlarm</a> object </dd></dl>
  223. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#a3ba9bb44f81b5350da5bc8bf7222beda">alarmIds</a> </dd></dl>
  224. </div>
  225. </div>
  226. <a class="anchor" id="a3ba9bb44f81b5350da5bc8bf7222beda"></a><!-- doxytag: member="QAlarms::alarmIds" ref="a3ba9bb44f81b5350da5bc8bf7222beda" args="() const " -->
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">QList&lt; int &gt; QAlarms::alarmIds </td>
  232. <td>(</td>
  233. <td class="paramname"></td>
  234. <td>&nbsp;)&nbsp;</td>
  235. <td> const</td>
  236. </tr>
  237. </table>
  238. </div>
  239. <div class="memdoc">
  240. <p>This function returns the list of Alarm Id list.</p>
  241. <p>Note: Function may occur an error. Call <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> to get the <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a> value that indicates which error occurred</p>
  242. <dl class="return"><dt><b>Returns:</b></dt><dd>List of alarm ids </dd></dl>
  243. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> </dd></dl>
  244. </div>
  245. </div>
  246. <a class="anchor" id="a216ba96e3020b79979b7ac57199f1d11"></a><!-- doxytag: member="QAlarms::deleteAlarm" ref="a216ba96e3020b79979b7ac57199f1d11" args="(int alarmId)" -->
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">bool QAlarms::deleteAlarm </td>
  252. <td>(</td>
  253. <td class="paramtype">int&nbsp;</td>
  254. <td class="paramname"> <em>alarmId</em></td>
  255. <td>&nbsp;)&nbsp;</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </div>
  260. <div class="memdoc">
  261. <p>Removes the alarm with given id.</p>
  262. <dl><dt><b>Parameters:</b></dt><dd>
  263. <table border="0" cellspacing="2" cellpadding="0">
  264. <tr><td valign="top"></td><td valign="top"><em>alarmId</em>&nbsp;</td><td>Alarm to be removed </td></tr>
  265. </table>
  266. </dd>
  267. </dl>
  268. <dl class="return"><dt><b>Returns:</b></dt><dd>If false is returned, an error has occurred. Call <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> to get the <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a> value that indicates which error occurred </dd></dl>
  269. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#a0ff12e30a134eecce5acd7bba02198bb">addAlarm()</a>, <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> </dd></dl>
  270. </div>
  271. </div>
  272. <a class="anchor" id="ab03d18140375234a84e253b6e595a602"></a><!-- doxytag: member="QAlarms::error" ref="ab03d18140375234a84e253b6e595a602" args="() const " -->
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a> QAlarms::error </td>
  278. <td>(</td>
  279. <td class="paramname"></td>
  280. <td>&nbsp;)&nbsp;</td>
  281. <td> const</td>
  282. </tr>
  283. </table>
  284. </div>
  285. <div class="memdoc">
  286. <dl class="return"><dt><b>Returns:</b></dt><dd>The type of error that occurred when the last function call failed, otherwise returns NoError. </dd></dl>
  287. </div>
  288. </div>
  289. <a class="anchor" id="a61a6e54e015bad8c54cb13c890eb9107"></a><!-- doxytag: member="QAlarms::isEnabled" ref="a61a6e54e015bad8c54cb13c890eb9107" args="(int alarmId) const " -->
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="memname">
  293. <tr>
  294. <td class="memname">bool QAlarms::isEnabled </td>
  295. <td>(</td>
  296. <td class="paramtype">int&nbsp;</td>
  297. <td class="paramname"> <em>alarmId</em></td>
  298. <td>&nbsp;)&nbsp;</td>
  299. <td> const</td>
  300. </tr>
  301. </table>
  302. </div>
  303. <div class="memdoc">
  304. <dl><dt><b>Parameters:</b></dt><dd>
  305. <table border="0" cellspacing="2" cellpadding="0">
  306. <tr><td valign="top"></td><td valign="top"><em>alarmId</em>&nbsp;</td><td>Alarm id to find the status of </td></tr>
  307. </table>
  308. </dd>
  309. </dl>
  310. <dl class="return"><dt><b>Returns:</b></dt><dd>True if the alarm is enabled, otherwise false.</dd></dl>
  311. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#a22ad1f3f0ed98965f06bc0d109a1378c">setEnabled()</a> </dd></dl>
  312. </div>
  313. </div>
  314. <a class="anchor" id="a22ad1f3f0ed98965f06bc0d109a1378c"></a><!-- doxytag: member="QAlarms::setEnabled" ref="a22ad1f3f0ed98965f06bc0d109a1378c" args="(int alarmId, bool status)" -->
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">bool QAlarms::setEnabled </td>
  320. <td>(</td>
  321. <td class="paramtype">int&nbsp;</td>
  322. <td class="paramname"> <em>alarmId</em>, </td>
  323. </tr>
  324. <tr>
  325. <td class="paramkey"></td>
  326. <td></td>
  327. <td class="paramtype">bool&nbsp;</td>
  328. <td class="paramname"> <em>status</em></td><td>&nbsp;</td>
  329. </tr>
  330. <tr>
  331. <td></td>
  332. <td>)</td>
  333. <td></td><td></td><td></td>
  334. </tr>
  335. </table>
  336. </div>
  337. <div class="memdoc">
  338. <p>This sets an alarm to be enabled or disabled.</p>
  339. <dl><dt><b>Parameters:</b></dt><dd>
  340. <table border="0" cellspacing="2" cellpadding="0">
  341. <tr><td valign="top"></td><td valign="top"><em>alarmId</em>&nbsp;</td><td>The id of the alarm to enable or disable </td></tr>
  342. <tr><td valign="top"></td><td valign="top"><em>status</em>&nbsp;</td><td>Sets the alarm's next due time. </td></tr>
  343. </table>
  344. </dd>
  345. </dl>
  346. <dl class="return"><dt><b>Returns:</b></dt><dd>If false is returned, an error has occurred. Call <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> to get the <a class="el" href="class_q_alarms.html#afe9c89b1d64c2a729a3c506fa1766641">QAlarms::Error</a> value that indicates which error occurred </dd></dl>
  347. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_q_alarms.html#a61a6e54e015bad8c54cb13c890eb9107">isEnabled()</a>, <a class="el" href="class_q_alarms.html#ab03d18140375234a84e253b6e595a602">error()</a> </dd></dl>
  348. </div>
  349. </div>
  350. <hr/>The documentation for this class was generated from the following files:<ul>
  351. <li><a class="el" href="qalarm_8h_source.html">qalarm.h</a></li>
  352. <li>qalarm.cpp</li>
  353. </ul>
  354. </div>
  355. <!--- window showing the filter options -->
  356. <div id="MSearchSelectWindow"
  357. onmouseover="return searchBox.OnSearchSelectShow()"
  358. onmouseout="return searchBox.OnSearchSelectHide()"
  359. onkeydown="return searchBox.OnSearchSelectKey(event)">
  360. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
  361. <!-- iframe showing the search results (closed by default) -->
  362. <div id="MSearchResultsWindow">
  363. <iframe src="" frameborder="0"
  364. name="MSearchResults" id="MSearchResults">
  365. </iframe>
  366. </div>
  367. <hr class="footer"/><address class="footer"><small>Generated on Tue Apr 24 2012 16:22:24 for QAlarm by&nbsp;
  368. <a href="http://www.doxygen.org/index.html">
  369. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
  370. </body>
  371. </html>