QScreen¶
The QScreen class is used to query screen properties. More…
Synopsis¶
Functions¶
def
angleBetween(a, b)def
availableGeometry()def
availableGeometryChanged(geometry)def
availableSize()def
availableVirtualGeometry()def
availableVirtualSize()def
depth()def
devicePixelRatio()def
geometry()def
geometryChanged(geometry)def
grabWindow([window=0[, x=0[, y=0[, w=-1[, h=-1]]]]])def
isLandscape(orientation)def
isPortrait(orientation)def
logicalDotsPerInch()def
logicalDotsPerInchChanged(dpi)def
logicalDotsPerInchX()def
logicalDotsPerInchY()def
manufacturer()def
mapBetween(a, b, rect)def
model()def
name()def
nativeOrientation()def
orientation()def
orientationChanged(orientation)def
physicalDotsPerInch()def
physicalDotsPerInchChanged(dpi)def
physicalDotsPerInchX()def
physicalDotsPerInchY()def
physicalSize()def
physicalSizeChanged(size)def
primaryOrientation()def
primaryOrientationChanged(orientation)def
refreshRate()def
refreshRateChanged(refreshRate)def
serialNumber()def
size()def
transformBetween(a, b, target)def
virtualGeometry()def
virtualGeometryChanged(rect)def
virtualSiblingAt(point)def
virtualSiblings()def
virtualSize()
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.
Note
Both physical and logical DPI are expressed in device-independent dots. Multiply by devicePixelRatio() to get device-dependent density.
- class PySide6.QtGui.QScreen¶
- PySide6.QtGui.QScreen.angleBetween(a, b)¶
- Parameters
- 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() .
- PySide6.QtGui.QScreen.availableGeometry()¶
- Return type
- PySide6.QtGui.QScreen.availableGeometryChanged(geometry)¶
- Parameters
geometry –
PySide6.QtCore.QRect
- PySide6.QtGui.QScreen.availableSize()¶
- Return type
- PySide6.QtGui.QScreen.availableVirtualGeometry()¶
- Return type
- PySide6.QtGui.QScreen.availableVirtualSize()¶
- Return type
- PySide6.QtGui.QScreen.depth()¶
- Return type
int
- PySide6.QtGui.QScreen.devicePixelRatio()¶
- Return type
float
- PySide6.QtGui.QScreen.geometry()¶
- Return type
- PySide6.QtGui.QScreen.geometryChanged(geometry)¶
- Parameters
geometry –
PySide6.QtCore.QRect
- PySide6.QtGui.QScreen.grabWindow([window=0[, x=0[, y=0[, w=-1[, h=-1]]]]])¶
- Parameters
window –
WIdx – int
y – int
w – int
h – int
- Return type
Creates and returns a pixmap constructed by grabbing the contents of the given window restricted by QRect (x, y, width, height). If window is 0, then the entire screen will be grabbed.
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 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.
- PySide6.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() .
- PySide6.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() .
- PySide6.QtGui.QScreen.logicalDotsPerInch()¶
- Return type
float
- PySide6.QtGui.QScreen.logicalDotsPerInchChanged(dpi)¶
- Parameters
dpi – float
- PySide6.QtGui.QScreen.logicalDotsPerInchX()¶
- Return type
float
- PySide6.QtGui.QScreen.logicalDotsPerInchY()¶
- Return type
float
- PySide6.QtGui.QScreen.manufacturer()¶
- Return type
str
- PySide6.QtGui.QScreen.mapBetween(a, b, rect)¶
- Parameters
rect –
PySide6.QtCore.QRect
- Return type
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() .
- PySide6.QtGui.QScreen.model()¶
- Return type
str
- PySide6.QtGui.QScreen.name()¶
- Return type
str
- PySide6.QtGui.QScreen.nativeOrientation()¶
- Return type
- PySide6.QtGui.QScreen.orientation()¶
- Return type
- PySide6.QtGui.QScreen.orientationChanged(orientation)¶
- Parameters
orientation –
ScreenOrientation
This signal is emitted when the orientation of the screen changes with orientation as an argument.
See also
- PySide6.QtGui.QScreen.physicalDotsPerInch()¶
- Return type
float
- PySide6.QtGui.QScreen.physicalDotsPerInchChanged(dpi)¶
- Parameters
dpi – float
- PySide6.QtGui.QScreen.physicalDotsPerInchX()¶
- Return type
float
- PySide6.QtGui.QScreen.physicalDotsPerInchY()¶
- Return type
float
- PySide6.QtGui.QScreen.physicalSize()¶
- Return type
- PySide6.QtGui.QScreen.physicalSizeChanged(size)¶
- Parameters
size –
PySide6.QtCore.QSizeF
- PySide6.QtGui.QScreen.primaryOrientation()¶
- Return type
- PySide6.QtGui.QScreen.primaryOrientationChanged(orientation)¶
- Parameters
orientation –
ScreenOrientation
This signal is emitted when the primary orientation of the screen changes with orientation as an argument.
See also
- PySide6.QtGui.QScreen.refreshRate()¶
- Return type
float
- PySide6.QtGui.QScreen.refreshRateChanged(refreshRate)¶
- Parameters
refreshRate – float
- PySide6.QtGui.QScreen.serialNumber()¶
- Return type
str
- PySide6.QtGui.QScreen.size()¶
- Return type
- PySide6.QtGui.QScreen.transformBetween(a, b, target)¶
- Parameters
target –
PySide6.QtCore.QRect
- Return type
Convenience function to compute a transform that maps from the coordinate system defined by orientation a into the coordinate system defined by orientation b and target dimensions target.
Example, a is Qt::Landscape, b is Qt::Portrait, and target is QRect (0, 0, w, h) the resulting transform will be such that the point QPoint (0, 0) is mapped to QPoint (0, w), and QPoint (h, w) is mapped to QPoint (0, h). Thus, the landscape coordinate system QRect (0, 0, h, w) is mapped (with a 90 degree rotation) into the portrait coordinate system QRect (0, 0, w, h).
PrimaryOrientation is interpreted as the screen’s primaryOrientation() .
- PySide6.QtGui.QScreen.virtualGeometry()¶
- Return type
- PySide6.QtGui.QScreen.virtualGeometryChanged(rect)¶
- Parameters
rect –
PySide6.QtCore.QRect
- PySide6.QtGui.QScreen.virtualSiblingAt(point)¶
- Parameters
point –
PySide6.QtCore.QPoint- Return type
Returns the screen at point within the set of virtualSiblings() , or nullptr if outside of any screen.
The point is in relation to the virtualGeometry() of each set of virtual siblings.
- PySide6.QtGui.QScreen.virtualSiblings()¶
- Return type
Get the screen’s virtual siblings.
The virtual siblings are the screen instances sharing the same virtual desktop. They share a common coordinate system, and windows can freely be moved or positioned across them without having to be re-created.
- PySide6.QtGui.QScreen.virtualSize()¶
- Return type
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.