QWindow¶

The QWindow class represents a window in the underlying windowing system. More…

Inherited by: Qt3DWindow, Q3DBars, Q3DScatter, Q3DSurface, QAbstract3DGraph, QOpenGLWindow, QPaintDeviceWindow, QRasterWindow, QQuickView, QQuickWindow

Synopsis¶

Functions¶

def baseSize ()
def contentOrientation ()
def create ()
def cursor ()
def destroy ()
def devicePixelRatio ()
def filePath ()
def flags ()
def frameGeometry ()
def frameMargins ()
def framePosition ()
def geometry ()
def height ()
def icon ()
def isActive ()
def isAncestorOf (child[, mode=IncludeTransients])
def isExposed ()
def isModal ()
def isTopLevel ()
def isVisible ()
def mapFromGlobal (pos)
def mapToGlobal (pos)
def mask ()
def maximumHeight ()
def maximumSize ()
def maximumWidth ()
def minimumHeight ()
def minimumSize ()
def minimumWidth ()
def modality ()
def opacity ()
def parent (mode)
def position ()
def reportContentOrientationChange (orientation)
def requestedFormat ()
def resize (newSize)
def resize (w, h)
def screen ()
def setBaseSize (size)
def setCursor (arg__1)
def setFilePath (filePath)
def setFlag (arg__1[, on=true])
def setFlags (flags)
def setFormat (format)
def setFramePosition (point)
def setIcon (icon)
def setKeyboardGrabEnabled (grab)
def setMask (region)
def setMaximumSize (size)
def setMinimumSize (size)
def setModality (modality)
def setMouseGrabEnabled (grab)
def setOpacity (level)
def setParent (parent)
def setPosition (posx, posy)
def setPosition (pt)
def setScreen (screen)
def setSizeIncrement (size)
def setSurfaceType (surfaceType)
def setTransientParent (parent)
def setVisibility (v)
def setWindowState (state)
def setWindowStates (states)
def sizeIncrement ()
def title ()
def transientParent ()
def type ()
def unsetCursor ()
def visibility ()
def width ()
def winId ()
def windowState ()
def windowStates ()
def x ()
def y ()

Virtual functions¶

def accessibleRoot ()
def exposeEvent (arg__1)
def focusInEvent (arg__1)
def focusObject ()
def focusOutEvent (arg__1)
def hideEvent (arg__1)
def keyPressEvent (arg__1)
def keyReleaseEvent (arg__1)
def mouseDoubleClickEvent (arg__1)
def mouseMoveEvent (arg__1)
def mousePressEvent (arg__1)
def mouseReleaseEvent (arg__1)
def moveEvent (arg__1)
def nativeEvent (eventType, message)
def resizeEvent (arg__1)
def showEvent (arg__1)
def tabletEvent (arg__1)
def touchEvent (arg__1)
def wheelEvent (arg__1)

Detailed Description¶

A window that is supplied a parent becomes a native child window of their parent window.

An application will typically use QWidget or QQuickView for its UI, and not QWindow directly. Still, it is possible to render directly to a QWindow with QBackingStore or QOpenGLContext , when wanting to keep dependencies to a minimum or when wanting to use OpenGL directly. The Raster Window Example and OpenGL Window Example are useful reference examples for how to render to a QWindow using either approach.

Resource Management¶

Windows can potentially use a lot of memory. A usual measurement is width times height times color depth. A window might also include multiple buffers to support double and triple buffering, as well as depth and stencil buffers. To release a window’s memory resources, call the destroy() function.

Content Orientation¶

QWindow has reportContentOrientationChange() that can be used to specify the layout of the window contents in relation to the screen. The content orientation is simply a hint to the windowing system about which orientation the window contents are in. It’s useful when you wish to keep the same window size, but rotate the contents instead, especially when doing rotation animations between different orientations. The windowing system might use this value to determine the layout of system popups or dialogs.

Visibility and Windowing System Exposure¶

