QWindow Class

Member Function Documentation

QWindow::QWindow(QScreen * targetScreen = 0)

Creates a window as a top level on the given screen.

The window is not shown until setVisible(true), show(), or similar is called.

See also setScreen().

QWindow::QWindow(QWindow * parent)

Creates a window as a child of the given parent window.

The window will be embedded inside the parent window, its coordinates relative to the parent.

The screen is inherited from the parent.

See also setParent().

QWindow::QWindow(QWindowPrivate & dd, QWindow * parent) [protected]

QWindow::~QWindow() [virtual]

Destroys the window.

QSize QWindow::baseSize() const

Returns the base size of the window.

See also setBaseSize().

bool QWindow::close() [slot]

Close the window.

This closes the window, effectively calling destroy(), and potentially quitting the application

See also destroy() and QGuiApplication::quitOnLastWindowClosed().

void QWindow::create()

Allocates the platform resources associated with the window.

It is at this point that the surface format set using setFormat() gets resolved into an actual native surface. However, the window remains hidden until setVisible() is called.

Note that it is not usually necessary to call this function directly, as it will be implicitly called by show(), setVisible(), and other functions that require access to the platform resources.

Call destroy() to free the platform resources if necessary.

See also destroy().

void QWindow::destroy()

Releases the native platform resources associated with this window.

See also create().

bool QWindow::event(QEvent * ev) [virtual protected]

Reimplemented from QObject::event().

Override this to handle any event sent to the window.

Remember to call the base class version if you wish for mouse events, key events, resize events, etc to be dispatched as usual.

void QWindow::exposeEvent(QExposeEvent * ev) [virtual protected]

The expose event is sent by the window system whenever the window's exposure on screen changes.

The application can start rendering into the window with QBackingStore and QOpenGLContext as soon as it gets an exposeEvent() such that isExposed() is true.

If the window is moved off screen, is made totally obscured by another window, iconified or similar, this function might be called and the value of isExposed() might change to false. When this happens, an application should stop its rendering as it is no longer visible to the user.

A resize event will always be sent before the expose event the first time a window is shown.

See also isExposed().

void QWindow::focusInEvent(QFocusEvent * ev) [virtual protected]

Override this to handle focus in events.

Focus in events are sent when the window receives keyboard focus.

See also focusOutEvent.

QObject * QWindow::focusObject() const [virtual]

Returns the QObject that will be the final receiver of events tied focus, such as key events.

void QWindow::focusObjectChanged(QObject * focusObject) [signal]

This signal is emitted when final receiver of events tied to focus is changed.

See also focusObject().

void QWindow::focusOutEvent(QFocusEvent * ev) [virtual protected]

Override this to handle focus out events.

Focus out events are sent when the window loses keyboard focus.

See also focusInEvent.

QSurfaceFormat QWindow::format() const [virtual]

Reimplemented from QSurface::format().

Returns the actual format of this window.

After the window has been created, this function will return the actual surface format of the window. It might differ from the requested format if the requested format could not be fulfilled by the platform.

See also setFormat(), create(), and requestedFormat().

QRect QWindow::frameGeometry() const

Returns the geometry of the window, including its window frame.

See also geometry() and frameMargins().

QMargins QWindow::frameMargins() const

Returns the window frame margins surrounding the window.

See also geometry() and frameGeometry().

QPoint QWindow::framePos() const

Returns the top left position of the window, including its window frame.

This returns the same value as frameGeometry().topLeft().

See also setFramePos(), geometry(), and frameGeometry().

QRect QWindow::geometry() const

Returns the geometry of the window, excluding its window frame.

See also setGeometry(), frameMargins(), and frameGeometry().

void QWindow::hide() [slot]

Hides the window.

Equivalent to calling setVisible(false).

See also show() and setVisible().

void QWindow::hideEvent(QHideEvent * ev) [virtual protected]

Override this to handle hide evens.

The function is called when the window has requested being hidden in the windowing system.

bool QWindow::isActive() const

Returns true if the window should appear active from a style perspective.

