git.maemo.org Git - chessclock/blob - www/html/turninformation_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/turninformation.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/turninformation.h</h1><a href="turninformation_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 TURNINFORMATION_H</span>
  66 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define TURNINFORMATION_H</span>
  67 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  68 <a name="l00034"></a><a class="code" href="class_turn_information.html">00034</a> <span class="keyword">class </span><a class="code" href="class_turn_information.html" title="Turn information class.">TurnInformation</a>
  69 <a name="l00035"></a>00035 {
  70 <a name="l00036"></a>00036 <span class="keyword">public</span>:
  71 <a name="l00041"></a>00041     <a class="code" href="class_turn_information.html#a0126f181e93c7fa7b6d53b46be79247d" title="Turn information object.">TurnInformation</a>(<span class="keywordtype">int</span> turnId, <span class="keywordtype">bool</span> white);
  72 <a name="l00042"></a>00042
  73 <a name="l00043"></a><a class="code" href="class_turn_information.html#ad9802d9ccc6849b3bc1aedf87d2f0926">00043</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#ad9802d9ccc6849b3bc1aedf87d2f0926">getTurnId</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_turn_information.html#a77d4475ceb0b529835ffe09cb3974cfa">turnId_</a>; }
  74 <a name="l00044"></a>00044
  75 <a name="l00047"></a><a class="code" href="class_turn_information.html#a04e622dacea74dbc558b1a4260bff9a6">00047</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#a04e622dacea74dbc558b1a4260bff9a6" title="Duration of turn.">getDuration</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_turn_information.html#a659fbb28b8b241ce857c93e99c6c0005" title="id of turn">duration_</a>; }
  76 <a name="l00048"></a>00048
  77 <a name="l00051"></a><a class="code" href="class_turn_information.html#ae2d37b598c7fb0fb5882e44559f662cb">00051</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#ae2d37b598c7fb0fb5882e44559f662cb" title="Duration of pauses during this turn.">getPaused</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_turn_information.html#a045f9d3fb6faea111cb6bc1e798ca40d" title="duration of turn in msecs">paused_</a>; }
  78 <a name="l00052"></a>00052
  79 <a name="l00055"></a>00055     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#acca895a029b03caa72115aed776e3070" title="Time available for this player after this turn.">getTimeAfter</a>() <span class="keyword">const</span>;
  80 <a name="l00056"></a><a class="code" href="class_turn_information.html#adfe335e110744566aee521c4784f08a0">00056</a>     <span class="keywordtype">bool</span> <a class="code" href="class_turn_information.html#adfe335e110744566aee521c4784f08a0">isWhiteTurn</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_turn_information.html#a884138dea5d094e2772ee2d87e2cdbe4" title="turn is ready and locked">white_</a>; }
  81 <a name="l00057"></a>00057
  82 <a name="l00058"></a>00058     <span class="keywordtype">void</span> <a class="code" href="class_turn_information.html#a355359f883ab74e549b5e439ea7e827e">addTime</a>( <span class="keywordtype">int</span> msecs );
  83 <a name="l00059"></a>00059     <span class="keywordtype">void</span> <a class="code" href="class_turn_information.html#ab8d3aa0183f400b64b217d39e920bb69">addPause</a>( <span class="keywordtype">int</span> msecs );
  84 <a name="l00060"></a>00060
  85 <a name="l00067"></a>00067     <span class="keywordtype">void</span> <a class="code" href="class_turn_information.html#a8820646aa51dd407d909fa08b55d52c5" title="Mark turn ready.">turnReady</a>( <span class="keywordtype">int</span> msecs );
  86 <a name="l00068"></a>00068
  87 <a name="l00069"></a>00069
  88 <a name="l00070"></a>00070 <span class="keyword">protected</span>:
  89 <a name="l00071"></a><a class="code" href="class_turn_information.html#a77d4475ceb0b529835ffe09cb3974cfa">00071</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#a77d4475ceb0b529835ffe09cb3974cfa">turnId_</a>;
  90 <a name="l00072"></a><a class="code" href="class_turn_information.html#a659fbb28b8b241ce857c93e99c6c0005">00072</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#a659fbb28b8b241ce857c93e99c6c0005" title="id of turn">duration_</a>;
  91 <a name="l00073"></a><a class="code" href="class_turn_information.html#a045f9d3fb6faea111cb6bc1e798ca40d">00073</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#a045f9d3fb6faea111cb6bc1e798ca40d" title="duration of turn in msecs">paused_</a>;
  92 <a name="l00074"></a><a class="code" href="class_turn_information.html#a5516d055dd81c55b75567247b8293cde">00074</a>     <span class="keywordtype">int</span> <a class="code" href="class_turn_information.html#a5516d055dd81c55b75567247b8293cde" title="duration of pauses in msecs">timeAfter_</a>;
  93 <a name="l00075"></a><a class="code" href="class_turn_information.html#a8e0a6eb69455755152da7705e46e1f48">00075</a>     <span class="keywordtype">bool</span> <a class="code" href="class_turn_information.html#a8e0a6eb69455755152da7705e46e1f48" title="time available after this turn in msecs">turnReady_</a>;
  94 <a name="l00076"></a><a class="code" href="class_turn_information.html#a884138dea5d094e2772ee2d87e2cdbe4">00076</a>     <span class="keywordtype">bool</span> <a class="code" href="class_turn_information.html#a884138dea5d094e2772ee2d87e2cdbe4" title="turn is ready and locked">white_</a>;
  95 <a name="l00077"></a>00077 };
  96 <a name="l00078"></a>00078
  97 <a name="l00079"></a>00079 <span class="preprocessor">#endif // TURNINFORMATION_H</span>
  98 </pre></div></div>
  99 <!--- window showing the filter options -->
 100 <div id="MSearchSelectWindow"
 101      onmouseover="return searchBox.OnSearchSelectShow()"
 102      onmouseout="return searchBox.OnSearchSelectHide()"
 103      onkeydown="return searchBox.OnSearchSelectKey(event)">
 104 <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>
 105
 106 <!-- iframe showing the search results (closed by default) -->
 107 <div id="MSearchResultsWindow">
 108 <iframe src="" frameborder="0"
 109         name="MSearchResults" id="MSearchResults">
 110 </iframe>
 111 </div>
 112
 113 <hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Aug 14 01:28:48 2010 for Chess Clock by&nbsp;
 114 <a href="http://www.doxygen.org/index.html">
 115 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 116 </body>
 117 </html>