#include <qquickscreen_p.h>

Inheritance diagram for QQuickScreenInfo:

Collaboration diagram for QQuickScreenInfo:

Signals
void	nameChanged ()
	Q_REVISION (2, 10) void manufacturerChanged()
	Q_REVISION (2, 10) void modelChanged()
	Q_REVISION (2, 10) void serialNumberChanged()
void	widthChanged ()
void	heightChanged ()
void	desktopGeometryChanged ()
void	logicalPixelDensityChanged ()
void	pixelDensityChanged ()
void	devicePixelRatioChanged ()
void	primaryOrientationChanged ()
void	orientationChanged ()
	Q_REVISION (2, 3) void virtualXChanged()
	Q_REVISION (2, 3) void virtualYChanged()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickScreenInfo (QObject parent=nullptr, QScreen wrappedScreen=nullptr)
	\qmltype Screen \nativetype QQuickScreenAttached \inqmlmodule QtQuick
QString	name () const
QString	manufacturer () const
QString	model () const
QString	serialNumber () const
int	width () const
int	height () const
int	desktopAvailableWidth () const
int	desktopAvailableHeight () const
qreal	logicalPixelDensity () const
qreal	pixelDensity () const
qreal	devicePixelRatio () const
Qt::ScreenOrientation	primaryOrientation () const
Qt::ScreenOrientation	orientation () const
int	virtualX () const
int	virtualY () const
void	setWrappedScreen (QScreen *screen)
QScreen *	wrappedScreen () const
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.
virtual	~QObject ()
	Destroys the object, deleting all its child objects.
virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.
QString	objectName () const
Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.
void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.
bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.
bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.
bool	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread *	thread () const
	Returns the thread in which the object lives.
bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
	Kills the timer with timer identifier, id.
void	killTimer (Qt::TimerId id)
template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList &	children () const
	Returns a list of child objects.
void	setParent (QObject *parent)
	Makes the object a child of parent.
void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.
void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject receiver, const char member=nullptr) const
void	dumpObjectTree () const
	Dumps a tree of children to the debug output.
void	dumpObjectInfo () const
	Dumps information about signal connections, etc.
bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.
bool	setProperty (const char *name, QVariant &&value)
QVariant	property (const char *name) const
	Returns the value of the object's name property.
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
	Returns a pointer to the parent object.
bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Attributes
QPointer< QScreen >	m_screen
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties
QString	name
QString	manufacturer
FINALQString	model
FINALQString	serialNumber
FINALint	width
int	height
int	desktopAvailableWidth
int	desktopAvailableHeight
qreal	logicalPixelDensity
qreal	pixelDensity
qreal	devicePixelRatio
Qt::ScreenOrientation	primaryOrientation
Qt::ScreenOrientation	orientation
int	virtualX
FINALint	virtualY
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int	senderSignalIndex () const
int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.
virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 32 of file qquickscreen_p.h.

Constructor & Destructor Documentation

◆ QQuickScreenInfo()

QT_BEGIN_NAMESPACE QQuickScreenInfo::QQuickScreenInfo	(	QObject *	parent = nullptr,
		QScreen *	wrappedScreen = nullptr )

\qmltype Screen \nativetype QQuickScreenAttached \inqmlmodule QtQuick

The Screen attached object provides information about the Screen an Item or Window is displayed on.

The Screen attached object is valid inside Item or Item derived types, after component completion. Inside these items it refers to the screen that the item is currently being displayed on.

The attached object is also valid inside Window or Window derived types, after component completion. In that case it refers to the screen where the Window was created. It is generally better to access the Screen from the relevant Item instead, because on a multi-screen desktop computer, the user can drag a Window into a position where it spans across multiple screens. In that case some Items will be on one screen, and others on a different screen.

To use this type, you will need to import the module with the following line:

import QtQuick.Window 2.2

It is a separate import in order to allow you to have a QML environment without access to window system features.