This is the case for the window that has input focus as well as windows that are in the same parent / transient parent chain as the focus window.

To get the window that currently has focus, use QGuiApplication::focusWindow().

bool QWindow::isAncestorOf(const QWindow * child, AncestorMode mode = IncludeTransients) const

Returns true if the window is an ancestor of the given child. If mode is IncludeTransients transient parents are also considered ancestors.

bool QWindow::isExposed() const

Returns if this window is exposed in the windowing system.

When the window is not exposed, it is shown by the application but it is still not showing in the windowing system, so the application should minimize rendering and other graphical activities.

An exposeEvent() is sent every time this value changes.

See also exposeEvent().

bool QWindow::isModal() const

Returns whether the window is modal.

A modal window prevents other windows from getting any input.

See also QWindow::windowModality.

bool QWindow::isTopLevel() const

Returns whether the window is top level, i.e. has no parent window.

void QWindow::keyPressEvent(QKeyEvent * ev) [virtual protected]

Override this to handle key press events.

See also keyReleaseEvent.

void QWindow::keyReleaseEvent(QKeyEvent * ev) [virtual protected]

Override this to handle key release events.

See also keyPressEvent.

void QWindow::lower() [slot]

Lower the window in the windowing system.

Requests that the window be lowered to appear below other windows.

QPoint QWindow::mapFromGlobal(const QPoint & pos) const

Translates the global screen coordinate pos to window coordinates.

See also mapToGlobal().

QPoint QWindow::mapToGlobal(const QPoint & pos) const

Translates the window coordinate pos to global screen coordinates. For example, mapToGlobal(QPoint(0,0)) would give the global coordinates of the top-left pixel of the window.

See also mapFromGlobal().

QSize QWindow::maximumSize() const

Returns the maximum size of the window.

See also setMaximumSize().

QSize QWindow::minimumSize() const

Returns the minimum size of the window.

See also setMinimumSize().

void QWindow::mouseDoubleClickEvent(QMouseEvent * ev) [virtual protected]

Override this to handle mouse double click events.

See also mousePressEvent() and QStyleHints::mouseDoubleClickInterval().

void QWindow::mouseMoveEvent(QMouseEvent * ev) [virtual protected]

Override this to handle mouse move events.

void QWindow::mousePressEvent(QMouseEvent * ev) [virtual protected]

Override this to handle mouse press events.

See also mouseReleaseEvent().

void QWindow::mouseReleaseEvent(QMouseEvent * ev) [virtual protected]

Override this to handle mouse release events.

See also mousePressEvent().

void QWindow::moveEvent(QMoveEvent * ev) [virtual protected]

Override this to handle mouse events.

bool QWindow::nativeEvent(const QByteArray & eventType, void * message, long * result) [virtual protected]

Override this to handle platform dependent events.

This might make your application non-portable.

QWindow * QWindow::parent() const

Returns the parent window, if any.

A window without a parent is known as a top level window.

See also setParent().

QPoint QWindow::pos() const

See also setPos().

void QWindow::raise() [slot]

Raise the window in the windowing system.

Requests that the window be raised to appear above other windows.

void QWindow::requestActivateWindow()

Requests the window to be activated, i.e. receive keyboard focus.

See also isActive() and QGuiApplication::focusWindow().

bool QWindow::requestWindowOrientation(Qt::ScreenOrientation orientation)

Requests the given window orientation.

The window orientation specifies how the window should be rotated by the window manager in order to be displayed. Input events will be correctly mapped to the given orientation.

The return value is false if the system doesn't support the given orientation (for example when requesting a portrait orientation on a device that only handles landscape buffers, typically a desktop system).

If the return value is false, call windowOrientation() to get the actual supported orientation.

See also windowOrientation(), reportContentOrientationChange(), and QScreen::orientation().

QSurfaceFormat QWindow::requestedFormat() const

Returns the requested surfaceformat of this window.

If the requested format was not supported by the platform implementation, the requestedFormat will differ from the actual window format.

This is the value set with setFormat().

See also setFormat() and format().

void QWindow::resize(const QSize & newSize)

Sets the size of the window to be newSize.