By default, the window is not visible, and you must call setVisible (true), or show() or similar to make it visible. To make a window hidden again, call setVisible (false) or hide() . The visible property describes the state the application wants the window to be in. Depending on the underlying system, a visible window might still not be shown on the screen. It could, for instance, be covered by other opaque windows or moved outside the physical area of the screen. On windowing systems that have exposure notifications, the isExposed() accessor describes whether the window should be treated as directly visible on screen. The exposeEvent() function is called whenever an area of the window is invalidated, for example due to the exposure in the windowing system changing. On windowing systems that do not make this information visible to the application, isExposed() will simply return the same value as isVisible() .

Visibility queried through visibility() is a convenience API combining the functions of visible() and windowStates() .

Rendering¶

There are two Qt APIs that can be used to render content into a window, QBackingStore for rendering with a QPainter and flushing the contents to a window with type RasterSurface , and QOpenGLContext for rendering with OpenGL to a window with type OpenGLSurface .

The application can start rendering as soon as isExposed() returns true , and can keep rendering until it isExposed() returns false . To find out when isExposed() changes, reimplement exposeEvent() . The window will always get a resize event before the first expose event.

Initial Geometry¶

If the window’s width and height are left uninitialized, the window will get a reasonable default geometry from the platform window. If the position is left uninitialized, then the platform window will allow the windowing system to position the window. For example on X11, the window manager usually does some kind of smart positioning to try to avoid having new windows completely obscure existing windows. However setGeometry() initializes both the position and the size, so if you want a fixed size but an automatic position, you should call resize() or setWidth() and setHeight() instead.

class PySide2.QtGui.QWindow([screen=None])¶

PySide2.QtGui.QWindow(parent)

param parent:

PySide2.QtGui.QWindow

param screen:

PySide2.QtGui.QScreen

Creates a window as a top level on the targetScreen .

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

PySide2.QtGui.QWindow.Visibility¶

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

Constant	Description
QWindow.Windowed	The window occupies part of the screen, but not necessarily the entire screen. This state will occur only on windowing systems which support showing multiple windows simultaneously. In this state it is possible for the user to move and resize the window manually, if WindowFlags permit it and if it is supported by the windowing system.
QWindow.Minimized	The window is reduced to an entry or icon on the task bar, dock, task list or desktop, depending on how the windowing system handles minimized windows.
QWindow.Maximized	The window occupies one entire screen, and the titlebar is still visible. On most windowing systems this is the state achieved by clicking the maximize button on the toolbar.
QWindow.FullScreen	The window occupies one entire screen, is not resizable, and there is no titlebar. On some platforms which do not support showing multiple simultaneous windows, this can be the usual visibility when the window is not hidden.
QWindow.AutomaticVisibility	This means to give the window a default visible state, which might be fullscreen or windowed depending on the platform. It can be given as a parameter to `setVisibility` but will never be read back from the visibility accessor.
QWindow.Hidden	The window is not visible in any way, however it may remember a latent visibility which can be restored by setting .

PySide2.QtGui.QWindow.AncestorMode¶

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

Constant	Description
QWindow.ExcludeTransients	Transient parents are not considered ancestors.
QWindow.IncludeTransients	Transient parents are considered ancestors.

PySide2.QtGui.QWindow.accessibleRoot()¶

Return type:: PySide2.QtGui.QAccessibleInterface

Returns the accessibility interface for the object that the window represents

See also

QAccessible

PySide2.QtGui.QWindow.activeChanged()¶

PySide2.QtGui.QWindow.alert(msec)¶

Parameters:: msec – int

Causes an alert to be shown for msec miliseconds. If msec is 0 (the default), then the alert is shown indefinitely until the window becomes active again. This function 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.

PySide2.QtGui.QWindow.baseSize()¶

Return type:: PySide2.QtCore.QSize

Returns the base size of the window.

See also

setBaseSize()

PySide2.QtGui.QWindow.close()¶

Return type:: bool

Close the window.

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

