API documentation updated
[chessclock] / www / html / screenlitkeeper_8cpp_source.html
diff --git a/www/html/screenlitkeeper_8cpp_source.html b/www/html/screenlitkeeper_8cpp_source.html
new file mode 100644 (file)
index 0000000..f5c253a
--- /dev/null
@@ -0,0 +1,127 @@
+<!-- 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: /holvi/arto/ohjelmointi/ChessClock/chessclock/classes/screenlitkeeper.cpp Source File</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><a href="annotated.html"><span>Classes</span></a></li>
+      <li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
+      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
+    </ul>
+  </div>
+<h1>/holvi/arto/ohjelmointi/ChessClock/chessclock/classes/screenlitkeeper.cpp</h1><a href="screenlitkeeper_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**************************************************************************</span>
+<a name="l00002"></a>00002 <span class="comment">        ScreenLitKeeper</span>
+<a name="l00003"></a>00003 <span class="comment"></span>
+<a name="l00004"></a>00004 <span class="comment">        Copyright (C) 2010  Heli Hyvättinen</span>
+<a name="l00005"></a>00005 <span class="comment">        </span>
+<a name="l00006"></a>00006 <span class="comment">        This file is free software: you can redistribute it and/or modify</span>
+<a name="l00007"></a>00007 <span class="comment">        it under the terms of the GNU General Public License as published by</span>
+<a name="l00008"></a>00008 <span class="comment">        the Free Software Foundation, either version 3 of the License, or</span>
+<a name="l00009"></a>00009 <span class="comment">        (at your option) any later version.</span>
+<a name="l00010"></a>00010 <span class="comment"></span>
+<a name="l00011"></a>00011 <span class="comment">        This program is distributed in the hope that it will be useful,</span>
+<a name="l00012"></a>00012 <span class="comment">        but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<a name="l00013"></a>00013 <span class="comment">        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<a name="l00014"></a>00014 <span class="comment">        GNU General Public License for more details.</span>
+<a name="l00015"></a>00015 <span class="comment"></span>
+<a name="l00016"></a>00016 <span class="comment">        You should have received a copy of the GNU General Public License</span>
+<a name="l00017"></a>00017 <span class="comment">        along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<a name="l00018"></a>00018 <span class="comment"></span>
+<a name="l00019"></a>00019 <span class="comment">**************************************************************************/</span>
+<a name="l00020"></a>00020 
+<a name="l00021"></a>00021 
+<a name="l00022"></a>00022 
+<a name="l00023"></a>00023 
+<a name="l00024"></a>00024 
+<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;<a class="code" href="screenlitkeeper_8h.html">screenlitkeeper.h</a>&quot;</span>
+<a name="l00026"></a>00026 
+<a name="l00027"></a><a class="code" href="class_screen_lit_keeper.html#a548195ffb1809ccb8f0277492a40a3fb">00027</a> <a class="code" href="class_screen_lit_keeper.html#a548195ffb1809ccb8f0277492a40a3fb">ScreenLitKeeper::ScreenLitKeeper</a>(QObject *parent) :
+<a name="l00028"></a>00028     QObject(parent)
+<a name="l00029"></a>00029 {
+<a name="l00030"></a>00030     p_screensaver_ = NULL;
+<a name="l00031"></a>00031     isKeptLit_ = <span class="keyword">false</span>;
+<a name="l00032"></a>00032 }
+<a name="l00033"></a>00033 
+<a name="l00034"></a><a class="code" href="class_screen_lit_keeper.html#a41cc193e58d9b4b5c09eda79bbb095c8">00034</a> <span class="keywordtype">void</span> <a class="code" href="class_screen_lit_keeper.html#a41cc193e58d9b4b5c09eda79bbb095c8" title="Sets whether the screen is to be kept lit.">ScreenLitKeeper::keepScreenLit</a>(<span class="keywordtype">bool</span> keepLit)
+<a name="l00035"></a>00035 {
+<a name="l00036"></a>00036 
+<a name="l00037"></a>00037     <span class="comment">//If the requested state is the same as the current state do nothing.</span>
+<a name="l00038"></a>00038     <span class="keywordflow">if</span> (keepLit == isKeptLit_)
+<a name="l00039"></a>00039         <span class="keywordflow">return</span>;
+<a name="l00040"></a>00040 
+<a name="l00041"></a>00041 
+<a name="l00042"></a>00042 
+<a name="l00043"></a>00043     <span class="keywordflow">if</span> (keepLit == <span class="keyword">true</span> )
+<a name="l00044"></a>00044     {
+<a name="l00045"></a>00045         <span class="comment">//a new screensaver is created, parent is given so that it is automatically destroyed when this object is destroyed</span>
+<a name="l00046"></a>00046         p_screensaver_ = <span class="keyword">new</span> QSystemScreenSaver(<span class="keyword">this</span>);
+<a name="l00047"></a>00047         <span class="comment">//screensaver is disabled, which keeps the screen lit on N900</span>
+<a name="l00048"></a>00048         p_screensaver_-&gt;setScreenSaverInhibit();
+<a name="l00049"></a>00049         isKeptLit_ = <span class="keyword">true</span>;
+<a name="l00050"></a>00050 
+<a name="l00051"></a>00051     }
+<a name="l00052"></a>00052 
+<a name="l00053"></a>00053     <span class="keywordflow">else</span> <span class="keywordflow">if</span> (p_screensaver_ != NULL) <span class="comment">//just to be on the safe side, it should never be NULL if this line is reached</span>
+<a name="l00054"></a>00054     {
+<a name="l00055"></a>00055       <span class="keyword">delete</span> p_screensaver_; <span class="comment">//The object must be deleted to reverse the effect of setScreenSaverInhibit()</span>
+<a name="l00056"></a>00056       p_screensaver_ = NULL;
+<a name="l00057"></a>00057       isKeptLit_ = <span class="keyword">false</span>;
+<a name="l00058"></a>00058 
+<a name="l00059"></a>00059     }
+<a name="l00060"></a>00060 
+<a name="l00061"></a>00061     <span class="keywordflow">return</span>;
+<a name="l00062"></a>00062 
+<a name="l00063"></a>00063 }
+</pre></div></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:33 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>