Skip to content

PythonQt.QtGui.QWindow · declarations 002

Back to PythonQt.QtGui.QWindow

mapFromGlobal

mapFromGlobal(pos: Any) -> Any

X.mapFromGlobal(pos) -> PythonQt.QtCore.QPoint

Supplemental documentation: Qt 5 reference:

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

Translates the global screen coordinate pos to window coordinates.

See also mapToGlobal().

Upstream PySide2 reference signatures (binding differences may apply):

mapFromGlobal(self, pos: PySide2.QtCore.QPoint) -> PySide2.QtCore.QPoint

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mapFromGlobal

mapToGlobal

mapToGlobal(pos: Any) -> Any

X.mapToGlobal(pos) -> PythonQt.QtCore.QPoint

Supplemental documentation: Qt 5 reference:

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

Upstream PySide2 reference signatures (binding differences may apply):

mapToGlobal(self, pos: PySide2.QtCore.QPoint) -> PySide2.QtCore.QPoint

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mapToGlobal

mask

mask() -> Any

X.mask() -> PythonQt.QtGui.QRegion

Supplemental documentation: Qt 5 reference:

QRegion QWindow::mask() const

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

Upstream PySide2 reference signatures (binding differences may apply):

mask(self) -> PySide2.QtGui.QRegion

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mask

maximumHeight instance-attribute

maximumHeight: int

Qt 5 reference:

maximumHeight : int

This property holds the maximum height of the window's geometry

Access functions:

int maximumHeight() const
void setMaximumHeight(int h)

Notifier signal:

void maximumHeightChanged(int arg)

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#maximumHeight

maximumHeightChanged

maximumHeightChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.maximumHeightChanged; argument details are not documented.

maximumSize

maximumSize() -> Any

X.maximumSize() -> PythonQt.QtCore.QSize

Supplemental documentation: Qt 5 reference:

QSize QWindow::maximumSize() const

Returns the maximum size of the window.

See also setMaximumSize().

Upstream PySide2 reference signatures (binding differences may apply):

maximumSize(self) -> PySide2.QtCore.QSize

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#maximumSize

maximumWidth instance-attribute

maximumWidth: int

Qt 5 reference:

maximumWidth : int

This property holds the maximum width of the window's geometry

Access functions:

int maximumWidth() const
void setMaximumWidth(int w)

Notifier signal:

void maximumWidthChanged(int arg)

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#maximumWidth

maximumWidthChanged

maximumWidthChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.maximumWidthChanged; argument details are not documented.

minimumHeight instance-attribute

minimumHeight: int

Qt 5 reference:

minimumHeight : int

This property holds the minimum height of the window's geometry

Access functions:

int minimumHeight() const
void setMinimumHeight(int h)

Notifier signal:

void minimumHeightChanged(int arg)

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#minimumHeight

minimumHeightChanged

minimumHeightChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.minimumHeightChanged; argument details are not documented.

minimumSize

minimumSize() -> Any

X.minimumSize() -> PythonQt.QtCore.QSize

Supplemental documentation: Qt 5 reference:

QSize QWindow::minimumSize() const

Returns the minimum size of the window.

See also setMinimumSize().

Upstream PySide2 reference signatures (binding differences may apply):

minimumSize(self) -> PySide2.QtCore.QSize

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#minimumSize

minimumWidth instance-attribute

minimumWidth: int

Qt 5 reference:

minimumWidth : int

This property holds the minimum width of the window's geometry

Access functions:

int minimumWidth() const
void setMinimumWidth(int w)

Notifier signal:

void minimumWidthChanged(int arg)

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#minimumWidth

minimumWidthChanged

minimumWidthChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.minimumWidthChanged; argument details are not documented.

modality instance-attribute

modality: Any

Qt 5 reference:

modality : Qt::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: Qt::WindowModal and Qt::ApplicationModal.

By default, this property is Qt::NonModal

Access functions:

Qt::WindowModality modality() const
void setModality(Qt::WindowModality modality)

Notifier signal:

void modalityChanged(Qt::WindowModality modality)

See also Qt::WindowModality.

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#modality

modalityChanged

modalityChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.modalityChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QWindow::modalityChanged(Qt::WindowModality modality)

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