PySide2.QtGui.QWindow.contentOrientation()¶

Return type:: ScreenOrientation

This property holds 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 orientation() but an application doesn’t 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. angleBetween() , transformBetween() , and mapBetween() can be used to compute the necessary transform.

The default value is PrimaryOrientation

PySide2.QtGui.QWindow.contentOrientationChanged(orientation)¶

Parameters:: orientation – ScreenOrientation

PySide2.QtGui.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()

PySide2.QtGui.QWindow.cursor()¶

Return type:: PySide2.QtGui.QCursor

the cursor shape for this window

See also

setCursor() unsetCursor()

PySide2.QtGui.QWindow.destroy()¶: Releases the native platform resources associated with this window.

See also

create()

PySide2.QtGui.QWindow.devicePixelRatio()¶

Return type:: float

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 the associated QScreen ‘s device pixel ratio.

See also

devicePixelRatio()

PySide2.QtGui.QWindow.exposeEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QExposeEvent

The expose event (ev ) is sent by the window system whenever an area of the window is invalidated, for example due to the exposure in the windowing system changing.

The application can start rendering into the window with QBackingStore and QOpenGLContext as soon as it gets an 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()

PySide2.QtGui.QWindow.filePath()¶

Return type:: str

the file name this window is representing.

See also

setFilePath()

PySide2.QtGui.QWindow.flags()¶

Return type:: WindowFlags

This property holds the window flags of 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 if the requested flags could not be fulfilled.

See also

setFlag()

PySide2.QtGui.QWindow.focusInEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QFocusEvent

Override this to handle focus in events (ev ).

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

See also

focusOutEvent()

PySide2.QtGui.QWindow.focusObject()¶

Return type:: PySide2.QtCore.QObject

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

PySide2.QtGui.QWindow.focusObjectChanged(object)¶

Parameters:: object – PySide2.QtCore.QObject

PySide2.QtGui.QWindow.focusOutEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QFocusEvent

Override this to handle focus out events (ev ).

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

See also

focusInEvent()

PySide2.QtGui.QWindow.frameGeometry()¶

Return type:: PySide2.QtCore.QRect

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

The geometry is in relation to the virtualGeometry() of its screen.

See also

geometry() frameMargins()

PySide2.QtGui.QWindow.frameMargins()¶

Return type:: PySide2.QtCore.QMargins

Returns the window frame margins surrounding the window.

See also

geometry() frameGeometry()

PySide2.QtGui.QWindow.framePosition()¶

Return type:: PySide2.QtCore.QPoint

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

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

static PySide2.QtGui.QWindow.fromWinId(id)¶

Parameters:: id – WId
Return type:: PySide2.QtGui.QWindow

Creates a local representation of a window created by another process or by using native libraries below Qt.

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 .

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 or embedding the native window failed in the platform plugin, this function returns None .

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

PySide2.QtGui.QWindow.geometry()¶

Return type:: PySide2.QtCore.QRect

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

The geometry is in relation to the virtualGeometry() of its screen.

PySide2.QtGui.QWindow.height()¶

Return type:: int

This property holds the height of the window’s geometry.

PySide2.QtGui.QWindow.heightChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.hide()¶

Hides the window.

Equivalent to calling setVisible (false).

See also

show() setVisible()

PySide2.QtGui.QWindow.hideEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QHideEvent

Override this to handle hide events (ev ).

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

PySide2.QtGui.QWindow.icon()¶

Return type:: PySide2.QtGui.QIcon

Returns the window’s icon in the windowing system

See also

setIcon()

PySide2.QtGui.QWindow.isActive()¶

Return type:: bool

This property holds the active status of the window.

See also

requestActivate()

PySide2.QtGui.QWindow.isAncestorOf(child[, mode=IncludeTransients])¶

Parameters:

child – PySide2.QtGui.QWindow
mode – AncestorMode

Return type:

bool

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

PySide2.QtGui.QWindow.isExposed()¶

Return type:: bool

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

