|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QWSWindow Class Reference
[QtGui module]

The QWSWindow class encapsulates a top-level window in Qtopia Core. More...

     #include <QWSWindow>

- List of all members, including inherited members

### Public Types

- enum State { NoState, Hidden, Showing, Visible, ..., Destroyed }

### Public Functions

- const QString & caption () const
- QWSClient * client () const
- QRegion dirtyOnScreen () const
- bool isFullyObscured () const
- bool isOpaque () const
- bool isVisible () const
- const QString & name () const
- uint opacity () const
- const QRegion & requestedRegion () const
- State state () const
- int winId () const
- Qt::WindowFlags windowFlags () const

## Detailed Description

The QWSWindow class encapsulates a top-level window in Qtopia Core.

When you run a Qtopia Core 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 Qtopia Core, 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 QWSServer::clientWindows() function.

With a window at hand, you can retrieve its caption, name, opacity and ID using the caption(), name(), opacity() and winId() functions, respectively. Use the client() function to retrieve a pointer to the client that owns the window.

Use the isVisible() 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 isFullyObscured() function. The isOpaque() function returns true if the window has an alpha channel equal to 255. Finally, the requestedRegion() function returns the region of the display the window wants to draw on.

See also QWSServer, QWSClient, and Qtopia Core Architecture.

## Member Type Documentation

### enum QWSWindow::State

This enum describes the state of a window. Most of the transitional states are set just before a call to QScreen::exposeRegion(), and reset immediately afterwards.

Constant | Value | Description
--- | --- | ---
`QWSWindow::NoState` | `0` | Initial state before the window is properly initialized.
`QWSWindow::Hidden` | `1` | The window is not visible.
`QWSWindow::Showing` | `2` | The window is being shown.
`QWSWindow::Visible` | `3` | The window is visible, and not in a transition.
`QWSWindow::Hiding` | `4` | The window is being hidden.
`QWSWindow::Raising` | `5` | The windoe is being raised.
`QWSWindow::Lowering` | `6` | The window is being raised.
`QWSWindow::Moving` | `7` | The window is being moved.
`QWSWindow::GeometryChanging` | ? | The window's geometry is being changed.
`QWSWindow::Destroyed` | `9` | The window is destroyed.

See also state() and QScreen::exposeRegion.

## Member Function Documentation

### const QString & QWSWindow::caption () const

Returns the window's caption.

See also name() and winId().

### QWSClient * QWSWindow::client () const

Returns a reference to the QWSClient object that owns this window.

See also requestedRegion().

### QRegion QWSWindow::dirtyOnScreen () const

### bool QWSWindow::isFullyObscured () const

Returns true if the window is completely obsured by another window or by the bounds of the screen; otherwise returns false.

See also isVisible().

### bool QWSWindow::isOpaque () const

Returns true if the window is opaque, i.e., if its alpha channel equals 255; otherwise returns false.

See also opacity().

### bool QWSWindow::isVisible () const

Returns true if the window is visible; otherwise returns false.

See also isFullyObscured().

### const QString & QWSWindow::name () const

Returns the window's name.

See also caption() and winId().

### uint QWSWindow::opacity () const

Returns the window's alpha channel value.

See also isOpaque().

### const QRegion & QWSWindow::requestedRegion () const

Returns the region that the window has requested to draw onto, including any window decorations.

See also client().

### State QWSWindow::state () const

### int QWSWindow::winId () const

Returns the window's ID.

See also name() and caption().

### Qt::WindowFlags QWSWindow::windowFlags () const