Add hourclass and old clock icons.
[chessclock] / www / html / class_time_control.html
diff --git a/www/html/class_time_control.html b/www/html/class_time_control.html
new file mode 100644 (file)
index 0000000..2e8706d
--- /dev/null
@@ -0,0 +1,203 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>Chess Clock: TimeControl Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body onload='searchBox.OnSelectItem(0);'>
+<!-- Generated by Doxygen 1.6.3 -->
+<script type="text/javascript"><!--
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+--></script>
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="files.html"><span>Files</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <img id="MSearchSelect" src="search/search.png"
+             onmouseover="return searchBox.OnSearchSelectShow()"
+             onmouseout="return searchBox.OnSearchSelectHide()"
+             alt=""/>
+        <input type="text" id="MSearchField" value="Search" accesskey="S"
+             onfocus="searchBox.OnSearchFieldFocus(true)" 
+             onblur="searchBox.OnSearchFieldFocus(false)" 
+             onkeyup="searchBox.OnSearchFieldChange(event)"/>
+        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+        </div>
+      </li>
+    </ul>
+  </div>
+  <div class="tabs">
+    <ul>
+      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
+      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
+      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<h1>TimeControl Class Reference</h1><!-- doxytag: class="TimeControl" -->
+<p>Base class of virtual controls.  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="timecontrol_8h_source.html">timecontrol.h</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for TimeControl:</div>
+<div class="dynsection">
+ <div class="center">
+  <img src="class_time_control.png" usemap="#TimeControl_map" alt=""/>
+  <map id="TimeControl_map" name="TimeControl_map">
+<area href="class_delay_after_time_control.html" alt="DelayAfterTimeControl" shape="rect" coords="0,56,150,80"/>
+<area href="class_delay_time_control.html" alt="DelayTimeControl" shape="rect" coords="160,56,310,80"/>
+<area href="class_fischer_after_time_control.html" alt="FischerAfterTimeControl" shape="rect" coords="320,56,470,80"/>
+<area href="class_fischer_time_control.html" alt="FischerTimeControl" shape="rect" coords="480,56,630,80"/>
+<area href="class_hour_glass_time_control.html" alt="HourGlassTimeControl" shape="rect" coords="640,56,790,80"/>
+<area href="class_no_time_control.html" alt="NoTimeControl" shape="rect" coords="800,56,950,80"/>
+</map>
+ </div>
+</div>
+
+<p><a href="class_time_control-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_time_control.html#a1f9a2cfab9652f4edbeee8c50a0fd779">getName</a> ()=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of the time control.  <a href="#a1f9a2cfab9652f4edbeee8c50a0fd779"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_time_control.html#a2313b582e78004b5d945572cb269bfc4">getDescription</a> ()=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the time control.  <a href="#a2313b582e78004b5d945572cb269bfc4"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual QIcon&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_time_control.html#acf43aedff9f2ab894b02c00cac883ae7">getIcon</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Icon of the time control.  <a href="#acf43aedff9f2ab894b02c00cac883ae7"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_clocks_widget.html">ClocksWidget</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_time_control.html#a2e56bcba84d74b8aa4108ae4ba9f33b1">initGame</a> (bool useLastSettings=false)=0</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Init new game.  <a href="#a2e56bcba84d74b8aa4108ae4ba9f33b1"></a><br/></td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Base class of virtual controls. </p>
+<dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
+<dl class="date"><dt><b>Date:</b></dt><dd>2010-08-15 </dd></dl>
+
+<p>Definition at line <a class="el" href="timecontrol_8h_source.html#l00035">35</a> of file <a class="el" href="timecontrol_8h_source.html">timecontrol.h</a>.</p>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a2313b582e78004b5d945572cb269bfc4"></a><!-- doxytag: member="TimeControl::getDescription" ref="a2313b582e78004b5d945572cb269bfc4" args="()=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual QString TimeControl::getDescription </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Description of the time control. </p>
+
+<p>Implemented in <a class="el" href="class_delay_after_time_control.html#a9a0a327cb511c7dbcb55ecc36850c44a">DelayAfterTimeControl</a>, <a class="el" href="class_delay_time_control.html#af617c351aa09bb903ebf7ffb1431fe47">DelayTimeControl</a>, <a class="el" href="class_fischer_after_time_control.html#ace4a714f714adb2742acbebc4b0a4dd0">FischerAfterTimeControl</a>, <a class="el" href="class_fischer_time_control.html#aa4e6d06f0a9d6d086ea3c2470049aabb">FischerTimeControl</a>, <a class="el" href="class_hour_glass_time_control.html#af71c1d0bd9087d6e7f142cfc4663b5a6">HourGlassTimeControl</a>, and <a class="el" href="class_no_time_control.html#a39c9b1c0b0e11e5271ea64b38f2d09e6">NoTimeControl</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="acf43aedff9f2ab894b02c00cac883ae7"></a><!-- doxytag: member="TimeControl::getIcon" ref="acf43aedff9f2ab894b02c00cac883ae7" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual QIcon TimeControl::getIcon </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [inline, virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Icon of the time control. </p>
+
+<p>Definition at line <a class="el" href="timecontrol_8h_source.html#l00043">43</a> of file <a class="el" href="timecontrol_8h_source.html">timecontrol.h</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a1f9a2cfab9652f4edbeee8c50a0fd779"></a><!-- doxytag: member="TimeControl::getName" ref="a1f9a2cfab9652f4edbeee8c50a0fd779" args="()=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual QString TimeControl::getName </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Name of the time control. </p>
+
+<p>Implemented in <a class="el" href="class_delay_after_time_control.html#af8c89050571857e3f048a86a933fc6b6">DelayAfterTimeControl</a>, <a class="el" href="class_delay_time_control.html#a2a89bc8c11d892ccc7ebf0494ed82a1e">DelayTimeControl</a>, <a class="el" href="class_fischer_after_time_control.html#aec7ae5784004a28a9da4aa5db55f553c">FischerAfterTimeControl</a>, <a class="el" href="class_fischer_time_control.html#af01acb7ce90134ec43831df30eef2964">FischerTimeControl</a>, <a class="el" href="class_hour_glass_time_control.html#a92c5d62cd0f35df06c28ec08e98b32ab">HourGlassTimeControl</a>, and <a class="el" href="class_no_time_control.html#ad31a2c12256bc897c0fe8ed2aabe9cd2">NoTimeControl</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a2e56bcba84d74b8aa4108ae4ba9f33b1"></a><!-- doxytag: member="TimeControl::initGame" ref="a2e56bcba84d74b8aa4108ae4ba9f33b1" args="(bool useLastSettings=false)=0" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual <a class="el" href="class_clocks_widget.html">ClocksWidget</a>* TimeControl::initGame </td>
+          <td>(</td>
+          <td class="paramtype">bool&nbsp;</td>
+          <td class="paramname"> <em>useLastSettings</em> = <code>false</code></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [pure virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Init new game. </p>
+<p>Ask options, and init new game. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>useLastSettings</em>&nbsp;</td><td>Use last settings, don't ask </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="return"><dt><b>Returns:</b></dt><dd>Clocks widget for new game, or NULL if unsuccess. </dd></dl>
+
+<p>Implemented in <a class="el" href="class_delay_after_time_control.html#a9261e9b06c1cc36b07c2d614fd800bce">DelayAfterTimeControl</a>, <a class="el" href="class_delay_time_control.html#a9b702b5dde3e92a086eaa1051c69218f">DelayTimeControl</a>, <a class="el" href="class_fischer_after_time_control.html#adcbbc386e232a5f3664ff3a332e7c8ef">FischerAfterTimeControl</a>, <a class="el" href="class_fischer_time_control.html#a8c3b5624318ef5454eadac12c296485f">FischerTimeControl</a>, <a class="el" href="class_hour_glass_time_control.html#a0fccb9f0036c5936d72cb09394a07fe2">HourGlassTimeControl</a>, and <a class="el" href="class_no_time_control.html#ab59e0d665a961614b2e54e3f8dd2f53b">NoTimeControl</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/<a class="el" href="timecontrol_8h_source.html">timecontrol.h</a></li>
+</ul>
+</div>
+<!--- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<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>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 16 21:44:24 2010 for Chess Clock by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
+</body>
+</html>