PySide2.QtGui.QWindow.isModal()¶

Return type:: bool

Returns whether the window is modal.

A modal window prevents other windows from getting any input.

See also

modality

PySide2.QtGui.QWindow.isTopLevel()¶

Return type:: bool

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

PySide2.QtGui.QWindow.isVisible()¶

Return type:: bool

This property holds whether the window is visible or not.

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

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

Note

Hiding a window does not remove the window from the windowing system, it only hides it. On windowing systems that give full screen applications a dedicated desktop (such as macOS), hiding a full screen window will not remove that desktop, but leave it blank. Another window from the same application might be shown full screen, and will fill that desktop. Use close to completely remove a window from the windowing system.

See also

show()

PySide2.QtGui.QWindow.keyPressEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QKeyEvent

Override this to handle key press events (ev ).

See also

keyReleaseEvent()

PySide2.QtGui.QWindow.keyReleaseEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QKeyEvent

Override this to handle key release events (ev ).

See also

keyPressEvent()

PySide2.QtGui.QWindow.lower()¶

Lower the window in the windowing system.

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

PySide2.QtGui.QWindow.mapFromGlobal(pos)¶

Parameters:: pos – PySide2.QtCore.QPoint
Return type:: PySide2.QtCore.QPoint

Translates the global screen coordinate pos to window coordinates.

See also

mapToGlobal()

PySide2.QtGui.QWindow.mapToGlobal(pos)¶

Parameters:: pos – PySide2.QtCore.QPoint
Return type:: PySide2.QtCore.QPoint

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

PySide2.QtGui.QWindow.mask()¶

Return type:: PySide2.QtGui.QRegion

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.

See also

setMask()

PySide2.QtGui.QWindow.maximumHeight()¶

Return type:: int

This property holds the maximum height of the window’s geometry.

PySide2.QtGui.QWindow.maximumHeightChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.maximumSize()¶

Return type:: PySide2.QtCore.QSize

Returns the maximum size of the window.

See also

setMaximumSize()

PySide2.QtGui.QWindow.maximumWidth()¶

Return type:: int

This property holds the maximum width of the window’s geometry.

PySide2.QtGui.QWindow.maximumWidthChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.minimumHeight()¶

Return type:: int

This property holds the minimum height of the window’s geometry.

PySide2.QtGui.QWindow.minimumHeightChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.minimumSize()¶

Return type:: PySide2.QtCore.QSize

Returns the minimum size of the window.

See also

setMinimumSize()

PySide2.QtGui.QWindow.minimumWidth()¶

Return type:: int

This property holds the minimum width of the window’s geometry.

PySide2.QtGui.QWindow.minimumWidthChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.modality()¶

Return type:: WindowModality

This property holds the modality of the window.

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

By default, this property is NonModal

See also

WindowModality

PySide2.QtGui.QWindow.modalityChanged(modality)¶

Parameters:: modality – WindowModality

PySide2.QtGui.QWindow.mouseDoubleClickEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QMouseEvent

Override this to handle mouse double click events (ev ).

PySide2.QtGui.QWindow.mouseMoveEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QMouseEvent

Override this to handle mouse move events (ev ).

PySide2.QtGui.QWindow.mousePressEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QMouseEvent

Override this to handle mouse press events (ev ).

See also

mouseReleaseEvent()

PySide2.QtGui.QWindow.mouseReleaseEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QMouseEvent

Override this to handle mouse release events (ev ).

See also

mousePressEvent()

PySide2.QtGui.QWindow.moveEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QMoveEvent

Override this to handle window move events (ev ).

PySide2.QtGui.QWindow.nativeEvent(eventType, message)¶

Parameters:

eventType – PySide2.QtCore.QByteArray
message – void

Return type:

PyObject

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.

PySide2.QtGui.QWindow.opacity()¶

Return type:: float

This property holds 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 inbetween represent varying levels of translucency between the two extremes.

The default value is 1.0.

