git.maemo.org Git - chessclock/blob - 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="annotated.html"><span>Classes</span></a></li>
  22       <li class="current"><a href="files.html"><span>Files</span></a></li>
  23       <li>
  24         <div id="MSearchBox" class="MSearchBoxInactive">
  25         <img id="MSearchSelect" src="search/search.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         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  34         </div>
  35       </li>
  36     </ul>
  37   </div>
  38   <div class="tabs">
  39     <ul>
  40       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  41       <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
  42     </ul>
  43   </div>
  44 <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>
  45 <a name="l00002"></a>00002 <span class="comment"></span>
  46 <a name="l00003"></a>00003 <span class="comment">    Chess Clock</span>
  47 <a name="l00004"></a>00004 <span class="comment"></span>
  48 <a name="l00005"></a>00005 <span class="comment">    Copyright (c) Arto Hyvättinen 2010</span>
  49 <a name="l00006"></a>00006 <span class="comment"></span>
  50 <a name="l00007"></a>00007 <span class="comment">    This file is part of Chess Clock software.</span>
  51 <a name="l00008"></a>00008 <span class="comment"></span>
  52 <a name="l00009"></a>00009 <span class="comment">    Chess Clock is free software: you can redistribute it and/or modify</span>
  53 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  54 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation, either version 3 of the License, or</span>
  55 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  56 <a name="l00013"></a>00013 <span class="comment"></span>
  57 <a name="l00014"></a>00014 <span class="comment">    Chess Clock is distributed in the hope that it will be useful,</span>
  58 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  59 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  60 <a name="l00017"></a>00017 <span class="comment">    GNU General Public License for more details.</span>
  61 <a name="l00018"></a>00018 <span class="comment"></span>
  62 <a name="l00019"></a>00019 <span class="comment"></span>
  63 <a name="l00020"></a>00020 <span class="comment">**************************************************************************/</span>
  64 <a name="l00021"></a>00021
  65 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef CHESSCLOCK_H</span>
  66 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define CHESSCLOCK_H</span>
  67 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  68 <a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QWidget&gt;</span>
  69 <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QTime&gt;</span>
  70 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QTimer&gt;</span>
  71 <a name="l00028"></a>00028
  72 <a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="class_turn_information.html" title="Turn information class.">TurnInformation</a>;
  73 <a name="l00030"></a>00030
  74 <a name="l00031"></a>00031
  75 <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
  76 <a name="l00044"></a>00044 {
  77 <a name="l00045"></a>00045     Q_OBJECT
  78 <a name="l00046"></a>00046 <span class="keyword">public</span>:
  79 <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);
  80 <a name="l00048"></a>00048
  81 <a name="l00049"></a>00049 <span class="keyword">public</span>:
  82 <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> {
  83 <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,
  84 <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,
  85 <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
  86 <a name="l00054"></a>00054     };
  87 <a name="l00055"></a>00055
  88 <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> loser_; }
  89 <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> turn_; }
  90 <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> isWhite_; }
  91 <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> status_ ; }
  92 <a name="l00060"></a>00060
  93 <a name="l00061"></a>00061
  94 <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>();
  95 <a name="l00064"></a>00064
  96 <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>();
  97 <a name="l00070"></a>00070
  98 <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>();
  99 <a name="l00073"></a>00073
 100 <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>();
 101 <a name="l00076"></a>00076
 102 <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);
 103 <a name="l00080"></a>00080
 104 <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>();
 105 <a name="l00087"></a>00087
 106 <a name="l00090"></a>00090     <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_chess_clock.html#a90be9c7c27f000e7bcad1420d8f3e8b0" title="Get total time played.">getTimePlayed</a>() <span class="keyword">const</span>;
 107 <a name="l00091"></a>00091
 108 <a name="l00092"></a>00092
 109 <a name="l00093"></a>00093 signals:
 110 <a name="l00094"></a>00094     <span class="keywordtype">void</span> <a class="code" href="class_chess_clock.html#a9406ad0b60047e6605cf3e41c8a47b13">timeOutLoser</a>();
 111 <a name="l00095"></a>00095
 112 <a name="l00096"></a>00096 <span class="keyword">public</span> slots:
 113 <a name="l00097"></a>00097
 114 <a name="l00099"></a>00099     <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;
 115 <a name="l00100"></a>00100
 116 <a name="l00102"></a>00102     <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>();
 117 <a name="l00103"></a>00103
 118 <a name="l00104"></a>00104 <span class="keyword">private</span>:
 119 <a name="l00105"></a>00105     <a class="code" href="class_chess_clock.html" title="Clock of a individual player.">ChessClock</a>* another_;
 120 <a name="l00107"></a>00107     <span class="keywordtype">bool</span> loser_;
 121 <a name="l00108"></a>00108     <span class="keywordtype">int</span> turn_;
 122 <a name="l00109"></a>00109     <a class="code" href="class_chess_clock.html#a4a819ca828d25e17dd5975a2ea935d28">RunningStatus</a> status_;
 123 <a name="l00110"></a>00110     <a class="code" href="class_turn_information.html" title="Turn information class.">TurnInformation</a>* currentTurn_;
 124 <a name="l00111"></a>00111
 125 <a name="l00112"></a>00112     <span class="keywordtype">int</span> timePlayedBeforeTurn_;
 126 <a name="l00113"></a>00113     <span class="keywordtype">int</span> timeAvailableBeforeTurn_;
 127 <a name="l00115"></a>00115     <span class="keywordtype">bool</span> isWhite_;
 128 <a name="l00117"></a>00117     QTime clockTime_;
 129 <a name="l00118"></a>00118     QTimer updateTimer_;
 130 <a name="l00119"></a>00119
 131 <a name="l00120"></a>00120     <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> UPDATEINTERVAL = 1000;
 132 <a name="l00122"></a>00122 };
 133 <a name="l00123"></a>00123
 134 <a name="l00124"></a>00124 <span class="preprocessor">#endif // CHESSCLOCK_H</span>
 135 </pre></div></div>
 136 <!--- window showing the filter options -->
 137 <div id="MSearchSelectWindow"
 138      onmouseover="return searchBox.OnSearchSelectShow()"
 139      onmouseout="return searchBox.OnSearchSelectHide()"
 140      onkeydown="return searchBox.OnSearchSelectKey(event)">
 141 <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>
 142
 143 <!-- iframe showing the search results (closed by default) -->
 144 <div id="MSearchResultsWindow">
 145 <iframe src="" frameborder="0"
 146         name="MSearchResults" id="MSearchResults">
 147 </iframe>
 148 </div>
 149
 150 <hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Aug 14 01:28:48 2010 for Chess Clock by&nbsp;
 151 <a href="http://www.doxygen.org/index.html">
 152 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 153 </body>
 154 </html>