The QPlatformScreen class provides an abstraction for visual displays. More...

#include <qplatformscreen.h>

Inheritance diagram for QPlatformScreen:

Collaboration diagram for QPlatformScreen:

Classes
struct	Mode

Public Types
enum	SubpixelAntialiasingType { Subpixel_None , Subpixel_RGB , Subpixel_BGR , Subpixel_VRGB , Subpixel_VBGR }
enum	PowerState { PowerStateOn , PowerStateStandby , PowerStateSuspend , PowerStateOff }

Public Member Functions
	QPlatformScreen ()
virtual	~QPlatformScreen ()
virtual bool	isPlaceholder () const
virtual QPixmap	grabWindow (WId window, int x, int y, int width, int height) const
	This function is called when Qt needs to be able to grab the content of a window.
virtual QRect	geometry () const =0
	Reimplement in subclass to return the pixel geometry of the screen.
virtual QRect	availableGeometry () const
	Reimplement in subclass to return the pixel geometry of the available space This normally is the desktop screen minus the task manager, global menubar etc.
virtual int	depth () const =0
	Reimplement in subclass to return current depth of the screen.
virtual QImage::Format	format () const =0
	Reimplement in subclass to return the image format which corresponds to the screen format.
virtual QColorSpace	colorSpace () const
virtual QSizeF	physicalSize () const
	Reimplement this function in subclass to return the physical size of the screen, in millimeters.
virtual QDpi	logicalDpi () const
	Reimplement this function in subclass to return the logical horizontal and vertical dots per inch metrics of the screen.
virtual QDpi	logicalBaseDpi () const
	Reimplement to return the base logical DPI for the platform.
virtual qreal	devicePixelRatio () const
	Reimplement this function in subclass to return the device pixel ratio for the screen.
virtual qreal	refreshRate () const
	Reimplement this function in subclass to return the vertical refresh rate of the screen, in Hz.
virtual Qt::ScreenOrientation	nativeOrientation () const
	Reimplement this function in subclass to return the native orientation of the screen, e.g.
virtual Qt::ScreenOrientation	orientation () const
	Reimplement this function in subclass to return the current orientation of the screen, for example based on accelerometer data to determine the device orientation.
virtual QWindow *	topLevelAt (const QPoint &point) const
	Return the given top level window for a given position.
QWindowList	windows () const
	Return all windows residing on this screen.
virtual QList< QPlatformScreen * >	virtualSiblings () const
	Returns a list of all the platform screens that are part of the same virtual desktop.
const QPlatformScreen *	screenForPosition (const QPoint &point) const
	Find the sibling screen corresponding to globalPos.
QScreen *	screen () const
virtual QString	name () const
virtual QString	manufacturer () const
	Reimplement this function in subclass to return the manufacturer of this screen.
virtual QString	model () const
	Reimplement this function in subclass to return the model of this screen.
virtual QString	serialNumber () const
	Reimplement this function in subclass to return the serial number of this screen.
virtual QPlatformCursor *	cursor () const
	Reimplement this function in subclass to return the cursor of the screen.
virtual SubpixelAntialiasingType	subpixelAntialiasingTypeHint () const
	Returns a hint about this screen's subpixel layout structure.
virtual PowerState	powerState () const
	Returns the current power state.
virtual void	setPowerState (PowerState state)
	Sets the power state for this screen.
virtual QList< Mode >	modes () const
	Reimplement this function in subclass to return the list of modes for this screen.
virtual int	currentMode () const
	Reimplement this function in subclass to return the index of the current mode from the modes list.
virtual int	preferredMode () const
	Reimplement this function in subclass to return the preferred mode index from the modes list.

Static Public Member Functions
static QPlatformScreen *	platformScreenForWindow (const QWindow *window)
static int	angleBetween (Qt::ScreenOrientation a, Qt::ScreenOrientation b)
static QTransform	transformBetween (Qt::ScreenOrientation a, Qt::ScreenOrientation b, const QRect &target)
static QRect	mapBetween (Qt::ScreenOrientation a, Qt::ScreenOrientation b, const QRect &rect)
static QDpi	overrideDpi (const QDpi &in)

Protected Member Functions
void	resizeMaximizedWindows ()
	Convenience method to resize all the maximized and fullscreen windows of this platform screen.

