source: trunk/doc/html/qwswindow.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added
File size: 7.2 KB
RevLine 
[190]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qwindowsystem_qws.cpp:164 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QWSWindow Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QWSWindow Class Reference</h1>
33
34<p>The QWSWindow class provides server-specific functionality in Qt/Embedded.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qwindowsystem_qws-h.html">qwindowsystem_qws.h</a>&gt;</tt>
37<p><a href="qwswindow-members.html">List of all member functions.</a>
38<h2>Public Members</h2>
39<ul>
40<li class=fn><a href="#QWSWindow"><b>QWSWindow</b></a> ( int&nbsp;i, QWSClient&nbsp;*&nbsp;client )</li>
41<li class=fn><a href="#~QWSWindow"><b>~QWSWindow</b></a> ()</li>
42<li class=fn>int <a href="#winId"><b>winId</b></a> () const</li>
43<li class=fn>const QString &amp; <a href="#name"><b>name</b></a> () const</li>
44<li class=fn>const QString &amp; <a href="#caption"><b>caption</b></a> () const</li>
45<li class=fn>QWSClient * <a href="#client"><b>client</b></a> () const</li>
46<li class=fn>QRegion <a href="#requested"><b>requested</b></a> () const</li>
47<li class=fn>QRegion <a href="#allocation"><b>allocation</b></a> () const</li>
48<li class=fn>bool <a href="#isVisible"><b>isVisible</b></a> () const</li>
49<li class=fn>bool <a href="#isPartiallyObscured"><b>isPartiallyObscured</b></a> () const</li>
50<li class=fn>bool <a href="#isFullyObscured"><b>isFullyObscured</b></a> () const</li>
51<li class=fn>void <a href="#raise"><b>raise</b></a> ()</li>
52<li class=fn>void <a href="#lower"><b>lower</b></a> ()</li>
53<li class=fn>void <a href="#show"><b>show</b></a> ()</li>
54<li class=fn>void <a href="#hide"><b>hide</b></a> ()</li>
55<li class=fn>void <a href="#setActiveWindow"><b>setActiveWindow</b></a> ()</li>
56</ul>
57<hr><a name="details"></a><h2>Detailed Description</h2>
58
59
60The QWSWindow class provides server-specific functionality in Qt/Embedded.
61<p>
62<p> When you run a Qt/Embedded application, it either runs as a server
63or connects to an existing server. If it runs as a server, some
64additional functionality is provided by the <a href="qwsserver.html">QWSServer</a> class.
65<p> This class maintains information about each window and allows
66operations to be performed on the windows.
67<p> You can get the window's <a href="#name">name</a>(), <a href="#caption">caption</a>() and <a href="#winId">winId</a>(), along with
68the <a href="#client">client</a>() that owns the window.
69<p> The region the window wants to draw on is returned by <a href="#requested">requested</a>();
70the region that the window is allowed to draw on is returned by
71<a href="#allocation">allocation</a>().
72<p> The visibility of the window can be determined using <a href="#isVisible">isVisible</a>(),
73<a href="#isPartiallyObscured">isPartiallyObscured</a>() and <a href="#isFullyObscured">isFullyObscured</a>(). Visibility can be
74changed using <a href="#raise">raise</a>(), <a href="#lower">lower</a>(), <a href="#show">show</a>(), <a href="#hide">hide</a>() and
75<a href="#setActiveWindow">setActiveWindow</a>().
76<p>See also <a href="qws.html">Qt/Embedded</a>.
77
78<hr><h2>Member Function Documentation</h2>
79<h3 class=fn><a name="QWSWindow"></a>QWSWindow::QWSWindow ( int&nbsp;i, QWSClient&nbsp;*&nbsp;client )
80</h3>
81
82<p> Constructs a new top-level window, associated with the client <em>client</em> and giving it the id <em>i</em>.
83
84<h3 class=fn><a name="~QWSWindow"></a>QWSWindow::~QWSWindow ()
85</h3>
86Destructor.
87
88<h3 class=fn><a href="qregion.html">QRegion</a> <a name="allocation"></a>QWSWindow::allocation () const
89</h3>
90
91<p> Returns the region that the window is allowed to draw onto,
92including any window decorations but excluding regions covered by
93other windows.
94<p> <p>See also <a href="#requested">requested</a>().
95
96<h3 class=fn>const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp; <a name="caption"></a>QWSWindow::caption () const
97</h3>
98
99<p> Returns the window's caption.
100
101<h3 class=fn>QWSClient * <a name="client"></a>QWSWindow::client () const
102</h3>
103
104<p> Returns the QWSClient that owns this window.
105
106<h3 class=fn>void <a name="hide"></a>QWSWindow::hide ()
107</h3>
108Hides the window.
109
110<h3 class=fn>bool <a name="isFullyObscured"></a>QWSWindow::isFullyObscured () const
111</h3>
112
113<p> Returns TRUE if the window is completely obsured by another window
114or by the bounds of the screen; otherwise returns FALSE.
115
116<h3 class=fn>bool <a name="isPartiallyObscured"></a>QWSWindow::isPartiallyObscured () const
117</h3>
118
119<p> Returns TRUE if the window is partially obsured by another window
120or by the bounds of the screen; otherwise returns FALSE.
121
122<h3 class=fn>bool <a name="isVisible"></a>QWSWindow::isVisible () const
123</h3>
124
125<p> Returns TRUE if the window is visible; otherwise returns FALSE.
126
127<h3 class=fn>void <a name="lower"></a>QWSWindow::lower ()
128</h3>
129Lowers the window below other windows.
130
131<h3 class=fn>const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp; <a name="name"></a>QWSWindow::name () const
132</h3>
133
134<p> Returns the window's name.
135
136<h3 class=fn>void <a name="raise"></a>QWSWindow::raise ()
137</h3>
138Raises the window above all other windows except "Stay on top" windows.
139
140<h3 class=fn><a href="qregion.html">QRegion</a> <a name="requested"></a>QWSWindow::requested () const
141</h3>
142
143<p> Returns the region that the window has requested to draw onto,
144including any window decorations.
145<p> <p>See also <a href="#allocation">allocation</a>().
146
147<h3 class=fn>void <a name="setActiveWindow"></a>QWSWindow::setActiveWindow ()
148</h3>
149Make this the active window (i.e. sets the <a href="focus.html#keyboard-focus">keyboard focus</a> to this
150window).
151
152<h3 class=fn>void <a name="show"></a>QWSWindow::show ()
153</h3>
154Shows the window.
155
156<h3 class=fn>int <a name="winId"></a>QWSWindow::winId () const
157</h3>
158
159<p> Returns the window's Id.
160
161<!-- eof -->
162<hr><p>
163This file is part of the <a href="index.html">Qt toolkit</a>.
164Copyright &copy; 1995-2007
165<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
166<table width=100% cellspacing=0 border=0><tr>
167<td>Copyright &copy; 2007
168<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
169<td align=right><div align=right>Qt 3.3.8</div>
170</table></div></address></body>
171</html>
Note: See TracBrowser for help on using the repository browser.