API documentation updated
[chessclock] / www / html / class_screen_lit_keeper.html
diff --git a/www/html/class_screen_lit_keeper.html b/www/html/class_screen_lit_keeper.html
new file mode 100644 (file)
index 0000000..ebf07c5
--- /dev/null
@@ -0,0 +1,143 @@
+<!-- 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: ScreenLitKeeper 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>ScreenLitKeeper Class Reference</h1><!-- doxytag: class="ScreenLitKeeper" -->
+<p>Allows keeping the sreen lit by disabling the screensaver.  
+<a href="#_details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="screenlitkeeper_8h_source.html">screenlitkeeper.h</a>&gt;</code></p>
+
+<p><a href="class_screen_lit_keeper-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Slots</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_lit_keeper.html#a41cc193e58d9b4b5c09eda79bbb095c8">keepScreenLit</a> (bool keepLit)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets whether the screen is to be kept lit.  <a href="#a41cc193e58d9b4b5c09eda79bbb095c8"></a><br/></td></tr>
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_lit_keeper.html#a548195ffb1809ccb8f0277492a40a3fb">ScreenLitKeeper</a> (QObject *parent=0)</td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Allows keeping the sreen lit by disabling the screensaver. </p>
+<p>Works at least on N900. The sreen can be set to be kept lit or not. To use this class, you must have the following lines in your .pro file: CONFIG += mobility MOBILITY += systeminfo</p>
+<dl class="author"><dt><b>Author:</b></dt><dd>Heli Hyvättinen </dd></dl>
+<dl class="date"><dt><b>Date:</b></dt><dd>2010-09-07 </dd></dl>
+<dl class="version"><dt><b>Version:</b></dt><dd>1 </dd></dl>
+
+<p>Definition at line <a class="el" href="screenlitkeeper_8h_source.html#l00047">47</a> of file <a class="el" href="screenlitkeeper_8h_source.html">screenlitkeeper.h</a>.</p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a548195ffb1809ccb8f0277492a40a3fb"></a><!-- doxytag: member="ScreenLitKeeper::ScreenLitKeeper" ref="a548195ffb1809ccb8f0277492a40a3fb" args="(QObject *parent=0)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">ScreenLitKeeper::ScreenLitKeeper </td>
+          <td>(</td>
+          <td class="paramtype">QObject *&nbsp;</td>
+          <td class="paramname"> <em>parent</em> = <code>0</code></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [explicit]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Definition at line <a class="el" href="screenlitkeeper_8cpp_source.html#l00027">27</a> of file <a class="el" href="screenlitkeeper_8cpp_source.html">screenlitkeeper.cpp</a>.</p>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a41cc193e58d9b4b5c09eda79bbb095c8"></a><!-- doxytag: member="ScreenLitKeeper::keepScreenLit" ref="a41cc193e58d9b4b5c09eda79bbb095c8" args="(bool keepLit)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ScreenLitKeeper::keepScreenLit </td>
+          <td>(</td>
+          <td class="paramtype">bool&nbsp;</td>
+          <td class="paramname"> <em>keepLit</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [slot]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Sets whether the screen is to be kept lit. </p>
+<dl><dt><b>Parameters:</b></dt><dd>
+  <table border="0" cellspacing="2" cellpadding="0">
+    <tr><td valign="top"></td><td valign="top"><em>keepLit</em>&nbsp;</td><td>true for keeping lit, false for allowing blanking </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p>Definition at line <a class="el" href="screenlitkeeper_8cpp_source.html#l00034">34</a> of file <a class="el" href="screenlitkeeper_8cpp_source.html">screenlitkeeper.cpp</a>.</p>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/<a class="el" href="screenlitkeeper_8h_source.html">screenlitkeeper.h</a></li>
+<li>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/<a class="el" href="screenlitkeeper_8cpp_source.html">screenlitkeeper.cpp</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 Sep 27 18:30:34 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>