~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qwsscreensaver.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
ImportĀ upstreamĀ versionĀ 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- qwindowsystem_qws.cpp -->
 
6
<head>
 
7
  <title>Qt 4.6: QWSScreenSaver Class Reference</title>
 
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
 
9
</head>
 
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QWSScreenSaver" />
 
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
13
<tr>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QWSScreenSaver Class Reference<br /><span class="small-subtitle">[<a href="qtgui.html">QtGui</a> module]</span>
 
17
</h1>
 
18
<p>The QWSScreenSaver class is a base class for screensavers in Qt for Embedded Linux. <a href="#details">More...</a></p>
 
19
<pre> #include &lt;QWSScreenSaver&gt;</pre><ul>
 
20
<li><a href="qwsscreensaver-members.html">List of all members, including inherited members</a></li>
 
21
</ul>
 
22
<hr />
 
23
<a name="public-functions"></a>
 
24
<h2>Public Functions</h2>
 
25
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
26
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qwsscreensaver.html#dtor.QWSScreenSaver">~QWSScreenSaver</a></b> ()</td></tr>
 
27
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qwsscreensaver.html#restore">restore</a></b> () = 0</td></tr>
 
28
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qwsscreensaver.html#save">save</a></b> ( int <i>level</i> ) = 0</td></tr>
 
29
</table>
 
30
<a name="details"></a>
 
31
<hr />
 
32
<h2>Detailed Description</h2>
 
33
<p>The QWSScreenSaver class is a base class for screensavers in Qt for Embedded Linux.</p>
 
34
<p>When running <a href="qt-embedded-linux.html">Qt for Embedded Linux</a> applications, it is the server application that installs and controls the screensaver. <a href="qt-embedded-linux.html">Qt for Embedded Linux</a> supports multilevel screen saving; i.e&#x2e;, it is possible to specify several different levels of screen responsiveness. For example, you can choose to first turn off the light before you fully activate the screensaver.</p>
 
35
<p>Note that there exists no default screensaver implementation.</p>
 
36
<p>To create a custom screensaver, derive from this class and reimplement the <a href="qwsscreensaver.html#restore">restore</a>() and <a href="qwsscreensaver.html#save">save</a>() functions. These functions are called whenever the screensaver is activated or deactivated, respectively. Once an instance of your custom screensaver is created, you can use the <a href="qwsserver.html#setScreenSaver">QWSServer::setScreenSaver</a>() function to install it.</p>
 
37
<p>See also <a href="qwsserver.html">QWSServer</a>, <a href="qscreen.html">QScreen</a>, and <a href="qt-embedded-linux.html">Qt for Embedded Linux</a>.</p>
 
38
<hr />
 
39
<h2>Member Function Documentation</h2>
 
40
<a name="//apple_ref/cpp/instm/QWSScreenSaver/~QWSScreenSaver" />
 
41
<h3 class="fn"><a name="dtor.QWSScreenSaver"></a>QWSScreenSaver::~QWSScreenSaver ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
 
42
<p>Reimplement this function to destroy the screensaver.</p>
 
43
<a name="//apple_ref/cpp/instm/QWSScreenSaver/restore" />
 
44
<h3 class="fn"><a name="restore"></a>void QWSScreenSaver::restore ()&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
45
<p>Implement this function to deactivate the screensaver, restoring the previously saved screen.</p>
 
46
<p>See also <a href="qwsscreensaver.html#save">save</a>() and <a href="qwsserver.html#screenSaverActivate">QWSServer::screenSaverActivate</a>().</p>
 
47
<a name="//apple_ref/cpp/instm/QWSScreenSaver/save" />
 
48
<h3 class="fn"><a name="save"></a>bool QWSScreenSaver::save ( int <i>level</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
49
<p>Implement this function to activate the screensaver, saving the current screen.</p>
 
50
<p><a href="qt-embedded-linux.html">Qt for Embedded Linux</a> supports multilevel screen saving; i.e&#x2e;, it is possible to specify several different levels of screen responsiveness. For example, you can choose to first turn off the light before you fully activate the screensaver. Use the <a href="qwsserver.html#setScreenSaverIntervals">QWSServer::setScreenSaverIntervals</a>() to specify the time intervals between the different levels.</p>
 
51
<p>This function should return true if the screensaver successfully enters the given <i>level</i>; otherwise it should return false.</p>
 
52
<p>See also <a href="qwsscreensaver.html#restore">restore</a>() and <a href="qwsserver.html#screenSaverActivate">QWSServer::screenSaverActivate</a>().</p>
 
53
<p /><address><hr /><div align="center">
 
54
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
55
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
56
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
57
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
58
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
 
59
</html>