Protected Attributes
QScopedPointer< QPlatformScreenPrivate >	d_ptr

Friends
class	QScreen

Detailed Description

The QPlatformScreen class provides an abstraction for visual displays.

Since: 4.8

\preliminary

Many window systems has support for retrieving information on the attached displays. To be able to query the display QPA uses QPlatformScreen. Qt its self is most dependent on the physicalSize() function, since this is the function it uses to calculate the dpi to use when converting point sizes to pixels sizes. However, this is unfortunate on some systems, as the native system fakes its dpi size.

Definition at line 44 of file qplatformscreen.h.

Member Enumeration Documentation

◆ PowerState

enum QPlatformScreen::PowerState

Enumerator
PowerStateOn
PowerStateStandby
PowerStateSuspend
PowerStateOff

Definition at line 60 of file qplatformscreen.h.

◆ SubpixelAntialiasingType

enum QPlatformScreen::SubpixelAntialiasingType

Enumerator
Subpixel_None
Subpixel_RGB
Subpixel_BGR
Subpixel_VRGB
Subpixel_VBGR

Definition at line 52 of file qplatformscreen.h.

Constructor & Destructor Documentation

◆ QPlatformScreen()

QT_BEGIN_NAMESPACE QPlatformScreen::QPlatformScreen ( )

Definition at line 19 of file qplatformscreen.cpp.

◆ ~QPlatformScreen()

QPlatformScreen::~QPlatformScreen ( )

virtual

Definition at line 26 of file qplatformscreen.cpp.

Member Function Documentation

◆ angleBetween()

int QPlatformScreen::angleBetween	(	Qt::ScreenOrientation	a,
		Qt::ScreenOrientation	b )

static

Definition at line 366 of file qplatformscreen.cpp.

◆ availableGeometry()

virtual QRect QPlatformScreen::availableGeometry ( ) const

inlinevirtual

Reimplement in subclass to return the pixel geometry of the available space This normally is the desktop screen minus the task manager, global menubar etc.

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QIOSScreen, QPlatformPlaceholderScreen, QQnxScreen, QWindowsScreen, and QXcbScreen.

Definition at line 80 of file qplatformscreen.h.

◆ colorSpace()

virtual QColorSpace QPlatformScreen::colorSpace ( ) const

inlinevirtual

Reimplemented in QCocoaScreen, and QXcbScreen.

Definition at line 84 of file qplatformscreen.h.

◆ currentMode()

int QPlatformScreen::currentMode ( ) const

virtual

Reimplement this function in subclass to return the index of the current mode from the modes list.

The default implementation returns 0.

See also: QPlatformScreen::modes

Since: 5.9

Reimplemented in QAndroidPlatformScreen, and QEglFSKmsScreen.

Definition at line 512 of file qplatformscreen.cpp.

◆ cursor()

QPlatformCursor * QPlatformScreen::cursor ( ) const

virtual

Reimplement this function in subclass to return the cursor of the screen.

The default implementation returns \nullptr.

Reimplemented in QCocoaScreen, QDirectFbScreen, QEglFSKmsEglDeviceScreen, QEglFSKmsGbmScreen, QEglFSScreen, QFbScreen, QHaikuScreen, QOffscreenScreen, QQnxScreen, QVncScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

Definition at line 310 of file qplatformscreen.cpp.

◆ depth()

virtual int QPlatformScreen::depth ( ) const

pure virtual

Reimplement in subclass to return current depth of the screen.

Implemented in QAndroidPlatformScreen, QCocoaScreen, QDirectFbScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QFbScreen, QHaikuScreen, QIOSScreen, QMinimalEglScreen, QMinimalScreen, QOffscreenScreen, QPlatformPlaceholderScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QVkKhrDisplayScreen, QVkKhrDisplayScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

◆ devicePixelRatio()

qreal QPlatformScreen::devicePixelRatio ( ) const

virtual

Reimplement this function in subclass to return the device pixel ratio for the screen.

This is the ratio between physical pixels and the device-independent pixels of the windowing system. The default implementation returns 1.0.

See also: QPlatformWindow::devicePixelRatio()

Reimplemented in QCocoaScreen, QIOSScreen, QOffscreenScreen, QtWaylandClient::QWaylandScreen, QWasmScreen, and QWindowsScreen.

Definition at line 184 of file qplatformscreen.cpp.