PySide2.QtGui.QWindow.opacityChanged(opacity)¶

Parameters:: opacity – float

PySide2.QtGui.QWindow.parent(mode)¶

Parameters:: mode – AncestorMode
Return type:: PySide2.QtGui.QWindow

Returns the parent window, if any.

If mode is IncludeTransients , then the transient parent is returned if there is no parent.

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

See also

setParent()

PySide2.QtGui.QWindow.position()¶

Return type:: PySide2.QtCore.QPoint

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

See also

setPosition()

PySide2.QtGui.QWindow.raise_()¶

Raise the window in the windowing system.

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

PySide2.QtGui.QWindow.reportContentOrientationChange(orientation)¶

Parameters:: orientation – ScreenOrientation

This property holds 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 orientation() but an application doesn’t 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. angleBetween() , transformBetween() , and mapBetween() can be used to compute the necessary transform.

The default value is PrimaryOrientation

PySide2.QtGui.QWindow.requestActivate()¶: Requests the window to be activated, i.e. receive keyboard focus.

See also

isActive() focusWindow() setWindowActivationBehavior()

PySide2.QtGui.QWindow.requestUpdate()¶

Schedules a UpdateRequest event to be delivered to this window.

The event is delivered in sync with the display vsync on platforms where this is possible. Otherwise, the event is delivered after a delay of 5 ms. The additional time is there to give the event loop a bit of idle time to gather system events, and can be overridden using the QT_QPA_UPDATE_IDLE_TIME environment variable.

When driving animations, this function should be called once after drawing has completed. Calling this function 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.

Note

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 Timer events. Filtering them away would therefore break the delivery of the update events.

PySide2.QtGui.QWindow.requestedFormat()¶

Return type:: PySide2.QtGui.QSurfaceFormat

Returns the requested surface format of this window.

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

This is the value set with setFormat() .

See also

setFormat() format()

PySide2.QtGui.QWindow.resize(newSize)¶

Parameters:: newSize – PySide2.QtCore.QSize

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

See also

size() geometry()

PySide2.QtGui.QWindow.resize(w, h)

Parameters:

w – int
h – int

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

For interactively resizing windows, see startSystemResize() .

See also

size() geometry()

PySide2.QtGui.QWindow.resizeEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QResizeEvent

Override this to handle resize events (ev ).

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.

PySide2.QtGui.QWindow.screen()¶

Return type:: PySide2.QtGui.QScreen

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

PySide2.QtGui.QWindow.screenChanged(screen)¶

Parameters:: screen – PySide2.QtGui.QScreen

PySide2.QtGui.QWindow.setBaseSize(size)¶

Parameters:: size – PySide2.QtCore.QSize

Sets the base size of the window.

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

