This enum is used to control whether or not transient parents should be considered ancestors.

This enum describes what part of the screen the window occupies or should occupy.

Creates a window as a top level on the screen. The window is not shown until setVisible(true), show(), or similar is called.

See also

setScreen()

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()

Destroys the window.

Causes an alert to be shown for msec milliseconds. If msec is 0 (the default) then the alert is shown indefinitely until the window becomes active again. This method has no effect on an active window.

In alert state, the window indicates that it demands attention, for example by flashing or bouncing the taskbar entry.

Returns the base size of the window.

See also

setBaseSize()

This method closes the window, effectively calling destroy() and potentially quitting the application. Returns true on success, false if it has a parent window (in which case the top level window should be closed instead).

See also

destroy(), QApplication::quitOnLastWindowClosed()

Returns the value of the QWindow::contentOrientation property.

This signal is emitted when the value of the QWindow::contentOrientation property changes. The specified orientation represents the updated value.

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.

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

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

See also

destroy()

Returns the cursor shape for this window.

See also

setCursor(), unsetCursor()

Releases the native platform resources associated with this window.

See also

create()

Returns the ratio between physical pixels and device-independent pixels for the window. This value is dependent on the screen the window is on, and may change when the window is moved.

Common values are 1.0 on normal displays and 2.0 on Apple "retina" displays.

Note

For windows not backed by a platform window, meaning that create() was not called, the function will fall back to QApplication::devicePixelRatio() which in turn returns the highest screen device pixel ratio found on the system.

See also

QScreen::devicePixelRatio(), QApplication::devicePixelRatio()

Override this to handle any event (event) sent to the window. Return true if the event was recognized and processed. Remember to call the base class version if you wish for mouse events, key events, resize events, etc to be dispatched as usual.