◆ format()

virtual QImage::Format QPlatformScreen::format ( ) const

pure virtual

Reimplement in subclass to return the image format which corresponds to the screen format.

Implemented in QAndroidPlatformScreen, QCocoaScreen, QDirectFbScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QFbScreen, QHaikuScreen, QIOSScreen, QMinimalEglScreen, QMinimalScreen, QOffscreenScreen, QPlatformPlaceholderScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QVkKhrDisplayScreen, QVkKhrDisplayScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

◆ geometry()

virtual QRect QPlatformScreen::geometry ( ) const

pure virtual

Reimplement in subclass to return the pixel geometry of the screen.

Implemented in QAndroidPlatformScreen, QCocoaScreen, QDirectFbScreen, QEglFSEmulatorScreen, QEglFSScreen, QFbScreen, QHaikuScreen, QIOSScreen, QMinimalEglScreen, QMinimalScreen, QOffscreenScreen, QPlatformPlaceholderScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QVkKhrDisplayScreen, QVkKhrDisplayScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

◆ grabWindow()

QPixmap QPlatformScreen::grabWindow	(	WId	window,
		int	x,
		int	y,
		int	width,
		int	height ) const

virtual

This function is called when Qt needs to be able to grab the content of a window.

Returns the content of the window specified with the WId handle within the boundaries of QRect(x,y,width,height).

Reimplemented in QBsdFbScreen, QCocoaScreen, QEglFSScreen, QHaikuScreen, QIntegrityFbScreen, QIOSScreen, QLinuxFbDrmScreen, QLinuxFbScreen, QOffscreenScreen, QQnxScreen, QVncScreen, QWindowsScreen, and QXcbScreen.

Definition at line 39 of file qplatformscreen.cpp.

◆ isPlaceholder()

virtual bool QPlatformScreen::isPlaceholder ( ) const

inlinevirtual

Reimplemented in QPlatformPlaceholderScreen.

Definition at line 75 of file qplatformscreen.h.

◆ logicalBaseDpi()

QDpi QPlatformScreen::logicalBaseDpi ( ) const

virtual

Reimplement to return the base logical DPI for the platform.

This DPI value should correspond to a standard-DPI (1x) display. The default implementation returns 96.

QtGui will use this value (together with logicalDpi) to compute the scale factor when high-DPI scaling is enabled, as follows: factor = logicalDPI / baseDPI

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QIOSScreen, QOffscreenScreen, QWindowsScreen, and QXcbScreen.

Definition at line 171 of file qplatformscreen.cpp.

◆ logicalDpi()

QDpi QPlatformScreen::logicalDpi ( ) const

virtual

Reimplement this function in subclass to return the logical horizontal and vertical dots per inch metrics of the screen.

The logical dots per inch metrics are used by Qt to scale the user interface.

The default implementation returns logicalBaseDpi(), which results in a UI scale factor of 1.0.

See also: physicalSize

Reimplemented in QAndroidPlatformScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QOffscreenScreen, QtWaylandClient::QWaylandScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

Definition at line 149 of file qplatformscreen.cpp.

◆ manufacturer()

QString QPlatformScreen::manufacturer ( ) const

virtual

Reimplement this function in subclass to return the manufacturer of this screen.

The default implementation returns an empty string.

Since: 5.9

Reimplemented in QEglFSKmsScreen, QtWaylandClient::QWaylandScreen, QWindowsScreen, and QXcbScreen.

Definition at line 241 of file qplatformscreen.cpp.

◆ mapBetween()

QRect QPlatformScreen::mapBetween	(	Qt::ScreenOrientation	a,
		Qt::ScreenOrientation	b,
		const QRect &	rect )

static

Definition at line 419 of file qplatformscreen.cpp.

◆ model()

QString QPlatformScreen::model ( ) const

virtual

Reimplement this function in subclass to return the model of this screen.

The default implementation returns an empty string.

Since: 5.9

Reimplemented in QEglFSKmsScreen, QtWaylandClient::QWaylandScreen, QWindowsScreen, and QXcbScreen.

Definition at line 254 of file qplatformscreen.cpp.

◆ modes()

QList< QPlatformScreen::Mode > QPlatformScreen::modes ( ) const

virtual

Reimplement this function in subclass to return the list of modes for this screen.

