qwswindow(3qt)

1QWSWindow(3qt)                                                  QWSWindow(3qt)
2
3
4

NAME

6       QWSWindow - Server-specific functionality in Qt/Embedded
7

SYNOPSIS

9       #include <qwindowsystem_qws.h>
10
11   Public Members
12       QWSWindow ( int i, QWSClient * client )
13       ~QWSWindow ()
14       int winId () const
15       const QString & name () const
16       const QString & caption () const
17       QWSClient * client () const
18       QRegion requested () const
19       QRegion allocation () const
20       bool isVisible () const
21       bool isPartiallyObscured () const
22       bool isFullyObscured () const
23       void raise ()
24       void lower ()
25       void show ()
26       void hide ()
27       void setActiveWindow ()
28

DESCRIPTION

30       The QWSWindow class provides server-specific functionality in
31       Qt/Embedded.
32
33       When you run a Qt/Embedded application, it either runs as a server or
34       connects to an existing server. If it runs as a server, some additional
35       functionality is provided by the QWSServer class.
36
37       This class maintains information about each window and allows
38       operations to be performed on the windows.
39
40       You can get the window's name(), caption() and winId(), along with the
41       client() that owns the window.
42
43       The region the window wants to draw on is returned by requested(); the
44       region that the window is allowed to draw on is returned by
45       allocation().
46
47       The visibility of the window can be determined using isVisible(),
48       isPartiallyObscured() and isFullyObscured(). Visibility can be changed
49       using raise(), lower(), show(), hide() and setActiveWindow().
50
51       See also Qt/Embedded.
52

MEMBER FUNCTION DOCUMENTATION

QWSWindow::QWSWindow ( int i, QWSClient * client )

55       Constructs a new top-level window, associated with the client client
56       and giving it the id i.
57

QWSWindow::~QWSWindow ()

59       Destructor.
60

QRegion QWSWindow::allocation () const

62       Returns the region that the window is allowed to draw onto, including
63       any window decorations but excluding regions covered by other windows.
64
65       See also requested().
66

const QString & QWSWindow::caption () const

68       Returns the window's caption.
69

QWSClient * QWSWindow::client () const

71       Returns the QWSClient that owns this window.
72

void QWSWindow::hide ()

74       Hides the window.
75

bool QWSWindow::isFullyObscured () const

77       Returns TRUE if the window is completely obsured by another window or
78       by the bounds of the screen; otherwise returns FALSE.
79

bool QWSWindow::isPartiallyObscured () const

81       Returns TRUE if the window is partially obsured by another window or by
82       the bounds of the screen; otherwise returns FALSE.
83

bool QWSWindow::isVisible () const

85       Returns TRUE if the window is visible; otherwise returns FALSE.
86

void QWSWindow::lower ()

88       Lowers the window below other windows.
89

const QString & QWSWindow::name () const

91       Returns the window's name.
92

void QWSWindow::raise ()

94       Raises the window above all other windows except "Stay on top" windows.
95

QRegion QWSWindow::requested () const

97       Returns the region that the window has requested to draw onto,
98       including any window decorations.
99
100       See also allocation().
101

void QWSWindow::setActiveWindow ()

103       Make this the active window (i.e. sets the keyboard focus to this
104       window).
105

void QWSWindow::show ()

107       Shows the window.
108

int QWSWindow::winId () const

110       Returns the window's Id.
111
112

COPYRIGHT

118       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
119       license file included in the distribution for a complete license
120       statement.
121

AUTHOR

123       Generated automatically from the source code.
124

BUGS

126       If you find a bug in Qt, please report it as described in
127       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
128       help you. Thank you.
129
130       The definitive Qt documentation is provided in HTML format; it is
131       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
132       web browser. This man page is provided as a convenience for those users
133       who prefer man pages, although this format is not officially supported
134       by Trolltech.
135
136       If you find errors in this manual page, please report them to qt-
137       bugs@trolltech.com.  Please include the name of the manual page
138       (qwswindow.3qt) and the Qt version (3.3.8).
139
140
141
142Trolltech AS                    2 February 2007                 QWSWindow(3qt)