summaryrefslogtreecommitdiffstats
path: root/doc/html/qwswindow.html
blob: 20fafefb7b5b5e02031197901aacec6dd38ece26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qwindowsystem_qws.cpp:164 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QWSWindow Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<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>

<p>The QWSWindow class provides server-specific functionality in Qt/Embedded.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qwindowsystem_qws-h.html">qwindowsystem_qws.h</a>&gt;</tt>
<p><a href="qwswindow-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QWSWindow"><b>QWSWindow</b></a> ( int&nbsp;i, QWSClient&nbsp;*&nbsp;client )</li>
<li class=fn><a href="#~QWSWindow"><b>~QWSWindow</b></a> ()</li>
<li class=fn>int <a href="#winId"><b>winId</b></a> () const</li>
<li class=fn>const QString &amp; <a href="#name"><b>name</b></a> () const</li>
<li class=fn>const QString &amp; <a href="#caption"><b>caption</b></a> () const</li>
<li class=fn>QWSClient * <a href="#client"><b>client</b></a> () const</li>
<li class=fn>QRegion <a href="#requested"><b>requested</b></a> () const</li>
<li class=fn>QRegion <a href="#allocation"><b>allocation</b></a> () const</li>
<li class=fn>bool <a href="#isVisible"><b>isVisible</b></a> () const</li>
<li class=fn>bool <a href="#isPartiallyObscured"><b>isPartiallyObscured</b></a> () const</li>
<li class=fn>bool <a href="#isFullyObscured"><b>isFullyObscured</b></a> () const</li>
<li class=fn>void <a href="#raise"><b>raise</b></a> ()</li>
<li class=fn>void <a href="#lower"><b>lower</b></a> ()</li>
<li class=fn>void <a href="#show"><b>show</b></a> ()</li>
<li class=fn>void <a href="#hide"><b>hide</b></a> ()</li>
<li class=fn>void <a href="#setActiveWindow"><b>setActiveWindow</b></a> ()</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QWSWindow class provides server-specific functionality in Qt/Embedded.
<p> 
<p> When you run a Qt/Embedded application, it either runs as a server
or connects to an existing server. If it runs as a server, some
additional functionality is provided by the <a href="qwsserver.html">QWSServer</a> class.
<p> This class maintains information about each window and allows
operations to be performed on the windows.
<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
the <a href="#client">client</a>() that owns the window.
<p> The region the window wants to draw on is returned by <a href="#requested">requested</a>();
the region that the window is allowed to draw on is returned by
<a href="#allocation">allocation</a>().
<p> The visibility of the window can be determined using <a href="#isVisible">isVisible</a>(),
<a href="#isPartiallyObscured">isPartiallyObscured</a>() and <a href="#isFullyObscured">isFullyObscured</a>(). Visibility can be
changed using <a href="#raise">raise</a>(), <a href="#lower">lower</a>(), <a href="#show">show</a>(), <a href="#hide">hide</a>() and
<a href="#setActiveWindow">setActiveWindow</a>().
<p>See also <a href="qws.html">Qt/Embedded</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QWSWindow"></a>QWSWindow::QWSWindow ( int&nbsp;i, QWSClient&nbsp;*&nbsp;client )
</h3>

<p> Constructs a new top-level window, associated with the client <em>client</em> and giving it the id <em>i</em>.

<h3 class=fn><a name="~QWSWindow"></a>QWSWindow::~QWSWindow ()
</h3>
Destructor.

<h3 class=fn><a href="qregion.html">QRegion</a> <a name="allocation"></a>QWSWindow::allocation () const
</h3>

<p> Returns the region that the window is allowed to draw onto,
including any window decorations but excluding regions covered by
other windows.
<p> <p>See also <a href="#requested">requested</a>().

<h3 class=fn>const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp; <a name="caption"></a>QWSWindow::caption () const
</h3>

<p> Returns the window's caption.

<h3 class=fn>QWSClient * <a name="client"></a>QWSWindow::client () const
</h3>

<p> Returns the QWSClient that owns this window.

<h3 class=fn>void <a name="hide"></a>QWSWindow::hide ()
</h3>
Hides the window.

<h3 class=fn>bool <a name="isFullyObscured"></a>QWSWindow::isFullyObscured () const
</h3>

<p> Returns TRUE if the window is completely obsured by another window
or by the bounds of the screen; otherwise returns FALSE.

<h3 class=fn>bool <a name="isPartiallyObscured"></a>QWSWindow::isPartiallyObscured () const
</h3>

<p> Returns TRUE if the window is partially obsured by another window
or by the bounds of the screen; otherwise returns FALSE.

<h3 class=fn>bool <a name="isVisible"></a>QWSWindow::isVisible () const
</h3>

<p> Returns TRUE if the window is visible; otherwise returns FALSE.

<h3 class=fn>void <a name="lower"></a>QWSWindow::lower ()
</h3>
Lowers the window below other windows.

<h3 class=fn>const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp; <a name="name"></a>QWSWindow::name () const
</h3>

<p> Returns the window's name.

<h3 class=fn>void <a name="raise"></a>QWSWindow::raise ()
</h3>
Raises the window above all other windows except "Stay on top" windows.

<h3 class=fn><a href="qregion.html">QRegion</a> <a name="requested"></a>QWSWindow::requested () const
</h3>

<p> Returns the region that the window has requested to draw onto,
including any window decorations.
<p> <p>See also <a href="#allocation">allocation</a>().

<h3 class=fn>void <a name="setActiveWindow"></a>QWSWindow::setActiveWindow ()
</h3>
Make this the active window (i.e. sets the <a href="focus.html#keyboard-focus">keyboard focus</a> to this
window).

<h3 class=fn>void <a name="show"></a>QWSWindow::show ()
</h3>
Shows the window.

<h3 class=fn>int <a name="winId"></a>QWSWindow::winId () const
</h3>

<p> Returns the window's Id.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>