API documentation updated
[chessclock] / www / html / class_hour_glass_clock.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: HourGlassClock Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
23       <li><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="annotated.html"><span>Class&nbsp;List</span></a></li>
42       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
43       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
44     </ul>
45   </div>
46 </div>
47 <div class="contents">
48 <h1>HourGlassClock Class Reference</h1><!-- doxytag: class="HourGlassClock" --><!-- doxytag: inherits="ChessClockWidget" -->
49 <p><code>#include &lt;<a class="el" href="hourglassclock_8h_source.html">hourglassclock.h</a>&gt;</code></p>
50 <div class="dynheader">
51 Inheritance diagram for HourGlassClock:</div>
52 <div class="dynsection">
53  <div class="center">
54   <img src="class_hour_glass_clock.png" usemap="#HourGlassClock_map" alt=""/>
55   <map id="HourGlassClock_map" name="HourGlassClock_map">
56 <area href="class_chess_clock_widget.html" alt="ChessClockWidget" shape="rect" coords="0,56,117,80"/>
57 <area href="class_chess_clock.html" alt="ChessClock" shape="rect" coords="0,0,117,24"/>
58 </map>
59  </div>
60 </div>
61
62 <p><a href="class_hour_glass_clock-members.html">List of all members.</a></p>
63 <table border="0" cellpadding="0" cellspacing="0">
64 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hour_glass_clock.html#af4a8ee4fa210f6d9bc08510f614402e6">updateClock</a> ()</td></tr>
66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Update clock information, check looser state and refresh.  <a href="#af4a8ee4fa210f6d9bc08510f614402e6"></a><br/></td></tr>
67 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
68 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hour_glass_clock.html#a5adb14cc614ebd1a3261a4d3f42de8ee">HourGlassClock</a> (bool white, QWidget *parent=0)</td></tr>
69 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hour_glass_clock.html#a50daaa71c289575f47e1310ce215f45f">getTimeAvailable</a> ()</td></tr>
70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get total time available.  <a href="#a50daaa71c289575f47e1310ce215f45f"></a><br/></td></tr>
71 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_turn_information.html">TurnInformation</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_hour_glass_clock.html#af2c3629621f5ac7c41b41b236c2f1594">endTurn</a> ()</td></tr>
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">End this turn.  <a href="#af2c3629621f5ac7c41b41b236c2f1594"></a><br/></td></tr>
73 </table>
74 <hr/><a name="_details"></a><h2>Detailed Description</h2>
75
76 <p>Definition at line <a class="el" href="hourglassclock_8h_source.html#l00028">28</a> of file <a class="el" href="hourglassclock_8h_source.html">hourglassclock.h</a>.</p>
77 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
78 <a class="anchor" id="a5adb14cc614ebd1a3261a4d3f42de8ee"></a><!-- doxytag: member="HourGlassClock::HourGlassClock" ref="a5adb14cc614ebd1a3261a4d3f42de8ee" args="(bool white, QWidget *parent=0)" -->
79 <div class="memitem">
80 <div class="memproto">
81       <table class="memname">
82         <tr>
83           <td class="memname">HourGlassClock::HourGlassClock </td>
84           <td>(</td>
85           <td class="paramtype">bool&nbsp;</td>
86           <td class="paramname"> <em>white</em>, </td>
87         </tr>
88         <tr>
89           <td class="paramkey"></td>
90           <td></td>
91           <td class="paramtype">QWidget *&nbsp;</td>
92           <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
93         </tr>
94         <tr>
95           <td></td>
96           <td>)</td>
97           <td></td><td></td><td></td>
98         </tr>
99       </table>
100 </div>
101 <div class="memdoc">
102
103 <p>Definition at line <a class="el" href="hourglassclock_8cpp_source.html#l00025">25</a> of file <a class="el" href="hourglassclock_8cpp_source.html">hourglassclock.cpp</a>.</p>
104
105 </div>
106 </div>
107 <hr/><h2>Member Function Documentation</h2>
108 <a class="anchor" id="af2c3629621f5ac7c41b41b236c2f1594"></a><!-- doxytag: member="HourGlassClock::endTurn" ref="af2c3629621f5ac7c41b41b236c2f1594" args="()" -->
109 <div class="memitem">
110 <div class="memproto">
111       <table class="memname">
112         <tr>
113           <td class="memname"><a class="el" href="class_turn_information.html">TurnInformation</a> * HourGlassClock::endTurn </td>
114           <td>(</td>
115           <td class="paramname"></td>
116           <td>&nbsp;)&nbsp;</td>
117           <td><code> [virtual]</code></td>
118         </tr>
119       </table>
120 </div>
121 <div class="memdoc">
122
123 <p>End this turn. </p>
124 <p>Player has done his move. </p>
125 <dl class="return"><dt><b>Returns:</b></dt><dd>Locked turn information </dd></dl>
126
127 <p>Reimplemented from <a class="el" href="class_chess_clock.html#a2383619532d2e9e6557961616c722531">ChessClock</a>.</p>
128
129 <p>Definition at line <a class="el" href="hourglassclock_8cpp_source.html#l00047">47</a> of file <a class="el" href="hourglassclock_8cpp_source.html">hourglassclock.cpp</a>.</p>
130
131 </div>
132 </div>
133 <a class="anchor" id="a50daaa71c289575f47e1310ce215f45f"></a><!-- doxytag: member="HourGlassClock::getTimeAvailable" ref="a50daaa71c289575f47e1310ce215f45f" args="()" -->
134 <div class="memitem">
135 <div class="memproto">
136       <table class="memname">
137         <tr>
138           <td class="memname">int HourGlassClock::getTimeAvailable </td>
139           <td>(</td>
140           <td class="paramname"></td>
141           <td>&nbsp;)&nbsp;</td>
142           <td><code> [virtual]</code></td>
143         </tr>
144       </table>
145 </div>
146 <div class="memdoc">
147
148 <p>Get total time available. </p>
149 <p>Time does't contain delays.</p>
150 <dl class="return"><dt><b>Returns:</b></dt><dd>Time available in msecs </dd></dl>
151
152 <p>Reimplemented from <a class="el" href="class_chess_clock.html#a8e7d214dcc13dcd1087d2281fe96ce16">ChessClock</a>.</p>
153
154 <p>Definition at line <a class="el" href="hourglassclock_8cpp_source.html#l00031">31</a> of file <a class="el" href="hourglassclock_8cpp_source.html">hourglassclock.cpp</a>.</p>
155
156 </div>
157 </div>
158 <a class="anchor" id="af4a8ee4fa210f6d9bc08510f614402e6"></a><!-- doxytag: member="HourGlassClock::updateClock" ref="af4a8ee4fa210f6d9bc08510f614402e6" args="()" -->
159 <div class="memitem">
160 <div class="memproto">
161       <table class="memname">
162         <tr>
163           <td class="memname">void HourGlassClock::updateClock </td>
164           <td>(</td>
165           <td class="paramname"></td>
166           <td>&nbsp;)&nbsp;</td>
167           <td><code> [virtual, slot]</code></td>
168         </tr>
169       </table>
170 </div>
171 <div class="memdoc">
172
173 <p>Update clock information, check looser state and refresh. </p>
174
175 <p>Reimplemented from <a class="el" href="class_chess_clock.html#a2262f5bb09794ef7a40c62c0c28a6979">ChessClock</a>.</p>
176
177 <p>Definition at line <a class="el" href="hourglassclock_8cpp_source.html#l00069">69</a> of file <a class="el" href="hourglassclock_8cpp_source.html">hourglassclock.cpp</a>.</p>
178
179 </div>
180 </div>
181 <hr/>The documentation for this class was generated from the following files:<ul>
182 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/timecontrol/<a class="el" href="hourglassclock_8h_source.html">hourglassclock.h</a></li>
183 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/timecontrol/<a class="el" href="hourglassclock_8cpp_source.html">hourglassclock.cpp</a></li>
184 </ul>
185 </div>
186 <!--- window showing the filter options -->
187 <div id="MSearchSelectWindow"
188      onmouseover="return searchBox.OnSearchSelectShow()"
189      onmouseout="return searchBox.OnSearchSelectHide()"
190      onkeydown="return searchBox.OnSearchSelectKey(event)">
191 <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>
192
193 <!-- iframe showing the search results (closed by default) -->
194 <div id="MSearchResultsWindow">
195 <iframe src="" frameborder="0" 
196         name="MSearchResults" id="MSearchResults">
197 </iframe>
198 </div>
199
200 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 19 21:04:21 2010 for Chess Clock by&nbsp;
201 <a href="http://www.doxygen.org/index.html">
202 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
203 </body>
204 </html>