Note that the Screen type is not valid at Component.onCompleted, because the Item or Window has not been displayed on a screen by this time.

See also: {Qt Quick Examples - Window and Screen}

\qmlattachedproperty string Screen::name \readonly

Since: 5.1

The name of the screen.

\qmlattachedproperty int Screen::virtualX \readonly

Since: 5.9

The x coordinate of the screen within the virtual desktop.

\qmlattachedproperty int Screen::virtualY \readonly

Since: 5.9

The y coordinate of the screen within the virtual desktop.

\qmlattachedproperty string Screen::manufacturer \readonly

Since: 5.10

The manufacturer of the screen.

\qmlattachedproperty string Screen::model \readonly

Since: 5.10

The model of the screen.

\qmlattachedproperty string Screen::serialNumber \readonly

Since: 5.10

The serial number of the screen.

\qmlattachedproperty int Screen::width \readonly

This contains the width of the screen in pixels.

\qmlattachedproperty int Screen::height \readonly

This contains the height of the screen in pixels.

\qmlattachedproperty int Screen::desktopAvailableWidth \readonly

Since: 5.1

This contains the available width of the collection of screens which make up the virtual desktop, in pixels, excluding window manager reserved areas such as task bars and system menus. If you want to position a Window at the right of the desktop, you can bind to it like this:

x: Screen.desktopAvailableWidth - width

QQuickScreenInfo::width

FINALint width

Definition qquickscreen_p.h:39

x

GLint GLint GLint GLint GLint x

Definition qopengles2ext.h:605

\qmlattachedproperty int Screen::desktopAvailableHeight \readonly

Since: 5.1

This contains the available height of the collection of screens which make up the virtual desktop, in pixels, excluding window manager reserved areas such as task bars and system menus. If you want to position a Window at the bottom of the desktop, you can bind to it like this:

y: Screen.desktopAvailableHeight - height

QQuickScreenInfo::height

int height

Definition qquickscreen_p.h:40

y

GLint y

Definition qopengles2ext.h:206

\qmlattachedproperty real Screen::logicalPixelDensity \readonly

Since: 5.1

Deprecated

The number of logical pixels per millimeter. This is the effective pixel density provided by the platform to use in image scaling calculations.

Due to inconsistencies in how logical pixel density is handled across the various platforms Qt supports, it is recommended to use physical pixels instead (via the pixelDensity property) for portability.

See also: pixelDensity

\qmlattachedproperty real Screen::pixelDensity \readonly

Since: 5.2

The number of physical pixels per millimeter.

\qmlattachedproperty real Screen::devicePixelRatio \readonly

Since: 5.4

The ratio between physical pixels and device-independent pixels for the screen.

Common values are 1.0 on normal displays and 2.0 on Apple "retina" displays.

\qmlattachedproperty Qt::ScreenOrientation Screen::primaryOrientation \readonly

This contains the primary orientation of the screen. If the screen's height is greater than its width, then the orientation is Qt.PortraitOrientation; otherwise it is Qt.LandscapeOrientation.

If you are designing an application which changes its layout depending on device orientation, you probably want to use primaryOrientation to determine the layout. That is because on a desktop computer, you can expect primaryOrientation to change when the user rotates the screen via the operating system's control panel, even if the computer does not contain an accelerometer. Likewise on most handheld computers which do have accelerometers, the operating system will rotate the whole screen automatically, so again you will see the primaryOrientation change.

\qmlattachedproperty Qt::ScreenOrientation Screen::orientation \readonly

This contains the current orientation of the screen from the window system perspective.

Most mobile devices and tablet computers contain accelerometer sensors. The windowing system may rotate the entire screen automatically based on how it is being held, or manually via settings to rotate a desktop monitor; in that case, this orientation property will change.

See also: primaryOrientation, QWindow::contentOrientation()

\qmlattachedmethod int Screen::angleBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b)

Returns the rotation angle, in degrees, between the specified screen orientations a and b.