<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwindowsystem_qws.cpp -->
<title>Qt 4.8: QWSWindow Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QWSWindow</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QWSWindow Class Reference</h1>
<!-- $$$QWSWindow-brief -->
<p>The QWSWindow class encapsulates a top-level window in Qt for Embedded Linux. <a href="#details">More...</a></p>
<!-- @@@QWSWindow -->
<pre class="cpp"> <span class="preprocessor">#include <QWSWindow></span></pre><ul>
<li><a href="qwswindow-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#State-enum">State</a></b> { NoState, Hidden, Showing, Visible, ..., Destroyed }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QString & </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#caption">caption</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWSClient * </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#client">client</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRegion </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#dirtyOnScreen">dirtyOnScreen</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#isFullyObscured">isFullyObscured</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#isOpaque">isOpaque</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#isVisible">isVisible</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString & </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#name">name</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#opacity">opacity</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QRegion & </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#requestedRegion">requestedRegion</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#state">state</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#winId">winId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::WindowFlags </td><td class="memItemRight bottomAlign"><b><a href="qwswindow.html#windowFlags">windowFlags</a></b> () const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QWSWindow-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QWSWindow class encapsulates a top-level window in Qt for Embedded Linux.</p>
<p>When you run a <a href="qt-embedded-linux.html">Qt for Embedded Linux</a> application, it either runs as a server or connects to an existing server. As applications add and remove windows, the server process maintains information about each window. In <a href="qt-embedded-linux.html">Qt for Embedded Linux</a>, top-level windows are encapsulated as QWSWindow objects. Note that you should never construct the QWSWindow class yourself; the current top-level windows can be retrieved using the <a href="qwsserver.html#clientWindows">QWSServer::clientWindows</a>() function.</p>
<p>With a window at hand, you can retrieve its caption, name, opacity and ID using the <a href="qwswindow.html#caption">caption</a>(), <a href="qwswindow.html#name">name</a>(), <a href="qwswindow.html#opacity">opacity</a>() and <a href="qwswindow.html#winId">winId</a>() functions, respectively. Use the <a href="qwswindow.html#client">client</a>() function to retrieve a pointer to the client that owns the window.</p>
<p>Use the <a href="qwswindow.html#isVisible">isVisible</a>() function to find out if the window is visible. You can find out if the window is completely obscured by another window or by the bounds of the screen, using the <a href="qwswindow.html#isFullyObscured">isFullyObscured</a>() function. The <a href="qwswindow.html#isOpaque">isOpaque</a>() function returns true if the window has an alpha channel equal to 255. Finally, the <a href="qwswindow.html#requestedRegion">requestedRegion</a>() function returns the region of the display the window wants to draw on.</p>
</div>
<p><b>See also </b><a href="qwsserver.html">QWSServer</a>, <a href="qwsclient.html">QWSClient</a>, and <a href="qt-embedded-architecture.html">Qt for Embedded Linux Architecture</a>.</p>
<!-- @@@QWSWindow -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$State$$$NoState$$$Hidden$$$Showing$$$Visible$$$Hiding$$$Raising$$$Lowering$$$Moving$$$ChangingGeometry$$$Destroyed -->
<h3 class="fn"><a name="State-enum"></a>enum QWSWindow::<span class="name">State</span></h3>
<p>This enum describes the state of a window. Most of the transitional states are set just before a call to <a href="qscreen.html#exposeRegion">QScreen::exposeRegion</a>() and reset immediately afterwards.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QWSWindow::NoState</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Initial state before the window is properly initialized.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Hidden</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The window is not visible.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Showing</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The window is being shown.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Visible</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The window is visible, and not in a transition.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Hiding</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The window is being hidden.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Raising</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The windoe is being raised.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Lowering</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">The window is being raised.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Moving</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">The window is being moved.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::ChangingGeometry</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">The window's geometry is being changed.</td></tr>
<tr><td class="topAlign"><tt>QWSWindow::Destroyed</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">The window is destroyed.</td></tr>
</table>
<p><b>See also </b><a href="qwswindow.html#state">state</a>() and <a href="qscreen.html#exposeRegion">QScreen::exposeRegion</a>().</p>
<!-- @@@State -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$caption[overload1]$$$caption -->
<h3 class="fn"><a name="caption"></a>const <span class="type"><a href="qstring.html">QString</a></span> & QWSWindow::<span class="name">caption</span> () const</h3>
<p>Returns the window's caption.</p>
<p><b>See also </b><a href="qwswindow.html#name">name</a>() and <a href="qwswindow.html#winId">winId</a>().</p>
<!-- @@@caption -->
<!-- $$$client[overload1]$$$client -->
<h3 class="fn"><a name="client"></a><span class="type"><a href="qwsclient.html">QWSClient</a></span> * QWSWindow::<span class="name">client</span> () const</h3>
<p>Returns a reference to the <a href="qwsclient.html">QWSClient</a> object that owns this window.</p>
<p><b>See also </b><a href="qwswindow.html#requestedRegion">requestedRegion</a>().</p>
<!-- @@@client -->
<!-- $$$dirtyOnScreen[overload1]$$$dirtyOnScreen -->
<h3 class="fn"><a name="dirtyOnScreen"></a><span class="type"><a href="qregion.html">QRegion</a></span> QWSWindow::<span class="name">dirtyOnScreen</span> () const</h3>
<p>Returns the region that has been repainted since the previous <a href="qscreen.html#exposeRegion">QScreen::exposeRegion</a>(), and needs to be copied to the screen.</p>
<p>This function was introduced in Qt 4.3.</p>
<!-- @@@dirtyOnScreen -->
<!-- $$$isFullyObscured[overload1]$$$isFullyObscured -->
<h3 class="fn"><a name="isFullyObscured"></a><span class="type">bool</span> QWSWindow::<span class="name">isFullyObscured</span> () const</h3>
<p>Returns true if the window is completely obsured by another window or by the bounds of the screen; otherwise returns false.</p>
<p><b>See also </b><a href="qwswindow.html#isVisible">isVisible</a>().</p>
<!-- @@@isFullyObscured -->
<!-- $$$isOpaque[overload1]$$$isOpaque -->
<h3 class="fn"><a name="isOpaque"></a><span class="type">bool</span> QWSWindow::<span class="name">isOpaque</span> () const</h3>
<p>Returns true if the window is opaque, i.e., if its alpha channel equals 255; otherwise returns false.</p>
<p><b>See also </b><a href="qwswindow.html#opacity">opacity</a>().</p>
<!-- @@@isOpaque -->
<!-- $$$isVisible[overload1]$$$isVisible -->
<h3 class="fn"><a name="isVisible"></a><span class="type">bool</span> QWSWindow::<span class="name">isVisible</span> () const</h3>
<p>Returns true if the window is visible; otherwise returns false.</p>
<p><b>See also </b><a href="qwswindow.html#isFullyObscured">isFullyObscured</a>().</p>
<!-- @@@isVisible -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a>const <span class="type"><a href="qstring.html">QString</a></span> & QWSWindow::<span class="name">name</span> () const</h3>
<p>Returns the window's name, which is taken from the <a href="qobject.html#objectName-prop">objectName()</a> at the time of <a href="qwidget.html#show">show()</a>.</p>
<p><b>See also </b><a href="qwswindow.html#caption">caption</a>() and <a href="qwswindow.html#winId">winId</a>().</p>
<!-- @@@name -->
<!-- $$$opacity[overload1]$$$opacity -->
<h3 class="fn"><a name="opacity"></a><span class="type"><a href="qtglobal.html#uint-typedef">uint</a></span> QWSWindow::<span class="name">opacity</span> () const</h3>
<p>Returns the window's alpha channel value.</p>
<p><b>See also </b><a href="qwswindow.html#isOpaque">isOpaque</a>().</p>
<!-- @@@opacity -->
<!-- $$$requestedRegion[overload1]$$$requestedRegion -->
<h3 class="fn"><a name="requestedRegion"></a>const <span class="type"><a href="qregion.html">QRegion</a></span> & QWSWindow::<span class="name">requestedRegion</span> () const</h3>
<p>Returns the region that the window has requested to draw onto, including any window decorations.</p>
<p><b>See also </b><a href="qwswindow.html#client">client</a>().</p>
<!-- @@@requestedRegion -->
<!-- $$$state[overload1]$$$state -->
<h3 class="fn"><a name="state"></a><span class="type"><a href="qwswindow.html#State-enum">State</a></span> QWSWindow::<span class="name">state</span> () const</h3>
<p>Returns the current state of the window.</p>
<p>This function was introduced in Qt 4.3.</p>
<!-- @@@state -->
<!-- $$$winId[overload1]$$$winId -->
<h3 class="fn"><a name="winId"></a><span class="type">int</span> QWSWindow::<span class="name">winId</span> () const</h3>
<p>Returns the window's ID.</p>
<p><b>See also </b><a href="qwswindow.html#name">name</a>() and <a href="qwswindow.html#caption">caption</a>().</p>
<!-- @@@winId -->
<!-- $$$windowFlags[overload1]$$$windowFlags -->
<h3 class="fn"><a name="windowFlags"></a><span class="type"><a href="qt.html#WindowType-enum">Qt::WindowFlags</a></span> QWSWindow::<span class="name">windowFlags</span> () const</h3>
<p>Returns the window flags of the window. This value is only available after the first paint event.</p>
<p>This function was introduced in Qt 4.3.</p>
<!-- @@@windowFlags -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
