git.maemo.org Git - chessclock/blob - www/html/class_time_control.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: TimeControl 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>TimeControl Class Reference</h1><!-- doxytag: class="TimeControl" -->
  49 <p>Base class of virtual controls.
  50 <a href="#_details">More...</a></p>
  51
  52 <p><code>#include &lt;<a class="el" href="timecontrol_8h_source.html">timecontrol.h</a>&gt;</code></p>
  53 <div class="dynheader">
  54 Inheritance diagram for TimeControl:</div>
  55 <div class="dynsection">
  56  <div class="center">
  57   <img src="class_time_control.png" usemap="#TimeControl_map" alt=""/>
  58   <map id="TimeControl_map" name="TimeControl_map">
  59 <area href="class_delay_after_time_control.html" alt="DelayAfterTimeControl" shape="rect" coords="0,56,150,80"/>
  60 <area href="class_delay_time_control.html" alt="DelayTimeControl" shape="rect" coords="160,56,310,80"/>
  61 <area href="class_fischer_after_time_control.html" alt="FischerAfterTimeControl" shape="rect" coords="320,56,470,80"/>
  62 <area href="class_fischer_time_control.html" alt="FischerTimeControl" shape="rect" coords="480,56,630,80"/>
  63 <area href="class_hour_glass_time_control.html" alt="HourGlassTimeControl" shape="rect" coords="640,56,790,80"/>
  64 <area href="class_no_time_control.html" alt="NoTimeControl" shape="rect" coords="800,56,950,80"/>
  65 </map>
  66  </div>
  67 </div>
  68
  69 <p><a href="class_time_control-members.html">List of all members.</a></p>
  70 <table border="0" cellpadding="0" cellspacing="0">
  71 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  72 <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>
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of the time control.  <a href="#a1f9a2cfab9652f4edbeee8c50a0fd779"></a><br/></td></tr>
  74 <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>
  75 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Description of the time control.  <a href="#a2313b582e78004b5d945572cb269bfc4"></a><br/></td></tr>
  76 <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>
  77 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Icon of the time control.  <a href="#acf43aedff9f2ab894b02c00cac883ae7"></a><br/></td></tr>
  78 <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>
  79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Init new game.  <a href="#a2e56bcba84d74b8aa4108ae4ba9f33b1"></a><br/></td></tr>
  80 </table>
  81 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  82 <p>Base class of virtual controls. </p>
  83 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
  84 <dl class="date"><dt><b>Date:</b></dt><dd>2010-08-15 </dd></dl>
  85
  86 <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>
  87 <hr/><h2>Member Function Documentation</h2>
  88 <a class="anchor" id="a2313b582e78004b5d945572cb269bfc4"></a><!-- doxytag: member="TimeControl::getDescription" ref="a2313b582e78004b5d945572cb269bfc4" args="()=0" -->
  89 <div class="memitem">
  90 <div class="memproto">
  91       <table class="memname">
  92         <tr>
  93           <td class="memname">virtual QString TimeControl::getDescription </td>
  94           <td>(</td>
  95           <td class="paramname"></td>
  96           <td>&nbsp;)&nbsp;</td>
  97           <td><code> [pure virtual]</code></td>
  98         </tr>
  99       </table>
 100 </div>
 101 <div class="memdoc">
 102
 103 <p>Description of the time control. </p>
 104
 105 <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>
 106
 107 </div>
 108 </div>
 109 <a class="anchor" id="acf43aedff9f2ab894b02c00cac883ae7"></a><!-- doxytag: member="TimeControl::getIcon" ref="acf43aedff9f2ab894b02c00cac883ae7" args="()" -->
 110 <div class="memitem">
 111 <div class="memproto">
 112       <table class="memname">
 113         <tr>
 114           <td class="memname">virtual QIcon TimeControl::getIcon </td>
 115           <td>(</td>
 116           <td class="paramname"></td>
 117           <td>&nbsp;)&nbsp;</td>
 118           <td><code> [inline, virtual]</code></td>
 119         </tr>
 120       </table>
 121 </div>
 122 <div class="memdoc">
 123
 124 <p>Icon of the time control. </p>
 125
 126 <p>Reimplemented in <a class="el" href="class_hour_glass_time_control.html#a8e73aa82b20bad022dc1e639b387980d">HourGlassTimeControl</a>, and <a class="el" href="class_no_time_control.html#a9a639c9343f95a4deb4d0b7d044dab67">NoTimeControl</a>.</p>
 127
 128 <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>
 129
 130 </div>
 131 </div>
 132 <a class="anchor" id="a1f9a2cfab9652f4edbeee8c50a0fd779"></a><!-- doxytag: member="TimeControl::getName" ref="a1f9a2cfab9652f4edbeee8c50a0fd779" args="()=0" -->
 133 <div class="memitem">
 134 <div class="memproto">
 135       <table class="memname">
 136         <tr>
 137           <td class="memname">virtual QString TimeControl::getName </td>
 138           <td>(</td>
 139           <td class="paramname"></td>
 140           <td>&nbsp;)&nbsp;</td>
 141           <td><code> [pure virtual]</code></td>
 142         </tr>
 143       </table>
 144 </div>
 145 <div class="memdoc">
 146
 147 <p>Name of the time control. </p>
 148
 149 <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>
 150
 151 </div>
 152 </div>
 153 <a class="anchor" id="a2e56bcba84d74b8aa4108ae4ba9f33b1"></a><!-- doxytag: member="TimeControl::initGame" ref="a2e56bcba84d74b8aa4108ae4ba9f33b1" args="(bool useLastSettings=false)=0" -->
 154 <div class="memitem">
 155 <div class="memproto">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">virtual <a class="el" href="class_clocks_widget.html">ClocksWidget</a>* TimeControl::initGame </td>
 159           <td>(</td>
 160           <td class="paramtype">bool&nbsp;</td>
 161           <td class="paramname"> <em>useLastSettings</em> = <code>false</code></td>
 162           <td>&nbsp;)&nbsp;</td>
 163           <td><code> [pure virtual]</code></td>
 164         </tr>
 165       </table>
 166 </div>
 167 <div class="memdoc">
 168
 169 <p>Init new game. </p>
 170 <p>Ask options, and init new game. </p>
 171 <dl><dt><b>Parameters:</b></dt><dd>
 172   <table border="0" cellspacing="2" cellpadding="0">
 173     <tr><td valign="top"></td><td valign="top"><em>useLastSettings</em>&nbsp;</td><td>Use last settings, don't ask </td></tr>
 174   </table>
 175   </dd>
 176 </dl>
 177 <dl class="return"><dt><b>Returns:</b></dt><dd>Clocks widget for new game, or NULL if unsuccess. </dd></dl>
 178
 179 <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>
 180
 181 </div>
 182 </div>
 183 <hr/>The documentation for this class was generated from the following file:<ul>
 184 <li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/<a class="el" href="timecontrol_8h_source.html">timecontrol.h</a></li>
 185 </ul>
 186 </div>
 187 <!--- window showing the filter options -->
 188 <div id="MSearchSelectWindow"
 189      onmouseover="return searchBox.OnSearchSelectShow()"
 190      onmouseout="return searchBox.OnSearchSelectHide()"
 191      onkeydown="return searchBox.OnSearchSelectKey(event)">
 192 <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>
 193
 194 <!-- iframe showing the search results (closed by default) -->
 195 <div id="MSearchResultsWindow">
 196 <iframe src="" frameborder="0"
 197         name="MSearchResults" id="MSearchResults">
 198 </iframe>
 199 </div>
 200
 201 <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 19 21:04:21 2010 for Chess Clock by&nbsp;
 202 <a href="http://www.doxygen.org/index.html">
 203 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 204 </body>
 205 </html>