The default implementation returns a list with only one mode from the current screen size and refresh rate.

See also: QPlatformScreen::geometry; QPlatformScreen::refreshRate

Since: 5.9

Reimplemented in QAndroidPlatformScreen, and QEglFSKmsScreen.

Definition at line 495 of file qplatformscreen.cpp.

◆ name()

virtual QString QPlatformScreen::name ( ) const

inlinevirtual

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QIOSScreen, QOffscreenScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

Definition at line 108 of file qplatformscreen.h.

◆ nativeOrientation()

Qt::ScreenOrientation QPlatformScreen::nativeOrientation ( ) const

virtual

Reimplement this function in subclass to return the native orientation of the screen, e.g.

the orientation where the logo sticker of the device appears the right way up.

The default implementation returns Qt::PrimaryOrientation.

Reimplemented in QAndroidPlatformScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QIOSScreen, and QQnxScreen.

Definition at line 207 of file qplatformscreen.cpp.

◆ orientation()

Qt::ScreenOrientation QPlatformScreen::orientation ( ) const

virtual

Reimplement this function in subclass to return the current orientation of the screen, for example based on accelerometer data to determine the device orientation.

The default implementation returns Qt::PrimaryOrientation.

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QIOSScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QWindowsScreen, and QXcbScreen.

Definition at line 219 of file qplatformscreen.cpp.

◆ overrideDpi()

QDpi QPlatformScreen::overrideDpi ( const QDpi & in )

static

Definition at line 156 of file qplatformscreen.cpp.

◆ physicalSize()

QSizeF QPlatformScreen::physicalSize ( ) const

virtual

Reimplement this function in subclass to return the physical size of the screen, in millimeters.

The physical size represents the actual physical dimensions of the display.

The default implementation takes the pixel size of the screen, considers a resolution of 100 dots per inch, and returns the calculated physical size. A device with a screen that has different resolutions will need to be supported by a suitable reimplementation of this function.

See also: logcalDpi

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QDirectFbScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QFbScreen, QIOSScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QWindowsScreen, and QXcbScreen.

Definition at line 132 of file qplatformscreen.cpp.

◆ platformScreenForWindow()

QPlatformScreen * QPlatformScreen::platformScreenForWindow ( const QWindow * window )

static

Definition at line 224 of file qplatformscreen.cpp.

◆ powerState()

QPlatformScreen::PowerState QPlatformScreen::powerState ( ) const

virtual

Returns the current power state.

The default implementation always returns PowerStateOn.

Reimplemented in QEglFSKmsScreen.

Definition at line 470 of file qplatformscreen.cpp.

◆ preferredMode()

int QPlatformScreen::preferredMode ( ) const

virtual

Reimplement this function in subclass to return the preferred mode index from the modes list.

The default implementation returns 0.

See also: QPlatformScreen::modes

Since: 5.9

Reimplemented in QAndroidPlatformScreen, and QEglFSKmsScreen.

Definition at line 527 of file qplatformscreen.cpp.

◆ refreshRate()

qreal QPlatformScreen::refreshRate ( ) const

virtual

Reimplement this function in subclass to return the vertical refresh rate of the screen, in Hz.

The default returns 60, a sensible default for modern displays.

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QEglFSEmulatorScreen, QEglFSKmsScreen, QEglFSScreen, QIOSScreen, QQnxScreen, QtWaylandClient::QWaylandScreen, QWindowsScreen, and QXcbScreen.

Definition at line 195 of file qplatformscreen.cpp.

◆ resizeMaximizedWindows()

void QPlatformScreen::resizeMaximizedWindows ( )

protected

Convenience method to resize all the maximized and fullscreen windows of this platform screen.

Definition at line 319 of file qplatformscreen.cpp.

◆ screen()

QScreen * QPlatformScreen::screen ( ) const

Definition at line 114 of file qplatformscreen.cpp.

◆ screenForPosition()

const QPlatformScreen * QPlatformScreen::screenForPosition ( const QPoint & point ) const

Find the sibling screen corresponding to globalPos.

Returns this screen if no suitable screen is found at the position.

Definition at line 87 of file qplatformscreen.cpp.

◆ serialNumber()

QString QPlatformScreen::serialNumber ( ) const

virtual

Reimplement this function in subclass to return the serial number of this screen.

The default implementation returns an empty string.