See also setGeometry().

void QWindow::resize(int w, int h)

void QWindow::resizeEvent(QResizeEvent * ev) [virtual protected]

Override this to handle resize events.

The resize event is called whenever the window is resized in the windowing system, either directly through the windowing system acknowledging a setGeometry() or resize() request, or indirectly through the user resizing the window manually.

QScreen * QWindow::screen() const

Returns the screen on which the window is shown.

The value returned will not change when the window is moved between virtual screens (as returned by QScreen::virtualSiblings()).

See also setScreen() and QScreen::virtualSiblings().

void QWindow::screenChanged(QScreen * screen) [signal]

This signal is emitted when a window's screen changes, either by being set explicitly with setScreen(), or automatically when the window's screen is removed.

void QWindow::setBaseSize(const QSize & size)

Sets the base size of the window.

The base size is used to calculate a proper window size if the window defines sizeIncrement().

See also setMinimumSize(), setMaximumSize(), setSizeIncrement(), and baseSize().

void QWindow::setFormat(const QSurfaceFormat & format)

Sets the window's surface format.

The format determines properties such as color depth, alpha, depth and stencil buffer size, etc.

See also format().

void QWindow::setFramePos(const QPoint & point)

Sets the upper left position of the window including its window frame.

See also framePos(), setGeometry(), and frameGeometry().

void QWindow::setGeometry(int posx, int posy, int w, int h)

See also geometry().

void QWindow::setGeometry(const QRect & rect)

Sets the geometry of the window, excluding its window frame, to rect.

To make sure the window is visible, make sure the geometry is within the virtual geometry of its screen.

See also geometry(), screen(), and QScreen::virtualGeometry().

bool QWindow::setKeyboardGrabEnabled(bool grab)

Set whether keyboard grab should be enabled or not.

If the return value is true, the window receives all key events until setKeyboardGrabEnabled(false) is called; other windows get no key events at all. Mouse events are not affected. Use setMouseGrabEnabled() if you want to grab that.

See also setMouseGrabEnabled().

void QWindow::setMaximumSize(const QSize & size)

Sets the maximum size of the window.

This is a hint to the window manager to prevent resizing above the specified size.

See also setMinimumSize() and maximumSize().

void QWindow::setMinimumSize(const QSize & size)

Sets the minimum size of the window.

This is a hint to the window manager to prevent resizing below the specified size.

See also setMaximumSize() and minimumSize().

bool QWindow::setMouseGrabEnabled(bool grab)

Sets whether mouse grab should be enabled or not.

If the return value is true, the window receives all mouse events until setMouseGrabEnabled(false) is called; other windows get no mouse events at all. Keyboard events are not affected. Use setKeyboardGrabEnabled() if you want to grab that.

See also setKeyboardGrabEnabled().

void QWindow::setOpacity(qreal level)

Sets the window's opacity in the windowing system to level.

If the windowing system supports window opacity, this can be used to fade the window in and out, or to make it semitransparent.

A value of 1.0 or above is treated as fully opaque, whereas a value of 0.0 or below is treated as fully transparent. Values inbetween represent varying levels of translucency between the two extremes.

void QWindow::setParent(QWindow * parent)

Sets the parent Window. This will lead to the windowing system managing the clip of the window, so it will be clipped to the parent window.

Setting parent to be 0 will make the window become a top level window.

See also parent().

void QWindow::setPos(const QPoint & pt)

See also pos().

void QWindow::setPos(int posx, int posy)

void QWindow::setScreen(QScreen * newScreen)

Sets the screen on which the window should be shown.

If the window has been created, it will be recreated on the new screen.

Note that if the screen is part of a virtual desktop of multiple screens, the window can appear on any of the screens returned by QScreen::virtualSiblings().

See also screen() and QScreen::virtualSiblings().

void QWindow::setSizeIncrement(const QSize & size)

Sets the size increment of the window.

When the user resizes the window, the size will move in steps of sizeIncrement().width() pixels horizontally and sizeIncrement().height() pixels vertically, with baseSize() as the basis.

