harbour-boxing-timer/documentation/html/boxingtimer_8h_source.html

106 lines
28 KiB
HTML
Raw Normal View History

2017-08-21 21:04:30 +02:00
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Boxing Timer: src/boxingtimer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="harbour-boxing-timer.png"/></td>
2017-08-21 21:04:30 +02:00
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Boxing Timer
&#160;<span id="projectnumber">0.1a</span>
2017-08-21 21:04:30 +02:00
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">boxingtimer.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="boxingtimer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef BOXINGTIMER_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define BOXINGTIMER_H</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;QTimer&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;QString&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;QStringList&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifdef QT_DEBUG</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"> #include &lt;QDebug&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">class </span>QSound;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">class </span><a class="code" href="class_boxing_settings.html">BoxingSettings</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_boxing_timer.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_boxing_timer.html">BoxingTimer</a> : <span class="keyword">public</span> QTimer {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; Q_OBJECT</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; Q_ENUMS(<a class="code" href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558">Status</a>)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; Q_PROPERTY(QString <a class="code" href="class_boxing_timer.html#adddbecef36c86e650439141a7bf22ea4">remainingTimeToString</a> READ <a class="code" href="class_boxing_timer.html#adddbecef36c86e650439141a7bf22ea4">remainingTimeToString</a> NOTIFY <a class="code" href="class_boxing_timer.html#a3ef71d6ec54505732d9d5b96c5af1747">remainingTimeToStringChanged</a>)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; Q_PROPERTY(QString <a class="code" href="class_boxing_timer.html#a808ea8addb66a3a6f9270e56ed2518cf">roundsToString</a> READ <a class="code" href="class_boxing_timer.html#a808ea8addb66a3a6f9270e56ed2518cf">roundsToString</a> NOTIFY <a class="code" href="class_boxing_timer.html#a2c8d9c3c9916fc1ed65fb9545565835f">roundsToStringChanged</a>)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; Q_PROPERTY(<a class="code" href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558">Status</a> status READ <a class="code" href="class_boxing_timer.html#a091d7fb11525455766c19d6b9c250fa4">getStatus</a> WRITE <a class="code" href="class_boxing_timer.html#aa097f85ad7fd3602cc2583c3cc6c4d5e">setStatus</a> NOTIFY <a class="code" href="class_boxing_timer.html#ab3d16c454a2fac620bb84721c105485a">statusChanged</a>)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; Q_PROPERTY(<span cla
<div class="ttc" id="class_boxing_timer_html_ad5a57c7272222f91a75363bdad6543ba"><div class="ttname"><a href="class_boxing_timer.html#ad5a57c7272222f91a75363bdad6543ba">BoxingTimer::BoxingTimer</a></div><div class="ttdeci">BoxingTimer()</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:9</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481"><div class="ttname"><a href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481">BoxingTimer::Status::Stop</a></div></div>
<div class="ttc" id="class_boxing_timer_html_af8e0f0d2a34946e0a20562bfb187adbe"><div class="ttname"><a href="class_boxing_timer.html#af8e0f0d2a34946e0a20562bfb187adbe">BoxingTimer::loadPreset</a></div><div class="ttdeci">Q_INVOKABLE void loadPreset(const QString &amp;preset)</div><div class="ttdoc">Load the preset to change settings of timer. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:190</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_af2a4f0a0658b3685b2e0bcd965dca558a7a1920d61156abc05a60135aefe8bc67"><div class="ttname"><a href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a7a1920d61156abc05a60135aefe8bc67">BoxingTimer::Status::Default</a></div></div>
<div class="ttc" id="class_boxing_timer_html_adddbecef36c86e650439141a7bf22ea4"><div class="ttname"><a href="class_boxing_timer.html#adddbecef36c86e650439141a7bf22ea4">BoxingTimer::remainingTimeToString</a></div><div class="ttdeci">const QString remainingTimeToString()</div><div class="ttdoc">Convert remaining milliseconds in human readable time. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:155</div></div>
<div class="ttc" id="class_boxing_timer_html_a34f9e66cbe5bead806037a7ce882da4d"><div class="ttname"><a href="class_boxing_timer.html#a34f9e66cbe5bead806037a7ce882da4d">BoxingTimer::restore</a></div><div class="ttdeci">Q_INVOKABLE void restore()</div><div class="ttdoc">Start or restore the timer. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:169</div></div>
<div class="ttc" id="class_boxing_timer_html_aa294afc288608f91eb00d1680db67738"><div class="ttname"><a href="class_boxing_timer.html#aa294afc288608f91eb00d1680db67738">BoxingTimer::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Override of stop function to emit statusChanged() signal. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:56</div></div>
<div class="ttc" id="class_boxing_timer_html_a808ea8addb66a3a6f9270e56ed2518cf"><div class="ttname"><a href="class_boxing_timer.html#a808ea8addb66a3a6f9270e56ed2518cf">BoxingTimer::roundsToString</a></div><div class="ttdeci">const QString roundsToString()</div><div class="ttdoc">Convert round and total rounds for view. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:177</div></div>
<div class="ttc" id="class_boxing_timer_html_af2a4f0a0658b3685b2e0bcd965dca558"><div class="ttname"><a href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558">BoxingTimer::Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Define the status of the timer Some statuses are not saved, they are used to activate something...</div><div class="ttdef"><b>Definition:</b> boxingtimer.h:91</div></div>
<div class="ttc" id="class_boxing_timer_html_a64ae1d3a8bfe52b225658bf4121dcdfa"><div class="ttname"><a href="class_boxing_timer.html#a64ae1d3a8bfe52b225658bf4121dcdfa">BoxingTimer::start</a></div><div class="ttdeci">void start(const int &amp;milliseconds)</div><div class="ttdoc">Override of start function to emit statusChanged() signal. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:62</div></div>
<div class="ttc" id="class_boxing_timer_html_aa097f85ad7fd3602cc2583c3cc6c4d5e"><div class="ttname"><a href="class_boxing_timer.html#aa097f85ad7fd3602cc2583c3cc6c4d5e">BoxingTimer::setStatus</a></div><div class="ttdeci">void setStatus(const Status &amp;status)</div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:46</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_a4f2001335cd6249a350d87708b785de5"><div class="ttname"><a href="class_boxing_timer.html#a4f2001335cd6249a350d87708b785de5">BoxingTimer::activeChanged</a></div><div class="ttdeci">void activeChanged()</div></div>
<div class="ttc" id="class_boxing_timer_html_a2c8d9c3c9916fc1ed65fb9545565835f"><div class="ttname"><a href="class_boxing_timer.html#a2c8d9c3c9916fc1ed65fb9545565835f">BoxingTimer::roundsToStringChanged</a></div><div class="ttdeci">void roundsToStringChanged()</div></div>
<div class="ttc" id="class_boxing_timer_html_ab3d16c454a2fac620bb84721c105485a"><div class="ttname"><a href="class_boxing_timer.html#ab3d16c454a2fac620bb84721c105485a">BoxingTimer::statusChanged</a></div><div class="ttdeci">void statusChanged()</div></div>
<div class="ttc" id="class_boxing_timer_html_a091d7fb11525455766c19d6b9c250fa4"><div class="ttname"><a href="class_boxing_timer.html#a091d7fb11525455766c19d6b9c250fa4">BoxingTimer::getStatus</a></div><div class="ttdeci">Status getStatus()</div><div class="ttdef"><b>Definition:</b> boxingtimer.h:105</div></div>
<div class="ttc" id="class_boxing_timer_html_add8675aed0b0f7f2a90482456c63c8f3"><div class="ttname"><a href="class_boxing_timer.html#add8675aed0b0f7f2a90482456c63c8f3">BoxingTimer::applyStatus</a></div><div class="ttdeci">void applyStatus()</div><div class="ttdoc">Apply status and exec relative functions. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:68</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_a96dae97c68363403d732d74461d01499"><div class="ttname"><a href="class_boxing_timer.html#a96dae97c68363403d732d74461d01499">BoxingTimer::presetChanged</a></div><div class="ttdeci">void presetChanged()</div></div>
<div class="ttc" id="class_boxing_timer_html_a31cea07043d1be260db69767ccf96871"><div class="ttname"><a href="class_boxing_timer.html#a31cea07043d1be260db69767ccf96871">BoxingTimer::updateRemainingMilliseconds</a></div><div class="ttdeci">void updateRemainingMilliseconds()</div><div class="ttdoc">Switch milliseconds from round to rest and back. </div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:107</div></div>
<div class="ttc" id="class_boxing_settings_html"><div class="ttname"><a href="class_boxing_settings.html">BoxingSettings</a></div><div class="ttdoc">Handle settings about timer. Can save, load and delete a specific preset. </div><div class="ttdef"><b>Definition:</b> boxingsettings.h:20</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_af2a4f0a0658b3685b2e0bcd965dca558a105b296a83f9c105355403f3332af50f"><div class="ttname"><a href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a105b296a83f9c105355403f3332af50f">BoxingTimer::Status::Pause</a></div></div>
<div class="ttc" id="class_boxing_timer_html"><div class="ttname"><a href="class_boxing_timer.html">BoxingTimer</a></div><div class="ttdoc">Boxing timer class. </div><div class="ttdef"><b>Definition:</b> boxingtimer.h:27</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_a3ef71d6ec54505732d9d5b96c5af1747"><div class="ttname"><a href="class_boxing_timer.html#a3ef71d6ec54505732d9d5b96c5af1747">BoxingTimer::remainingTimeToStringChanged</a></div><div class="ttdeci">void remainingTimeToStringChanged()</div></div>
<div class="ttc" id="class_boxing_timer_html_aae9b18b16d38e1dd98a33ff0d0bed959"><div class="ttname"><a href="class_boxing_timer.html#aae9b18b16d38e1dd98a33ff0d0bed959">BoxingTimer::getPreset</a></div><div class="ttdeci">const QString getPreset()</div><div class="ttdef"><b>Definition:</b> boxingtimer.cpp:30</div></div>
2017-08-21 21:04:30 +02:00
<div class="ttc" id="class_boxing_timer_html_af2a4f0a0658b3685b2e0bcd965dca558a526d688f37a86d3c3f27d0c5016eb71d"><div class="ttname"><a href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a526d688f37a86d3c3f27d0c5016eb71d">BoxingTimer::Status::Reset</a></div></div>
<div class="ttc" id="class_boxing_timer_html_af2a4f0a0658b3685b2e0bcd965dca558a55276c10d84e1df7713b441e76e141f9"><div class="ttname"><a href="class_boxing_timer.html#af2a4f0a0658b3685b2e0bcd965dca558a55276c10d84e1df7713b441e76e141f9">BoxingTimer::Status::Rest</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>