Since: 5.9

Reimplemented in QEglFSKmsScreen, QWindowsScreen, and QXcbScreen.

Definition at line 267 of file qplatformscreen.cpp.

◆ setPowerState()

void QPlatformScreen::setPowerState ( PowerState state )

virtual

Sets the power state for this screen.

Reimplemented in QEglFSKmsScreen.

Definition at line 478 of file qplatformscreen.cpp.

◆ subpixelAntialiasingTypeHint()

QPlatformScreen::SubpixelAntialiasingType QPlatformScreen::subpixelAntialiasingTypeHint ( ) const

virtual

Returns a hint about this screen's subpixel layout structure.

The default implementation queries the {QT_SUBPIXEL_AA_TYPE} env variable. This is just a hint because most platforms don't have a way to retrieve the correct value from hardware and instead rely on font configurations.

Reimplemented in QCocoaScreen, QEglFSKmsScreen, QtWaylandClient::QWaylandScreen, and QWindowsScreen.

Definition at line 445 of file qplatformscreen.cpp.

◆ topLevelAt()

QWindow * QPlatformScreen::topLevelAt ( const QPoint & pos ) const

virtual

Return the given top level window for a given position.

Default implementation retrieves a list of all top level windows and finds the first window which contains point pos

Reimplemented in QAndroidPlatformScreen, QCocoaScreen, QEglFSScreen, QFbScreen, QQnxScreen, QWasmScreen, QWindowsScreen, and QXcbScreen.

Definition at line 55 of file qplatformscreen.cpp.

◆ transformBetween()

QTransform QPlatformScreen::transformBetween	(	Qt::ScreenOrientation	a,
		Qt::ScreenOrientation	b,
		const QRect &	target )

static

Definition at line 388 of file qplatformscreen.cpp.

◆ virtualSiblings()

QList< QPlatformScreen * > QPlatformScreen::virtualSiblings ( ) const

virtual

Returns a list of all the platform screens that are part of the same virtual desktop.

Screens part of the same virtual desktop share a common coordinate system, and windows can be freely moved between them.

Reimplemented in QCocoaScreen, QEglFSKmsScreen, QOffscreenScreen, QPlatformPlaceholderScreen, QtWaylandClient::QWaylandScreen, QWindowsScreen, and QXcbScreen.

Definition at line 107 of file qplatformscreen.cpp.

◆ windows()

QWindowList QPlatformScreen::windows ( ) const

Return all windows residing on this screen.

Definition at line 71 of file qplatformscreen.cpp.

◆ QScreen

friend class QScreen

friend

Definition at line 137 of file qplatformscreen.h.

Member Data Documentation

◆ d_ptr

QScopedPointer<QPlatformScreenPrivate> QPlatformScreen::d_ptr

protected

Definition at line 134 of file qplatformscreen.h.

The documentation for this class was generated from the following files:

qtbase/src/gui/kernel/qplatformscreen.h (3fa3e0362f36607707e24cb1dea31dce30254b4a)
qtbase/src/gui/kernel/qplatformscreen.cpp (3fa3e0362f36607707e24cb1dea31dce30254b4a)

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ PowerState

◆ SubpixelAntialiasingType

Constructor & Destructor Documentation

◆ QPlatformScreen()

◆ ~QPlatformScreen()

Member Function Documentation

◆ angleBetween()

◆ availableGeometry()

◆ colorSpace()

◆ currentMode()

◆ cursor()

◆ depth()

◆ devicePixelRatio()

◆ format()

◆ geometry()

◆ grabWindow()

◆ isPlaceholder()

◆ logicalBaseDpi()

◆ logicalDpi()

◆ manufacturer()

◆ mapBetween()

◆ model()

◆ modes()

◆ name()

◆ nativeOrientation()

◆ orientation()

◆ overrideDpi()

◆ physicalSize()

◆ platformScreenForWindow()

◆ powerState()

◆ preferredMode()

◆ refreshRate()

◆ resizeMaximizedWindows()

◆ screen()

◆ screenForPosition()

◆ serialNumber()

◆ setPowerState()

◆ subpixelAntialiasingTypeHint()

◆ topLevelAt()

◆ transformBetween()

◆ virtualSiblings()

◆ windows()

Friends And Related Symbol Documentation

◆ QScreen

Member Data Documentation

◆ d_ptr