PySide2.QtGui.QWindow.setCursor(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QCursor

set the cursor shape for this window

The mouse cursor will assume this shape when it is over this window, unless an override cursor is set. See the list of predefined cursor objects for a range of useful shapes.

If no cursor has been set, or after a call to unsetCursor() , the parent window’s cursor is used.

By default, the cursor has the ArrowCursor shape.

Some underlying window 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 setOverrideCursor() .

See also

cursor() setOverrideCursor()

PySide2.QtGui.QWindow.setFilePath(filePath)¶

Parameters:: filePath – str

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.

See also

filePath()

PySide2.QtGui.QWindow.setFlag(arg__1[, on=true])¶

Parameters:

arg__1 – WindowType
on – bool

Sets the window flag flag on this window if on is true; otherwise clears the flag.

See also

setFlags() flags() type()

PySide2.QtGui.QWindow.setFlags(flags)¶

Parameters:: flags – WindowFlags

This property holds the window flags of 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 if the requested flags could not be fulfilled.

See also

setFlag()

PySide2.QtGui.QWindow.setFormat(format)¶

Parameters:: format – PySide2.QtGui.QSurfaceFormat

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

QSurfaceFormat format;
format.setAlphaBufferSize(8);
window.setFormat(format);

The surface format will be resolved in the create() function. 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 defaultFormat() will be used. This means that when having multiple windows, individual calls to this function can be replaced by one single call to setDefaultFormat() before creating the first window.

PySide2.QtGui.QWindow.setFramePosition(point)¶

Parameters:: point – PySide2.QtCore.QPoint

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

The position is in relation to the virtualGeometry() of its screen.

PySide2.QtGui.QWindow.setGeometry(rect)¶

Parameters:: rect – PySide2.QtCore.QRect

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

The geometry is in relation to the virtualGeometry() of its screen.

See also

geometry()

PySide2.QtGui.QWindow.setGeometry(posx, posy, w, h)

Parameters:

posx – int
posy – int
w – int
h – int

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

The geometry is in relation to the virtualGeometry() of its screen.

See also

geometry()

PySide2.QtGui.QWindow.setHeight(arg)¶

Parameters:: arg – int

This property holds the height of the window’s geometry.

PySide2.QtGui.QWindow.setIcon(icon)¶

Parameters:: icon – PySide2.QtGui.QIcon

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.

Note

On macOS, the window title bar icon is meant for windows representing documents, and will only show up if a file path is also set.

See also

icon() setFilePath()

PySide2.QtGui.QWindow.setKeyboardGrabEnabled(grab)¶

Parameters:: grab – bool
Return type:: bool

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

If the return value is true, the window receives all key events until (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()

PySide2.QtGui.QWindow.setMask(region)¶

Parameters:: region – PySide2.QtGui.QRegion

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.

See also

mask()

PySide2.QtGui.QWindow.setMaximumHeight(h)¶

Parameters:: h – int

This property holds the maximum height of the window’s geometry.

PySide2.QtGui.QWindow.setMaximumSize(size)¶

Parameters:: size – PySide2.QtCore.QSize

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

PySide2.QtGui.QWindow.setMaximumWidth(w)¶

Parameters:: w – int

This property holds the maximum width of the window’s geometry.

PySide2.QtGui.QWindow.setMinimumHeight(h)¶

Parameters:: h – int

This property holds the minimum height of the window’s geometry.

PySide2.QtGui.QWindow.setMinimumSize(size)¶

Parameters:: size – PySide2.QtCore.QSize

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

PySide2.QtGui.QWindow.setMinimumWidth(w)¶

Parameters:: w – int

This property holds the minimum width of the window’s geometry.

PySide2.QtGui.QWindow.setModality(modality)¶

Parameters:: modality – WindowModality

This property holds the modality of the window.

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

By default, this property is NonModal

See also

WindowModality

PySide2.QtGui.QWindow.setMouseGrabEnabled(grab)¶

Parameters:: grab – bool
Return type:: bool

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

If the return value is true, the window receives all mouse events until (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()

PySide2.QtGui.QWindow.setOpacity(level)¶

Parameters:: level – float

This property holds 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 inbetween represent varying levels of translucency between the two extremes.

The default value is 1.0.

PySide2.QtGui.QWindow.setParent(parent)¶

Parameters:: parent – PySide2.QtGui.QWindow

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 None 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.

See also

parent()

PySide2.QtGui.QWindow.setPosition(pt)¶

Parameters:: pt – PySide2.QtCore.QPoint

set the position of the window on the desktop to pt

The position is in relation to the virtualGeometry() of its screen.

For interactively moving windows, see startSystemMove() . For interactively resizing windows, see startSystemResize() .

See also

position() startSystemMove()

PySide2.QtGui.QWindow.setPosition(posx, posy)

Parameters:

posx – int
posy – int

set the position of the window on the desktop to posx , posy

The position is in relation to the virtualGeometry() of its screen.

See also

position()

PySide2.QtGui.QWindow.setScreen(screen)¶

Parameters:: screen – PySide2.QtGui.QScreen

Sets the screen on which the window should be shown.

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

Note

If the screen is part of a virtual desktop of multiple screens, the window will not move automatically to newScreen . To place the window relative to the screen, use the screen’s topLeft() position.

This function only works for top level windows.

See also

screen() virtualSiblings()

PySide2.QtGui.QWindow.setSizeIncrement(size)¶

Parameters:: size – PySide2.QtCore.QSize

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.

PySide2.QtGui.QWindow.setSurfaceType(surfaceType)¶

Parameters:: surfaceType – SurfaceType

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.

PySide2.QtGui.QWindow.setTitle(arg__1)¶

Parameters:: arg__1 – str

This property holds 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()

PySide2.QtGui.QWindow.setTransientParent(parent)¶

Parameters:: parent – PySide2.QtGui.QWindow

PySide2.QtGui.QWindow.setVisibility(v)¶

Parameters:: v – Visibility

This property holds the screen-occupation state of the window.

Visibility is whether the window should appear in the windowing system as normal, minimized, maximized, fullscreen or hidden.

To set the visibility to 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 .

PySide2.QtGui.QWindow.setVisible(visible)¶

Parameters:: visible – bool

This property holds whether the window is visible or not.

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

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

Note

Hiding a window does not remove the window from the windowing system, it only hides it. On windowing systems that give full screen applications a dedicated desktop (such as macOS), hiding a full screen window will not remove that desktop, but leave it blank. Another window from the same application might be shown full screen, and will fill that desktop. Use close to completely remove a window from the windowing system.

See also

show()

PySide2.QtGui.QWindow.setWidth(arg)¶

Parameters:: arg – int

This property holds the width of the window’s geometry.

PySide2.QtGui.QWindow.setWindowState(state)¶

Parameters:: state – WindowState

set 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 WindowActive is not an accepted parameter.

PySide2.QtGui.QWindow.setWindowStates(states)¶

Parameters:: states – WindowStates

set the screen-occupation state of the window

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

The window can be in a combination of several states. For example, if the window is both minimized and maximized, the window will appear minimized, but clicking on the task bar entry will restore it to the maximized state.

The enum value WindowActive should not be set.

PySide2.QtGui.QWindow.setX(arg)¶

Parameters:: arg – int

This property holds the x position of the window’s geometry.

PySide2.QtGui.QWindow.setY(arg)¶

Parameters:: arg – int

This property holds the y position of the window’s geometry.

PySide2.QtGui.QWindow.show()¶

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.

PySide2.QtGui.QWindow.showEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QShowEvent

Override this to handle show events (ev ).

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.

PySide2.QtGui.QWindow.showFullScreen()¶

Shows the window as fullscreen.

Equivalent to calling setWindowStates ( WindowFullScreen ) and then setVisible (true).

See the showFullScreen() documentation for platform-specific considerations and limitations.

See also

setWindowStates() setVisible()

PySide2.QtGui.QWindow.showMaximized()¶

Shows the window as maximized.

Equivalent to calling setWindowStates ( WindowMaximized ) and then setVisible (true).

See also

setWindowStates() setVisible()

PySide2.QtGui.QWindow.showMinimized()¶

Shows the window as minimized.

Equivalent to calling setWindowStates ( WindowMinimized ) and then setVisible (true).

See also

setWindowStates() setVisible()

PySide2.QtGui.QWindow.showNormal()¶

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

Equivalent to calling setWindowStates ( WindowNoState ) and then setVisible (true).

See also

setWindowStates() setVisible()

PySide2.QtGui.QWindow.sizeIncrement()¶

Return type:: PySide2.QtCore.QSize

Returns the size increment of the window.

See also

setSizeIncrement()

PySide2.QtGui.QWindow.startSystemMove()¶

Return type:: bool

Start a system-specific move operation

Calling this will start an interactive move operation on the window by platforms that support it. The actual behavior may vary depending on the platform. Usually, it will make the window follow the mouse cursor until a mouse button is released.

On platforms that support it, this method of moving windows is preferred over setPosition , because it allows a more native look-and-feel of moving windows, e.g. letting the window manager snap this window against other windows, or special tiling or resizing behavior with animations when dragged to the edge of the screen. Furthermore, on some platforms such as Wayland, setPosition is not supported, so this is the only way the application can influence its position.

Returns true if the operation was supported by the system.

PySide2.QtGui.QWindow.startSystemResize(edges)¶

Parameters:: edges – Edges
Return type:: bool

Start a system-specific resize operation

Calling this will start an interactive resize operation on the window by platforms that support it. The actual behavior may vary depending on the platform. Usually, it will make the window resize so that its edge follows the mouse cursor.

On platforms that support it, this method of resizing windows is preferred over setGeometry , because it allows a more native look-and-feel of resizing windows, e.g. letting the window manager snap this window against other windows, or special resizing behavior with animations when dragged to the edge of the screen.

edges should either be a single edge, or two adjacent edges (a corner). Other values are not allowed.

Returns true if the operation was supported by the system.

PySide2.QtGui.QWindow.tabletEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QTabletEvent

Override this to handle tablet press, move, and release events (ev ).

Proximity enter and leave events are not sent to windows, they are delivered to the application instance.

PySide2.QtGui.QWindow.title()¶

Return type:: str

This property holds 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()

PySide2.QtGui.QWindow.touchEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QTouchEvent

Override this to handle touch events (ev ).

PySide2.QtGui.QWindow.transientParent()¶

Return type:: PySide2.QtGui.QWindow

PySide2.QtGui.QWindow.transientParentChanged(transientParent)¶

Parameters:: transientParent – PySide2.QtGui.QWindow

PySide2.QtGui.QWindow.type()¶

Return type:: WindowType

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

flags() setFlags()

PySide2.QtGui.QWindow.unsetCursor()¶: Restores the default arrow cursor for this window.

PySide2.QtGui.QWindow.visibility()¶

Return type:: Visibility

This property holds the screen-occupation state of the window.

Visibility is whether the window should appear in the windowing system as normal, minimized, maximized, fullscreen or hidden.

To set the visibility to 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 .

PySide2.QtGui.QWindow.visibilityChanged(visibility)¶

Parameters:: visibility – Visibility

PySide2.QtGui.QWindow.visibleChanged(arg)¶

Parameters:: arg – bool

PySide2.QtGui.QWindow.wheelEvent(arg__1)¶

Parameters:: arg__1 – PySide2.QtGui.QWheelEvent

Override this to handle mouse wheel or other wheel events (ev ).

PySide2.QtGui.QWindow.width()¶

Return type:: int

This property holds the width of the window’s geometry.

PySide2.QtGui.QWindow.widthChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.winId()¶

Return type:: WId

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

PySide2.QtGui.QWindow.windowState()¶

Return type:: WindowState

the screen-occupation state of the window

See also

setWindowState() windowStates()

PySide2.QtGui.QWindow.windowStateChanged(windowState)¶

Parameters:: windowState – WindowState

PySide2.QtGui.QWindow.windowStates()¶

Return type:: WindowStates

the screen-occupation state of the window

The window can be in a combination of several states. For example, if the window is both minimized and maximized, the window will appear minimized, but clicking on the task bar entry will restore it to the maximized state.

See also

setWindowStates()

PySide2.QtGui.QWindow.windowTitleChanged(title)¶

Parameters:: title – str

PySide2.QtGui.QWindow.x()¶

Return type:: int

This property holds the x position of the window’s geometry.

PySide2.QtGui.QWindow.xChanged(arg)¶

Parameters:: arg – int

PySide2.QtGui.QWindow.y()¶

Return type:: int

This property holds the y position of the window’s geometry.

PySide2.QtGui.QWindow.yChanged(arg)¶

Parameters:: arg – int

Table of Contents

Previous topic

Next topic

QWindow¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Static functions¶

Detailed Description¶

Resource Management¶

Content Orientation¶

Visibility and Windowing System Exposure¶

Rendering¶

Initial Geometry¶