QScreen¶

The QScreen class is used to query screen properties. More…

Synopsis¶

Functions¶

def angleBetween (a, b)
def availableGeometry ()
def availableSize ()
def availableVirtualGeometry ()
def availableVirtualSize ()
def depth ()
def devicePixelRatio ()
def geometry ()
def grabWindow (window[, x=0[, y=0[, w=-1[, h=-1]]]])
def isLandscape (orientation)
def isPortrait (orientation)
def logicalDotsPerInch ()
def logicalDotsPerInchX ()
def logicalDotsPerInchY ()
def manufacturer ()
def mapBetween (a, b, rect)
def model ()
def name ()
def nativeOrientation ()
def orientation ()
def orientationUpdateMask ()
def physicalDotsPerInch ()
def physicalDotsPerInchX ()
def physicalDotsPerInchY ()
def physicalSize ()
def primaryOrientation ()
def refreshRate ()
def serialNumber ()
def setOrientationUpdateMask (mask)
def size ()
def transformBetween (a, b, target)
def virtualGeometry ()
def virtualSiblings ()
def virtualSize ()

Signals¶

def availableGeometryChanged (geometry)
def geometryChanged (geometry)
def logicalDotsPerInchChanged (dpi)
def orientationChanged (orientation)
def physicalDotsPerInchChanged (dpi)
def physicalSizeChanged (size)
def primaryOrientationChanged (orientation)
def refreshRateChanged (refreshRate)
def virtualGeometryChanged (rect)

Detailed Description¶

A note on logical vs physical dots per inch: physical DPI is based on the actual physical pixel sizes when available, and is useful for print preview and other cases where it’s desirable to know the exact physical dimensions of screen displayed contents.

Logical dots per inch are used to convert font and user interface elements from point sizes to pixel sizes, and might be different from the physical dots per inch. The logical dots per inch are sometimes user-settable in the desktop environment’s settings panel, to let the user globally control UI and font sizes in different applications.

PySide2.QtGui.QScreen.angleBetween(a, b)¶

Parameters

a – ScreenOrientation
b – ScreenOrientation

Return type

int

Convenience function to compute the angle of rotation to get from rotation a to rotation b .

The result will be 0, 90, 180, or 270.

PrimaryOrientation is interpreted as the screen’s primaryOrientation() .

PySide2.QtGui.QScreen.availableGeometry()¶

Return type: QRect

PySide2.QtGui.QScreen.availableGeometryChanged(geometry)¶

Parameters: geometry – QRect

PySide2.QtGui.QScreen.availableSize()¶

Return type: QSize

PySide2.QtGui.QScreen.availableVirtualGeometry()¶

Return type: QRect

PySide2.QtGui.QScreen.availableVirtualSize()¶

Return type: QSize

PySide2.QtGui.QScreen.depth()¶

Return type: int

PySide2.QtGui.QScreen.devicePixelRatio()¶

Return type: qreal

PySide2.QtGui.QScreen.geometry()¶

Return type: QRect

PySide2.QtGui.QScreen.geometryChanged(geometry)¶

Parameters: geometry – QRect

PySide2.QtGui.QScreen.grabWindow(window[, x=0[, y=0[, w=-1[, h=-1]]]])¶

Parameters

window – WId
x – int
y – int
w – int
h – int

Return type

QPixmap

Creates and returns a pixmap constructed by grabbing the contents of the given window restricted by QRect (x , y , width , height ).

The arguments (x , y ) specify the offset in the window, whereas (width , height ) specify the area to be copied. If width is negative, the function copies everything to the right border of the window. If height is negative, the function copies everything to the bottom of the window.

The offset and size arguments are specified in device independent pixels. The returned pixmap may be larger than the requested size when grabbing from a high-DPI screen. Call devicePixelRatio() to determine if this is the case.

The window system identifier (WId ) can be retrieved using the winId() function. The rationale for using a window identifier and not a QWidget , is to enable grabbing of windows that are not part of the application, window system frames, and so on.

Warning

Grabbing windows that are not part of the application is not supported on systems such as iOS, where sandboxing/security prevents reading pixels of windows not owned by the application.

The function grabs pixels from the screen, not from the window, i.e. if there is another window partially or entirely over the one you grab, you get pixels from the overlying window, too. The mouse cursor is generally not grabbed.

Note on X11 that if the given window doesn’t have the same depth as the root window, and another window partially or entirely obscures the one you grab, you will not get pixels from the overlying window. The contents of the obscured areas in the pixmap will be undefined and uninitialized.

On Windows Vista and above grabbing a layered window, which is created by setting the WA_TranslucentBackground attribute, will not work. Instead grabbing the desktop widget should work.

Warning

In general, grabbing an area outside the screen is not safe. This depends on the underlying window system.

PySide2.QtGui.QScreen.isLandscape(orientation)¶

Parameters: orientation – ScreenOrientation
Return type: bool

Convenience function that returns true if o is either landscape or inverted landscape; otherwise returns false .

PrimaryOrientation is interpreted as the screen’s primaryOrientation() .

PySide2.QtGui.QScreen.isPortrait(orientation)¶

Parameters: orientation – ScreenOrientation
Return type: bool

Convenience function that returns true if o is either portrait or inverted portrait; otherwise returns false .

PrimaryOrientation is interpreted as the screen’s primaryOrientation() .

PySide2.QtGui.QScreen.logicalDotsPerInch()¶

Return type: qreal

PySide2.QtGui.QScreen.logicalDotsPerInchChanged(dpi)¶

Parameters: dpi – qreal

PySide2.QtGui.QScreen.logicalDotsPerInchX()¶

Return type: qreal

PySide2.QtGui.QScreen.logicalDotsPerInchY()¶

Return type: qreal

PySide2.QtGui.QScreen.manufacturer()¶

Return type: unicode

PySide2.QtGui.QScreen.mapBetween(a, b, rect)¶

Parameters

a – ScreenOrientation
b – ScreenOrientation
rect – QRect

Return type

QRect

Maps the rect between two screen orientations.

This will flip the x and y dimensions of the rectangle rect if the orientation a is PortraitOrientation or InvertedPortraitOrientation and orientation b is LandscapeOrientation or InvertedLandscapeOrientation , or vice versa.

PrimaryOrientation is interpreted as the screen’s primaryOrientation() .

PySide2.QtGui.QScreen.model()¶

Return type: unicode

PySide2.QtGui.QScreen.name()¶

Return type: unicode

PySide2.QtGui.QScreen.nativeOrientation()¶

Return type: ScreenOrientation

PySide2.QtGui.QScreen.orientation()¶

Return type: ScreenOrientation

PySide2.QtGui.QScreen.orientationChanged(orientation)¶

Parameters: orientation – ScreenOrientation

PySide2.QtGui.QScreen.orientationUpdateMask()¶

Return type: ScreenOrientations

Returns the currently set orientation update mask.

Qt Documentation

Table of Contents

QScreen¶

Synopsis¶

Functions¶

Signals¶

Detailed Description¶