API documentation updated
[chessclock] / www / html / class_delay_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: DelayClock 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>DelayClock Class Reference</h1><!-- doxytag: class="DelayClock" --><!-- doxytag: inherits="ChessClockWidget" -->
49 <p>Simple delay.  
50 <a href="#_details">More...</a></p>
51
52 <p><code>#include &lt;<a class="el" href="delayclock_8h_source.html">delayclock.h</a>&gt;</code></p>
53 <div class="dynheader">
54 Inheritance diagram for DelayClock:</div>
55 <div class="dynsection">
56  <div class="center">
57   <img src="class_delay_clock.png" usemap="#DelayClock_map" alt=""/>
58   <map id="DelayClock_map" name="DelayClock_map">
59 <area href="class_chess_clock_widget.html" alt="ChessClockWidget" shape="rect" coords="0,56,117,80"/>
60 <area href="class_chess_clock.html" alt="ChessClock" shape="rect" coords="0,0,117,24"/>
61 </map>
62  </div>
63 </div>
64
65 <p><a href="class_delay_clock-members.html">List of all members.</a></p>
66 <table border="0" cellpadding="0" cellspacing="0">
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_delay_clock.html#a1a3d6826f91aac75e4d3b2e1419bb33c">DelayClock</a> (bool white, int delay, 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_delay_clock.html#ad926d5f15903c47092d431cc26b296d4">getTimeAvailable</a> ()</td></tr>
70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get total time available.  <a href="#ad926d5f15903c47092d431cc26b296d4"></a><br/></td></tr>
71 <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
72 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_delay_clock.html#a2859dc0ab9e112839c005a3d2ec6b56c">delay_</a></td></tr>
73 </table>
74 <hr/><a name="_details"></a><h2>Detailed Description</h2>
75 <p>Simple delay. </p>
76 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
77 <dl class="date"><dt><b>Date:</b></dt><dd>2010-08-16 </dd></dl>
78
79 <p>Definition at line <a class="el" href="delayclock_8h_source.html#l00034">34</a> of file <a class="el" href="delayclock_8h_source.html">delayclock.h</a>.</p>
80 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
81 <a class="anchor" id="a1a3d6826f91aac75e4d3b2e1419bb33c"></a><!-- doxytag: member="DelayClock::DelayClock" ref="a1a3d6826f91aac75e4d3b2e1419bb33c" args="(bool white, int delay, QWidget *parent=0)" -->
82 <div class="memitem">
83 <div class="memproto">
84       <table class="memname">
85         <tr>
86           <td class="memname">DelayClock::DelayClock </td>
87           <td>(</td>
88           <td class="paramtype">bool&nbsp;</td>
89           <td class="paramname"> <em>white</em>, </td>
90         </tr>
91         <tr>
92           <td class="paramkey"></td>
93           <td></td>
94           <td class="paramtype">int&nbsp;</td>
95           <td class="paramname"> <em>delay</em>, </td>
96         </tr>
97         <tr>
98           <td class="paramkey"></td>
99           <td></td>
100           <td class="paramtype">QWidget *&nbsp;</td>
101           <td class="paramname"> <em>parent</em> = <code>0</code></td><td>&nbsp;</td>
102         </tr>
103         <tr>
104           <td></td>
105           <td>)</td>
106           <td></td><td></td><td></td>
107         </tr>
108       </table>
109 </div>
110 <div class="memdoc">
111
112 <p>Definition at line <a class="el" href="delayclock_8cpp_source.html#l00024">24</a> of file <a class="el" href="delayclock_8cpp_source.html">delayclock.cpp</a>.</p>
113
114 </div>
115 </div>
116 <hr/><h2>Member Function Documentation</h2>
117 <a class="anchor" id="ad926d5f15903c47092d431cc26b296d4"></a><!-- doxytag: member="DelayClock::getTimeAvailable" ref="ad926d5f15903c47092d431cc26b296d4" args="()" -->
118 <div class="memitem">
119 <div class="memproto">
120       <table class="memname">
121         <tr>
122           <td class="memname">int DelayClock::getTimeAvailable </td>
123           <td>(</td>
124           <td class="paramname"></td>
125           <td>&nbsp;)&nbsp;</td>
126           <td><code> [virtual]</code></td>
127         </tr>
128       </table>
129 </div>
130 <div class="memdoc">
131
132 <p>Get total time available. </p>
133 <p>Time does't contain delays.</p>
134 <dl class="return"><dt><b>Returns:</b></dt><dd>Time available in msecs </dd></dl>
135
136 <p>Reimplemented from <a class="el" href="class_chess_clock.html#a8e7d214dcc13dcd1087d2281fe96ce16">ChessClock</a>.</p>
137
138 <p>Definition at line <a class="el" href="delayclock_8cpp_source.html#l00031">31</a> of file <a class="el" href="delayclock_8cpp_source.html">delayclock.cpp</a>.</p>
139
140 </div>
141 </div>
142 <hr/><h2>Member Data Documentation</h2>
143 <a class="anchor" id="a2859dc0ab9e112839c005a3d2ec6b56c"></a><!-- doxytag: member="DelayClock::delay_" ref="a2859dc0ab9e112839c005a3d2ec6b56c" args="" -->
144 <div class="memitem">
145 <div class="memproto">
146       <table class="memname">
147         <tr>
148           <td class="memname">int <a class="el" href="class_delay_clock.html#a2859dc0ab9e112839c005a3d2ec6b56c">DelayClock::delay_</a><code> [protected]</code></td>
149         </tr>
150       </table>
151 </div>
152 <div class="memdoc">
153
154 <p>Definition at line <a class="el" href="delayclock_8h_source.html#l00046">46</a> of file <a class="el" href="delayclock_8h_source.html">delayclock.h</a>.</p>
155
156 </div>
157 </div>
158 <hr/>The documentation for this class was generated from the following files:<ul>
159 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/timecontrol/<a class="el" href="delayclock_8h_source.html">delayclock.h</a></li>
160 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/timecontrol/<a class="el" href="delayclock_8cpp_source.html">delayclock.cpp</a></li>
161 </ul>
162 </div>
163 <!--- window showing the filter options -->
164 <div id="MSearchSelectWindow"
165      onmouseover="return searchBox.OnSearchSelectShow()"
166      onmouseout="return searchBox.OnSearchSelectHide()"
167      onkeydown="return searchBox.OnSearchSelectKey(event)">
168 <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>
169
170 <!-- iframe showing the search results (closed by default) -->
171 <div id="MSearchResultsWindow">
172 <iframe src="" frameborder="0" 
173         name="MSearchResults" id="MSearchResults">
174 </iframe>
175 </div>
176
177 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 19 21:04:20 2010 for Chess Clock by&nbsp;
178 <a href="http://www.doxygen.org/index.html">
179 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
180 </body>
181 </html>