599b4f041bdfd97422fda798a847bf8a1ee4aa7c
[chessclock] / www / html / chessclock_8h_source.html
1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <title>Chess Clock: /holvi/arto/ohjelmointi/ChessClock/chessclock/classes/chessclock.h Source File</title>
7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javaScript" src="search/search.js"></script>
10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
11 </head>
12 <body onload='searchBox.OnSelectItem(0);'>
13 <!-- Generated by Doxygen 1.6.3 -->
14 <script type="text/javascript"><!--
15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
16 --></script>
17 <div class="navigation" id="top">
18   <div class="tabs">
19     <ul>
20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
21       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
22       <li><a href="annotated.html"><span>Classes</span></a></li>
23       <li class="current"><a href="files.html"><span>Files</span></a></li>
24       <li>
25         <div id="MSearchBox" class="MSearchBoxInactive">
26         <img id="MSearchSelect" src="search/search.png"
27              onmouseover="return searchBox.OnSearchSelectShow()"
28              onmouseout="return searchBox.OnSearchSelectHide()"
29              alt=""/>
30         <input type="text" id="MSearchField" value="Search" accesskey="S"
31              onfocus="searchBox.OnSearchFieldFocus(true)" 
32              onblur="searchBox.OnSearchFieldFocus(false)" 
33              onkeyup="searchBox.OnSearchFieldChange(event)"/>
34         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
35         </div>
36       </li>
37     </ul>
38   </div>
39   <div class="tabs">
40     <ul>
41       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
42       <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
43     </ul>
44   </div>
45 <h1>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/chessclock.h</h1><a href="chessclock_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001  <span class="comment">/**************************************************************************</span>
46 <a name="l00002"></a>00002 <span class="comment"></span>
47 <a name="l00003"></a>00003 <span class="comment">    Chess Clock</span>
48 <a name="l00004"></a>00004 <span class="comment"></span>
49 <a name="l00005"></a>00005 <span class="comment">    Copyright (c) Arto Hyvättinen 2010</span>
50 <a name="l00006"></a>00006 <span class="comment"></span>
51 <a name="l00007"></a>00007 <span class="comment">    This file is part of Chess Clock software.</span>
52 <a name="l00008"></a>00008 <span class="comment"></span>
53 <a name="l00009"></a>00009 <span class="comment">    Chess Clock is free software: you can redistribute it and/or modify</span>
54 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
55 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
56 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
57 <a name="l00013"></a>00013 <span class="comment"></span>
58 <a name="l00014"></a>00014 <span class="comment">    Chess Clock is distributed in the hope that it will be useful,</span>
59 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
60 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
61 <a name="l00017"></a>00017 <span class="comment">    GNU General Public License for more details.</span>
62 <a name="l00018"></a>00018 <span class="comment"></span>
63 <a name="l00019"></a>00019 <span class="comment"></span>
64 <a name="l00020"></a>00020 <span class="comment">**************************************************************************/</span>
65 <a name="l00021"></a>00021 
66 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef CHESSCLOCK_H</span>
67 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define CHESSCLOCK_H</span>
68 <a name="l00024"></a>00024 <span class="preprocessor"></span>
69 <a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QWidget&gt;</span>
70 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QTime&gt;</span>
71 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QTimer&gt;</span>
72 <a name="l00028"></a>00028 
73 <a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="class_turn_information.html" title="Turn information class.">TurnInformation</a>;
74 <a name="l00030"></a>00030 
75 <a name="l00031"></a>00031 
76 <a name="l00043"></a><a class="code" href="class_chess_clock.html">00043</a> <span class="keyword">class </span><a class="code" href="class_chess_clock.html" title="Clock of a individual player.">ChessClock</a> : <span class="keyword">public</span> QWidget
77 <a name="l00044"></a>00044 {
78 <a name="l00045"></a>00045     Q_OBJECT
79 <a name="l00046"></a>00046 <span class="keyword">public</span>:
80 <a name="l00047"></a>00047     <a class="code" href="class_chess_clock.html#af4d3718b1e746317749bbb992688dcd8">ChessClock</a>(<span class="keywordtype">bool</span> white, QWidget *parent = 0);
81 <a name="l00048"></a>00048 
82 <a name="l00049"></a>00049 <span class="keyword">public</span>:
83 <a name="l00050"></a><a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28">00050</a>     <span class="keyword">enum</span> <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28">RunningStatus</a> {
84 <a name="l00051"></a><a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28a62801e3ac4d8e7f2889090525598b181">00051</a>         <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28a62801e3ac4d8e7f2889090525598b181" title="Not turn.">NotRunning</a>  = 0,
85 <a name="l00052"></a><a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28ac717f6fe8e135ffff8153ec7d5b2b36c">00052</a>         <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28ac717f6fe8e135ffff8153ec7d5b2b36c" title="Turn running.">Running</a>  = 1,
86 <a name="l00053"></a><a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28a71899c98710fe6d3a18a5d3f1029e9d9">00053</a>         <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28a71899c98710fe6d3a18a5d3f1029e9d9" title="Turn paused.">Paused</a>  = 2
87 <a name="l00054"></a>00054     };
88 <a name="l00055"></a>00055 
89 <a name="l00056"></a><a class="code" href="class_chess_clock.html#a8ee162da0545410332d3fc1c4696b64a">00056</a>     <span class="keywordtype">bool</span> <a class="code" href="class_chess_clock.html#a8ee162da0545410332d3fc1c4696b64a">isLoser</a>()<span class="keyword"> const  </span>{ <span class="keywordflow">return</span> <a class="code" href="class_chess_clock.html#a4ed94dc49d57927eb518c3e7d93718b1" title="Another player&amp;#39;s clock.">loser_</a>; }
90 <a name="l00057"></a><a class="code" href="class_chess_clock.html#ad250dc2ff1f62f2c984e1925d30c1956">00057</a>     <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#ad250dc2ff1f62f2c984e1925d30c1956">getTurn</a>()<span class="keyword"> const  </span>{ <span class="keywordflow">return</span> <a class="code" href="class_chess_clock.html#aba90e7b968a5d27fc8653f7690344f8d" title="Is player losed because of timeout.">turn_</a>; }
91 <a name="l00058"></a><a class="code" href="class_chess_clock.html#a87c8761d7b25ef31764a3e173b9645c1">00058</a>     <span class="keywordtype">bool</span> <a class="code" href="class_chess_clock.html#a87c8761d7b25ef31764a3e173b9645c1">isWhite</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_chess_clock.html#a844453fc4683c62d24b53b70fb68c1a9" title="Time available for play BEFORE this turn msecs !">isWhite_</a>; }
92 <a name="l00059"></a><a class="code" href="class_chess_clock.html#a8988e92a321e25d52dc00552b4d44a4d">00059</a>     <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28">RunningStatus</a> <a class="code" href="class_chess_clock.html#a8988e92a321e25d52dc00552b4d44a4d">getStatus</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_chess_clock.html#ad2d4601fbc0dae0599a95ce7924c9902" title="Current turn.">status_</a> ; }
93 <a name="l00060"></a>00060 
94 <a name="l00061"></a>00061 
95 <a name="l00063"></a>00063     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a49504d86896ef3f724b2aa481c85435a" title="Start new turn.">startTurn</a>();
96 <a name="l00064"></a>00064 
97 <a name="l00069"></a>00069     <span class="keyword">virtual</span> <a class="code" href="class_turn_information.html" title="Turn information class.">TurnInformation</a>* <a class="code" href="class_chess_clock.html#a2383619532d2e9e6557961616c722531" title="End this turn.">endTurn</a>();
98 <a name="l00070"></a>00070 
99 <a name="l00072"></a>00072     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a461145515ab3854c079937143026a047" title="Pause clock.">pauseTurn</a>();
100 <a name="l00073"></a>00073 
101 <a name="l00075"></a>00075     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#ae0686cb1be507be4c7c411898ba52495" title="Continue paused game.">continueTurn</a>();
102 <a name="l00076"></a>00076 
103 <a name="l00079"></a>00079     <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#aa19330404a35872591d45d24fb52572e" title="Set another chess clock for connecting.">setAnother</a>( <a class="code" href="class_chess_clock.html" title="Clock of a individual player.">ChessClock</a>* another);
104 <a name="l00080"></a>00080 
105 <a name="l00086"></a>00086     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#a8e7d214dcc13dcd1087d2281fe96ce16" title="Get total time available.">getTimeAvailable</a>();
106 <a name="l00087"></a>00087 
107 <a name="l00090"></a>00090     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#a4bc0dedc29db4e121424b83605a3ec1b" title="Get total time played.">getTimePlayed</a>();
108 <a name="l00091"></a>00091 
109 <a name="l00095"></a>00095     <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#af0415d0184abb73d9ee3348635c3e0d8" title="Set time available.">setTimeAvailable</a>(<span class="keywordtype">int</span> msecs);
110 <a name="l00096"></a>00096 
111 <a name="l00103"></a>00103     <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a7726be810822d28f039252e29e8377d5" title="Add time.">addTime</a>(<span class="keywordtype">int</span> msecs);
112 <a name="l00104"></a>00104 
113 <a name="l00107"></a>00107     <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#a781fff762250f63de87d12f5d88ae5ed" title="Get time played current turn.">currentTurnPlayed</a>();
114 <a name="l00108"></a>00108 
115 <a name="l00109"></a>00109 
116 <a name="l00110"></a>00110 signals:
117 <a name="l00111"></a>00111     <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a9406ad0b60047e6605cf3e41c8a47b13">timeOutLoser</a>();
118 <a name="l00112"></a>00112     <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a832bb1a623c56078c91be7d67b12dea9">turnEnded</a>();
119 <a name="l00113"></a>00113 
120 <a name="l00114"></a>00114 <span class="keyword">public</span> slots:    
121 <a name="l00115"></a>00115 
122 <a name="l00117"></a>00117     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a349c7c108551649a9885651c5470e2dd" title="Refresh clock information.">repaintClock</a>() = 0;
123 <a name="l00118"></a>00118 
124 <a name="l00120"></a>00120     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a2262f5bb09794ef7a40c62c0c28a6979" title="Update clock information, check looser state and refresh.">updateClock</a>();
125 <a name="l00121"></a>00121 
126 <a name="l00122"></a>00122 <span class="keyword">protected</span>:
127 <a name="l00123"></a><a class="code" href="class_chess_clock.html#a2ec3c0ed0a5e9bee6bd0864c5c9e4452">00123</a>     <a class="code" href="class_chess_clock.html" title="Clock of a individual player.">ChessClock</a>* <a class="code" href="class_chess_clock.html#a2ec3c0ed0a5e9bee6bd0864c5c9e4452">another_</a>; 
128 <a name="l00125"></a><a class="code" href="class_chess_clock.html#a4ed94dc49d57927eb518c3e7d93718b1">00125</a>     <span class="keywordtype">bool</span> <a class="code" href="class_chess_clock.html#a4ed94dc49d57927eb518c3e7d93718b1" title="Another player&amp;#39;s clock.">loser_</a>;        
129 <a name="l00126"></a><a class="code" href="class_chess_clock.html#aba90e7b968a5d27fc8653f7690344f8d">00126</a>     <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#aba90e7b968a5d27fc8653f7690344f8d" title="Is player losed because of timeout.">turn_</a>;          
130 <a name="l00127"></a><a class="code" href="class_chess_clock.html#ad2d4601fbc0dae0599a95ce7924c9902">00127</a>     <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28">RunningStatus</a> <a class="code" href="class_chess_clock.html#ad2d4601fbc0dae0599a95ce7924c9902" title="Current turn.">status_</a>;
131 <a name="l00128"></a><a class="code" href="class_chess_clock.html#a0eb205f7484c7cf2a0be1f8bec78bf68">00128</a>     <a class="code" href="class_turn_information.html" title="Turn information class.">TurnInformation</a>* <a class="code" href="class_chess_clock.html#a0eb205f7484c7cf2a0be1f8bec78bf68">currentTurn_</a>;
132 <a name="l00129"></a>00129 
133 <a name="l00130"></a><a class="code" href="class_chess_clock.html#a373e5774a0af5387c76006a1a24d770e">00130</a>     <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#a373e5774a0af5387c76006a1a24d770e">timePlayedBeforeTurn_</a>;    
134 <a name="l00131"></a><a class="code" href="class_chess_clock.html#abbce62e8c796244cadb1a5413469ca1b">00131</a>     <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#abbce62e8c796244cadb1a5413469ca1b" title="Time played in this game BEFORE this turn msecs.">timeAvailableBeforeTurn_</a>; 
135 <a name="l00133"></a><a class="code" href="class_chess_clock.html#a844453fc4683c62d24b53b70fb68c1a9">00133</a>     <span class="keywordtype">bool</span> <a class="code" href="class_chess_clock.html#a844453fc4683c62d24b53b70fb68c1a9" title="Time available for play BEFORE this turn msecs !">isWhite_</a>;      
136 <a name="l00135"></a><a class="code" href="class_chess_clock.html#ae25ff9bfd3ccb8651b3e7890e712d1be">00135</a>     QTime <a class="code" href="class_chess_clock.html#ae25ff9bfd3ccb8651b3e7890e712d1be" title="True if white player.">clockTime_</a>;
137 <a name="l00136"></a><a class="code" href="class_chess_clock.html#a3493e745462457ebf5660754fe333fd2">00136</a>     QTimer <a class="code" href="class_chess_clock.html#a3493e745462457ebf5660754fe333fd2">updateTimer_</a>;
138 <a name="l00137"></a>00137 
139 <a name="l00138"></a><a class="code" href="class_chess_clock.html#a848e42d72b3470578f0f958106894b4f">00138</a>     <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#a848e42d72b3470578f0f958106894b4f">UPDATEINTERVAL</a> = 1000; 
140 <a name="l00140"></a>00140 };
141 <a name="l00141"></a>00141 
142 <a name="l00142"></a>00142 <span class="preprocessor">#endif // CHESSCLOCK_H</span>
143 </pre></div></div>
144 <!--- window showing the filter options -->
145 <div id="MSearchSelectWindow"
146      onmouseover="return searchBox.OnSearchSelectShow()"
147      onmouseout="return searchBox.OnSearchSelectHide()"
148      onkeydown="return searchBox.OnSearchSelectKey(event)">
149 <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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
150
151 <!-- iframe showing the search results (closed by default) -->
152 <div id="MSearchResultsWindow">
153 <iframe src="" frameborder="0" 
154         name="MSearchResults" id="MSearchResults">
155 </iframe>
156 </div>
157
158 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 16 21:44:24 2010 for Chess Clock by&nbsp;
159 <a href="http://www.doxygen.org/index.html">
160 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
161 </body>
162 </html>