By default, this property contains a size with zero width and height.

The windowing system might not support size increments.

See also sizeIncrement(), setBaseSize(), setMinimumSize(), and setMaximumSize().

void QWindow::setSurfaceType(SurfaceType surfaceType)

Set the surfaceType of the window.

Specifies whether the window is meant for raster rendering with QBackingStore, or OpenGL rendering with QOpenGLContext.

See also surfaceType(), QBackingStore, and QOpenGLContext.

void QWindow::setTransientParent(QWindow * parent)

Sets the transient parent

This is a hint to the window manager that this window is a dialog or pop-up on behalf of the given window.

See also transientParent() and parent().

void QWindow::setWindowFlags(Qt::WindowFlags flags)

Sets the window flags of the window to flags.

The window flags control the window's appearance in the windowing system, whether it's a dialog, popup, or a regular window, and whether it should have a title bar, etc.

See also windowFlags().

void QWindow::setWindowState(Qt::WindowState state)

Sets the desired window state.

The window state represents whether the window appears in the windowing system as maximized, minimized, fullscreen, or normal.

The enum value Qt::WindowActive is not an accepted parameter.

See also windowState(), showNormal(), showFullScreen(), showMinimized(), and showMaximized().

void QWindow::show() [slot]

Shows the window.

This equivalent to calling showFullScreen() or showNormal(), depending on whether the platform defaults to windows being fullscreen or not.

See also showFullScreen(), showNormal(), hide(), and QStyleHints::showIsFullScreen().

void QWindow::showEvent(QShowEvent * ev) [virtual protected]

Override this to handle show events.

The function is called when the window has requested becoming visible.

If the window is successfully shown by the windowing system, this will be followed by a resize and an expose event.

void QWindow::showFullScreen() [slot]

Shows the window as fullscreen.

Equivalent to calling setWindowState(Qt::WindowFullScreen) and then setVisible(true).

See also setWindowState() and setVisible().

void QWindow::showMaximized() [slot]

Shows the window as maximized.

Equivalent to calling setWindowState(Qt::WindowMaximized) and then setVisible(true).

See also setWindowState() and setVisible().

void QWindow::showMinimized() [slot]

Shows the window as minimized.

Equivalent to calling setWindowState(Qt::WindowMinimized) and then setVisible(true).

See also setWindowState() and setVisible().

void QWindow::showNormal() [slot]

Shows the window as normal, i.e. neither maximized, minimized, nor fullscreen.

Equivalent to calling setWindowState(Qt::WindowNoState) and then setVisible(true).

See also setWindowState() and setVisible().

QSize QWindow::size() const [virtual]

QSize QWindow::sizeIncrement() const

Returns the size increment of the window.

See also setSizeIncrement().

SurfaceType QWindow::surfaceType() const [virtual]

Reimplemented from QSurface::surfaceType().

Returns the surface type of the window.

See also setSurfaceType().

void QWindow::touchEvent(QTouchEvent * ev) [virtual protected]

Override this to handle touch events.

QWindow * QWindow::transientParent() const

Returns the transient parent of the window.

See also setTransientParent() and parent().

void QWindow::wheelEvent(QWheelEvent * ev) [virtual protected]

Override this to handle mouse wheel or other wheel events.

WId QWindow::winId() const

Returns the window's platform id.

For platforms where this id might be useful, the value returned will uniquely represent the window inside the corresponding screen.

See also screen().

Qt::WindowFlags QWindow::windowFlags() const

Returns the window flags of the window.

This might differ from the flags set with setWindowFlags() if the requested flags could not be fulfilled.

See also setWindowFlags().

Qt::ScreenOrientation QWindow::windowOrientation() const

Returns the actual window orientation.

The default value is Qt::PrimaryOrientation.

See also requestWindowOrientation().

Qt::WindowState QWindow::windowState() const

Returns the window state.

See also setWindowState().

Qt::WindowType QWindow::windowType() const

Returns the type of the window.

This returns the part of the window flags that represents whether the window is a dialog, tooltip, popup, regular window, etc.

See also windowFlags() and setWindowFlags().