API documentation updated
[chessclock] / www / html / class_fischer_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: FischerClock 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>FischerClock Class Reference</h1><!-- doxytag: class="FischerClock" --><!-- doxytag: inherits="ChessClockWidget" -->
49 <p><code>#include &lt;<a class="el" href="fischerclock_8h_source.html">fischerclock.h</a>&gt;</code></p>
50 <div class="dynheader">
51 Inheritance diagram for FischerClock:</div>
52 <div class="dynsection">
53  <div class="center">
54   <img src="class_fischer_clock.png" usemap="#FischerClock_map" alt=""/>
55   <map id="FischerClock_map" name="FischerClock_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_fischer_clock-members.html">List of all members.</a></p>
63 <table border="0" cellpadding="0" cellspacing="0">
64 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
65 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fischer_clock.html#a0b741841db9522c2ae75a9ae65d91822">FischerClock</a> (bool white, int addition, int perTurns, QWidget *parent=0)</td></tr>
66 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fischer_clock.html#a57f7d1108e88c04e3c8d9326cc8bb0b6">startTurn</a> ()</td></tr>
67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start new turn.  <a href="#a57f7d1108e88c04e3c8d9326cc8bb0b6"></a><br/></td></tr>
68 <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
69 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fischer_clock.html#a4a871125df35a56770b85617a0be920b">addition_</a></td></tr>
70 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fischer_clock.html#aad82135e0f3c675d749a784050f3b20b">perTurns_</a></td></tr>
71 </table>
72 <hr/><a name="_details"></a><h2>Detailed Description</h2>
73
74 <p>Definition at line <a class="el" href="fischerclock_8h_source.html#l00027">27</a> of file <a class="el" href="fischerclock_8h_source.html">fischerclock.h</a>.</p>
75 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
76 <a class="anchor" id="a0b741841db9522c2ae75a9ae65d91822"></a><!-- doxytag: member="FischerClock::FischerClock" ref="a0b741841db9522c2ae75a9ae65d91822" args="(bool white, int addition, int perTurns, QWidget *parent=0)" -->
77 <div class="memitem">
78 <div class="memproto">
79       <table class="memname">
80         <tr>
81           <td class="memname">FischerClock::FischerClock </td>
82           <td>(</td>
83           <td class="paramtype">bool&nbsp;</td>
84           <td class="paramname"> <em>white</em>, </td>
85         </tr>
86         <tr>
87           <td class="paramkey"></td>
88           <td></td>
89           <td class="paramtype">int&nbsp;</td>
90           <td class="paramname"> <em>addition</em>, </td>
91         </tr>
92         <tr>
93           <td class="paramkey"></td>
94           <td></td>
95           <td class="paramtype">int&nbsp;</td>
96           <td class="paramname"> <em>perTurns</em>, </td>
97         </tr>
98         <tr>
99           <td class="paramkey"></td>
100           <td></td>
101           <td class="paramtype">QWidget *&nbsp;</td>
102           <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
103         </tr>
104         <tr>
105           <td></td>
106           <td>)</td>
107           <td></td><td></td><td></td>
108         </tr>
109       </table>
110 </div>
111 <div class="memdoc">
112
113 <p>Definition at line <a class="el" href="fischerclock_8cpp_source.html#l00024">24</a> of file <a class="el" href="fischerclock_8cpp_source.html">fischerclock.cpp</a>.</p>
114
115 </div>
116 </div>
117 <hr/><h2>Member Function Documentation</h2>
118 <a class="anchor" id="a57f7d1108e88c04e3c8d9326cc8bb0b6"></a><!-- doxytag: member="FischerClock::startTurn" ref="a57f7d1108e88c04e3c8d9326cc8bb0b6" args="()" -->
119 <div class="memitem">
120 <div class="memproto">
121       <table class="memname">
122         <tr>
123           <td class="memname">void FischerClock::startTurn </td>
124           <td>(</td>
125           <td class="paramname"></td>
126           <td>&nbsp;)&nbsp;</td>
127           <td><code> [virtual]</code></td>
128         </tr>
129       </table>
130 </div>
131 <div class="memdoc">
132
133 <p>Start new turn. </p>
134
135 <p>Reimplemented from <a class="el" href="class_chess_clock.html#a49504d86896ef3f724b2aa481c85435a">ChessClock</a>.</p>
136
137 <p>Definition at line <a class="el" href="fischerclock_8cpp_source.html#l00033">33</a> of file <a class="el" href="fischerclock_8cpp_source.html">fischerclock.cpp</a>.</p>
138
139 </div>
140 </div>
141 <hr/><h2>Member Data Documentation</h2>
142 <a class="anchor" id="a4a871125df35a56770b85617a0be920b"></a><!-- doxytag: member="FischerClock::addition_" ref="a4a871125df35a56770b85617a0be920b" args="" -->
143 <div class="memitem">
144 <div class="memproto">
145       <table class="memname">
146         <tr>
147           <td class="memname">int <a class="el" href="class_fischer_clock.html#a4a871125df35a56770b85617a0be920b">FischerClock::addition_</a><code> [protected]</code></td>
148         </tr>
149       </table>
150 </div>
151 <div class="memdoc">
152
153 <p>Definition at line <a class="el" href="fischerclock_8h_source.html#l00041">41</a> of file <a class="el" href="fischerclock_8h_source.html">fischerclock.h</a>.</p>
154
155 </div>
156 </div>
157 <a class="anchor" id="aad82135e0f3c675d749a784050f3b20b"></a><!-- doxytag: member="FischerClock::perTurns_" ref="aad82135e0f3c675d749a784050f3b20b" args="" -->
158 <div class="memitem">
159 <div class="memproto">
160       <table class="memname">
161         <tr>
162           <td class="memname">int <a class="el" href="class_fischer_clock.html#aad82135e0f3c675d749a784050f3b20b">FischerClock::perTurns_</a><code> [protected]</code></td>
163         </tr>
164       </table>
165 </div>
166 <div class="memdoc">
167
168 <p>Definition at line <a class="el" href="fischerclock_8h_source.html#l00042">42</a> of file <a class="el" href="fischerclock_8h_source.html">fischerclock.h</a>.</p>
169
170 </div>
171 </div>
172 <hr/>The documentation for this class was generated from the following files:<ul>
173 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/timecontrol/<a class="el" href="fischerclock_8h_source.html">fischerclock.h</a></li>
174 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/timecontrol/<a class="el" href="fischerclock_8cpp_source.html">fischerclock.cpp</a></li>
175 </ul>
176 </div>
177 <!--- window showing the filter options -->
178 <div id="MSearchSelectWindow"
179      onmouseover="return searchBox.OnSearchSelectShow()"
180      onmouseout="return searchBox.OnSearchSelectHide()"
181      onkeydown="return searchBox.OnSearchSelectKey(event)">
182 <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>
183
184 <!-- iframe showing the search results (closed by default) -->
185 <div id="MSearchResultsWindow">
186 <iframe src="" frameborder="0" 
187         name="MSearchResults" id="MSearchResults">
188 </iframe>
189 </div>
190
191 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 19 21:04:21 2010 for Chess Clock by&nbsp;
192 <a href="http://www.doxygen.org/index.html">
193 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
194 </body>
195 </html>