The expose event (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()

Reimplemented in QVulkanWindow::exposeEvent()

Returns the file name this window is representing.

See also

setFilePath()

Returns the value of the property.

Override this to handle focus in events (event). Focus in events are sent when the window receives keyboard focus.

See also

focusOutEvent()

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

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

See also

focusObject()

Override this to handle focus out events (event). Focus out events are sent when the window loses keyboard focus.

See also

focusInEvent()

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. It might also be a superset, for example certain buffer sizes may be larger than requested.

Note

Depending on the platform, certain values in this surface format may still contain the requested values, that is, the values that have been passed to setFormat(). Typical examples are the OpenGL version, profile and options. These may not get updated during create() since these are context specific and a single window may be used together with multiple contexts over its lifetime. Use the QOpenGLContext format() instead to query such values.

See also

create(), requestedFormat(), QOpenGLContext::format()

Implements QSurface::format()

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

See also

geometry(), frameMargins()

Returns the window frame margins surrounding the window.

See also

geometry(), frameGeometry()

Returns the top left position of the window, including its window frame. This returns the same value as frameGeometry().topLeft().

See also

geometry(), frameGeometry()

Creates a local representation of a window created by another process or by using native libraries other than CopperSpice.

Given the handle id to a native window, this method creates a QWindow object which can be used to represent the window when invoking methods like setParent() and setTransientParent(). This can be used, on platforms which support it, to embed a QWindow inside a native window, or to embed a native window inside a QWindow.

If foreign windows are not supported, this function returns a nullptr.

Note

The resulting QWindow should not be used to manipulate the underlying native window (besides re-parenting), or to observe state changes of the native window. Any support for these kind of operations is incidental, highly platform dependent and untested.

See also

setParent(), setTransientParent()

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

See also

frameMargins(), frameGeometry()

Hides the window. Equivalent to calling setVisible(false).

See also

show(), setVisible()

Override this to handle hide events (event). The method is called when the window has requested being hidden in the windowing system.

Sets the window's icon in the windowing system

See also

setIcon()

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 QApplication::focusWindow().

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

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()

Returns whether the window is modal. A modal window prevents other windows from getting any input.

See also

QWindow::modality

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

Returns the value of the property.

Override this to handle key press events (event).

See also

keyReleaseEvent()

Override this to handle key release events (event).

See also

keyPressEvent()

Lower the window in the windowing system. Requests that the window be lowered to appear below other windows.

Translates the global screen coordinate pos to window coordinates.

See also

mapToGlobal()

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()

Returns the mask set on the window. The mask is a hint to the windowing system that the application does not want to receive mouse or touch input outside the given region.

Returns the maximum size of the window.

See also

setMaximumSize()

Returns the minimum size of the window.

See also

setMinimumSize()

Returns the value of the QWindow::modality property.

This signal is emitted when the QWindow::modality property changes to modality.

Override this method to handle a mouse double click event.

See also

mousePressEvent(), QStyleHints::mouseDoubleClickInterval()

Override this to handle mouse move events (event).

Override this to handle mouse press events (event).

See also

mouseReleaseEvent()

Override this to handle mouse release events (event).

See also

mousePressEvent()

Override this to handle window move events (event).

Override this to handle platform dependent events. Will be given eventType, message and result. This might make your application non-portable. Should return true only if the event was handled.

Returns the parent window, if any. A window without a parent is known as a top level window.

Returns the position of the window on the desktop excluding any window frame

See also

setPosition()

Raise the window in the windowing system. Requests that the window be raised to appear above other windows.

Sets the value of the QWindow::contentOrientation property to orientation.

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

See also

isActive(), QApplication::focusWindow()

Returns the requested surface format of this window.

If the requested format was not supported by the platform implementation it will differ from the actual window format. This is the value set with setFormat().

See also

setFormat(), format()

Schedules a QEvent::UpdateRequest event to be delivered to this window. The event is delivered in sync with the display vsync on platforms where this is possible. When driving animations, this function should be called once after drawing has completed.

Calling this method multiple times will result in a single event being delivered to the window.

Subclasses of QWindow should reimplement event(), intercept the event and call the application's rendering code, then call the base class implementation. The subclass' reimplementation of event() must invoke the base class implementation, unless it is absolutely sure that the event does not need to be handled by the base class. For example, the default implementation of this function relies on QEvent::Timer events. Filtering them away would therefore break the delivery of the update events.

set the size of the window, excluding any window frame, to newSize

See also

size(), geometry()

Sets the size of the window, excluding any window frame, to a QSize constructed from width w and height h.

See also

size(), geometry()

Override this to handle resize events (event).

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.

Returns the screen on which the window is shown, or null if there is none.

For child windows, this returns the screen of the corresponding top level window.

See also

setScreen(), QScreen::virtualSiblings()

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.

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(), baseSize()

Sets the cursor shape for this window to the given cursor. The mouse cursor will be displayed when the mouse is over this window, unless an override cursor is set. By default, the cursor has the Qt::ArrowCursor shape. Refer to Qt::CursorShape for a range of useful shapes.

Some implementations will reset the cursor if it leaves a window even if the mouse is grabbed. If you want to have a cursor set for all windows, even when outside the window, consider QApplication::setOverrideCursor().

See also

QApplication::setOverrideCursor()

Set the file name this window is representing. The windowing system might use filePath to display the path of the document this window is representing in the tile bar.

Sets the value of the property to flags.

Sets the window's surface format. The format determines properties such as color depth, alpha, depth and stencil buffer size, etc. For example, to give a window a transparent background (provided that the window system supports compositing, and provided that other content in the window does not make it opaque again).

The surface format will be resolved in the create() method. Calling this function after create() has been called will not re-resolve the surface format of the native surface.

When the format is not explicitly set via this function, the format returned by QSurfaceFormat::defaultFormat() will be used. This means that when having multiple windows, individual calls to this function can be replaced by one single call to QSurfaceFormat::setDefaultFormat() before creating the first window.

See also

create(), destroy(), QSurfaceFormat::setDefaultFormat()

Sets the upper left position of the window (point) including its window frame.

See also

setGeometry(), frameGeometry()

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

See also

geometry()

Sets the geometry of the window, excluding its window frame, to a rectangle constructed from posx, posy, w and h.

See also

geometry()

Sets the window's icon in the windowing system

The window icon might be used by the windowing system for example to decorate the window, and/or in the task switcher.

Sets whether keyboard grab should be enabled or not (grab).

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()

Sets the mask of the window. The mask is a hint to the windowing system that the application does not want to receive mouse or touch input outside the given region.

The window manager may or may not choose to display any areas of the window not included in the mask, thus it is the application's responsibility to clear to transparent the areas that are not part of the mask.

Setting the mask before the window has been created has no effect.

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(), maximumSize()

Sets the maximum width of the window. This is a hint to the window manager to prevent resizing below the specified width.

See also

setMinimumSize(), maximumSize()

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(), minimumSize()

Sets the value of the QWindow::modality property to modality.

Sets whether mouse grab should be enabled or not (grab).

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()

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 nullptr will make the window become a top level window.

If parent is a window created by fromWinId(), then the current window will be embedded inside parent, if the platform supports it.

Sets the position of the window on the desktop to pt.

See also

position()

Sets the position of the window on the desktop to posx, posy.

See also

position()

Sets the screen on which the window should be shown. If the window has been created, it will be recreated on the screen. 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().

This method only works for top level windows.

See also

screen(), QScreen::virtualSiblings()

Sets the size increment size 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

setBaseSize(), setMinimumSize(), setMaximumSize()

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

The surfaceType will be used when the native surface is created in the create() function. Calling this function after the native surface has been created requires calling destroy() and create() to release the old native surface and create a new one.

See also

QBackingStore, QOpenGLContext, create(), destroy()

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. In order for the window to be centered above its transient parent, it may also be necessary to call setFlags() with a suitable Qt::WindowType.

See also

transientParent(), parent()

Sets the value of the property to visible.

Configures this window to render using the instance. The given instance must remain valid for the lifetime of this QWindow.

Sets the screen-occupation state of the window. 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

showNormal(), showFullScreen(), showMinimized(), showMaximized()

Shows the window. This is equivalent to calling showFullScreen(), showMaximized(), or showNormal(), depending on the platform's default behavior for the window type and flags.

See also

showFullScreen(), showMaximized(), showNormal(), hide(), QStyleHints::showIsFullScreen(), flags()

Override this to handle show events (event). The method 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.

Shows the window as fullscreen. Equivalent to calling setWindowState(Qt::WindowFullScreen) and then setVisible(true).

See also

setWindowState(), setVisible()

Shows the window as maximized. Equivalent to calling setWindowState(Qt::WindowMaximized) and then setVisible(true).

See also

setWindowState(), setVisible()

Shows the window as minimized. Equivalent to calling setWindowState(Qt::WindowMinimized) and then setVisible(true).

See also

setWindowState(), setVisible()

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(), setVisible()

Returns the size of the window excluding any window frame.

See also

resize()

Implements QSurface::size()

Returns the size increment of the window.

See also

setSizeIncrement()

Returns the surface type of the window.

See also

setSurfaceType()

Implements QSurface::surfaceType()

Override this to handle tablet press, move, and release events (event). Proximity enter and leave events are not sent to windows, they are delivered to the application instance.

Returns the transient parent of the window.

See also

setTransientParent(), parent()

void QWindow::touchEvent(QTouchEvent *event)

Override this to handle touch events (event).

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

See also

flags(), setFlags()

Restores the default arrow cursor for this window.

Returns the Vulkan instance for this QWindow.

Override this mtheod to handle mouse wheel or other wheel events for the given event.

Returns the screen occupation state of the window.

See also

setWindowState()

This signal is emitted when the windowState changes, either by being set explicitly with setWindowState(), or automatically when the user clicks one of the titlebar buttons or by other means.

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()

The active status of the window.

See also

requestActivate()

The orientation of the window's contents. This is a hint to the window manager in case it needs to display additional content like popups, dialogs, status bars, or similar in relation to the window.

The recommended orientation is QScreen::orientation() but an application does not have to support all possible orientations, and thus can opt to ignore the current screen orientation.

The difference between the window and the content orientation determines how much to rotate the content by. QScreen::angleBetween(), QScreen::transformBetween(), and QScreen::mapBetween() can be used to compute the necessary transform.

The default value is Qt::PrimaryOrientation.

This property contains window flags for the window. 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.

The actual window flags might differ from the flags set with setFlags() if the requested flags could not be fulfilled.

The height of the window's geometry.

The maximum height of the window's geometry

The maximum width of the window's geometry.

The minimum height of the window's geometry.

The minimum width of the window's geometry.

A modal window prevents other windows from receiving input events. CopperSpice supports two types of modality: Qt::WindowModal and Qt::ApplicationModal.

By default, this property is Qt::NonModal.

See also

Qt::WindowModality

The opacity of the window in the windowing system. 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 in between represent varying levels of translucency between the two extremes.

The default value is 1.0.

This property is the window's title in the windowing system.

The window title might appear in the title area of the window decorations, depending on the windowing system and the window flags. It might also be used by the windowing system to identify the window in other contexts, such as in the task switcher.

See also

flags()

This property describes the way the window will be displayed. The QWindow::Visibility enum describes whether the window should appear in the windowing system as normal, minimized, maximized, fullscreen, or hidden.

To set the visibility to QWindow::AutomaticVisibility means to give the window a default visible state, which might be fullscreen or windowed depending on the platform. When reading the visibility property you will always get the actual state, never AutomaticVisibility.

This property controls the visibility of the window in the windowing system.

By default, the window is not visible, you must call setVisible(true), or show() or similar to make it visible.

See also

show()

The width of the window's geometry.

The x position of the window's geometry.

The y position of the window's geometry.