Note: Notifier signal for property modality.

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#modalityChanged

mouseDoubleClickEvent

mouseDoubleClickEvent(arg__1: Any) -> None

X.mouseDoubleClickEvent(arg__1)

Supplemental documentation: Qt 5 reference:

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

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

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

Upstream PySide2 reference signatures (binding differences may apply):

mouseDoubleClickEvent(self, arg__1: PySide2.QtGui.QMouseEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mouseDoubleClickEvent

mouseMoveEvent

mouseMoveEvent(arg__1: Any) -> None

X.mouseMoveEvent(arg__1)

Supplemental documentation: Qt 5 reference:

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

Override this to handle mouse move events (ev).

Upstream PySide2 reference signatures (binding differences may apply):

mouseMoveEvent(self, arg__1: PySide2.QtGui.QMouseEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mouseMoveEvent

mousePressEvent

mousePressEvent(arg__1: Any) -> None

X.mousePressEvent(arg__1)

Supplemental documentation: Qt 5 reference:

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

Override this to handle mouse press events (ev).

See also mouseReleaseEvent().

Upstream PySide2 reference signatures (binding differences may apply):

mousePressEvent(self, arg__1: PySide2.QtGui.QMouseEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mousePressEvent

mouseReleaseEvent

mouseReleaseEvent(arg__1: Any) -> None

X.mouseReleaseEvent(arg__1)

Supplemental documentation: Qt 5 reference:

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

Override this to handle mouse release events (ev).

See also mousePressEvent().

Upstream PySide2 reference signatures (binding differences may apply):

mouseReleaseEvent(self, arg__1: PySide2.QtGui.QMouseEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#mouseReleaseEvent

moveEvent

moveEvent(arg__1: Any) -> None

X.moveEvent(arg__1)

Supplemental documentation: Qt 5 reference:

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

Override this to handle window move events (ev).

Upstream PySide2 reference signatures (binding differences may apply):

moveEvent(self, arg__1: PySide2.QtGui.QMoveEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#moveEvent

nativeEvent

nativeEvent(eventType: Any, message: int, result: Any) -> bool

X.nativeEvent(eventType, message, result) -> bool

Supplemental documentation: Qt 5 reference:

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

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.

Upstream PySide2 reference signatures (binding differences may apply):

nativeEvent(self, eventType: PySide2.QtCore.QByteArray, message: int) -> typing.Tuple[bool, int]

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#nativeEvent

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.objectNameChanged; argument details are not documented.

opacity instance-attribute

opacity: float

Qt 5 reference:

opacity : qreal

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.

This property was introduced in Qt 5.1.

Access functions:

qreal opacity() const
void setOpacity(qreal level)

Notifier signal:

void opacityChanged(qreal opacity)

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#opacity

opacityChanged

opacityChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.opacityChanged; argument details are not documented.

parent

parent() -> Any

X.parent() -> PythonQt.QtGui.QWindow

Supplemental documentation: Qt 5 reference:

QWindow *QWindow::parent(QWindow::AncestorMode mode) const

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.

This function was introduced in Qt 5.9.

See also setParent().

QWindow *QWindow::parent() const

Returns the parent window, if any.

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

Upstream PySide2 reference signatures (binding differences may apply):

parent(self) -> PySide2.QtGui.QWindow
parent(self, mode: PySide2.QtGui.QWindow.AncestorMode) -> PySide2.QtGui.QWindow

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#parent

position

position() -> Any

X.position() -> PythonQt.QtCore.QPoint

Supplemental documentation: Qt 5 reference:

QPoint QWindow::position() const

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

See also setPosition().

Upstream PySide2 reference signatures (binding differences may apply):

position(self) -> PySide2.QtCore.QPoint

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#position

raise_

raise_() -> Any

X.raise()

Native spelling: raise; access it through getattr on the native object.

Supplemental documentation: Qt 5 reference:

[slot] void QWindow::raise()

Raise the window in the windowing system.

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

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#raise

reportContentOrientationChange

reportContentOrientationChange(orientation: Any) -> None

X.reportContentOrientationChange(orientation)

Upstream PySide2 reference signatures (binding differences may apply):

reportContentOrientationChange(self, orientation: PySide2.QtCore.Qt.ScreenOrientation) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#reportContentOrientationChange

requestActivate

requestActivate() -> None

X.requestActivate()

Supplemental documentation: Qt 5 reference:

[slot] void QWindow::requestActivate()

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

See also isActive(), QGuiApplication::focusWindow(), and QWindowsWindowFunctions::setWindowActivationBehavior().

Upstream PySide2 reference signatures (binding differences may apply):

requestActivate(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#requestActivate

requestUpdate

requestUpdate() -> None

X.requestUpdate()

Supplemental documentation: Qt 5 reference:

[slot] void QWindow::requestUpdate()

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

This function was introduced in Qt 5.5.

Upstream PySide2 reference signatures (binding differences may apply):

requestUpdate(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#requestUpdate

requestedFormat

requestedFormat() -> Any

X.requestedFormat() -> PythonQt.QtGui.QSurfaceFormat

Supplemental documentation: Qt 5 reference:

QSurfaceFormat QWindow::requestedFormat() const

Returns the requested surface format 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().

Upstream PySide2 reference signatures (binding differences may apply):

requestedFormat(self) -> PySide2.QtGui.QSurfaceFormat

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#requestedFormat

resize

resize(w: Any, h: Any) -> None

X.resize(w, h)

Supplemental documentation: Qt 5 reference:

void QWindow::resize(const QSize \&newSize)

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

See also size() and geometry().

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

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() and geometry().

Upstream PySide2 reference signatures (binding differences may apply):

resize(self, newSize: PySide2.QtCore.QSize) -> None
resize(self, w: int, h: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#resize

resizeEvent

resizeEvent(arg__1: Any) -> None

X.resizeEvent(arg__1)

Supplemental documentation: Qt 5 reference:

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

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.

Upstream PySide2 reference signatures (binding differences may apply):

resizeEvent(self, arg__1: PySide2.QtGui.QResizeEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#resizeEvent

screen

screen() -> Any

X.screen() -> PythonQt.QtGui.QScreen

Supplemental documentation: Qt 5 reference:

QScreen *QWindow::screen() const

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() and QScreen::virtualSiblings().

Upstream PySide2 reference signatures (binding differences may apply):

screen(self) -> PySide2.QtGui.QScreen

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#screen

screenChanged

screenChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QWindow.screenChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

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

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.

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#screenChanged

setBaseSize

setBaseSize(size: Any) -> None

X.setBaseSize(size)

Supplemental documentation: Qt 5 reference:

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

Upstream PySide2 reference signatures (binding differences may apply):

setBaseSize(self, size: PySide2.QtCore.QSize) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#setBaseSize

setCursor

setCursor(arg__1: Any) -> None

X.setCursor(arg__1)

Supplemental documentation: Qt 5 reference:

void QWindow::setCursor(const QCursor \&cursor)

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 Qt::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 QGuiApplication::setOverrideCursor().

See also cursor() and QGuiApplication::setOverrideCursor().

Upstream PySide2 reference signatures (binding differences may apply):

setCursor(self, arg__1: PySide2.QtGui.QCursor) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#setCursor

setFilePath

setFilePath(filePath: str) -> None

X.setFilePath(filePath)

Supplemental documentation: Qt 5 reference:

void QWindow::setFilePath(const QString \&filePath)

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

Upstream PySide2 reference signatures (binding differences may apply):

setFilePath(self, filePath: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#setFilePath

setFlags

setFlags(arg0: flags) -> None

X.setFlags(flags)

Upstream PySide2 reference signatures (binding differences may apply):

setFlags(self, flags: PySide2.QtCore.Qt.WindowFlags) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#setFlags

setFormat

setFormat(format: Any) -> None

X.setFormat(format)

Supplemental documentation: Qt 5 reference:

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. 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 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 format(), create(), destroy(), and QSurfaceFormat::setDefaultFormat().

Upstream PySide2 reference signatures (binding differences may apply):

setFormat(self, format: PySide2.QtGui.QSurfaceFormat) -> None

Source: https://doc.qt.io/archives/qt-5.15/qwindow.html#setFormat