API reference - Class QScreen

_const_cast

Signature: [const] QScreen ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

angleBetween

Signature: [const] int angleBetween (const Qt_ScreenOrientation a, const Qt_ScreenOrientation b)

Description: Method int QScreen::angleBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b)

availableGeometry

Signature: [const] QRect availableGeometry

Description: Method QRect QScreen::availableGeometry()

Python specific notes:
The object exposes a readable attribute 'availableGeometry'. This is the getter.

availableGeometryChanged

Signature: [signal] void availableGeometryChanged (const QRect geometry)

Description: Signal declaration for QScreen::availableGeometryChanged(const QRect &geometry)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'availableGeometryChanged'. This is the getter.
The object exposes a writable attribute 'availableGeometryChanged'. This is the setter.

availableSize

Signature: [const] QSize availableSize

Description: Method QSize QScreen::availableSize()

Python specific notes:
The object exposes a readable attribute 'availableSize'. This is the getter.

availableVirtualGeometry

Signature: [const] QRect availableVirtualGeometry

Description: Method QRect QScreen::availableVirtualGeometry()

Python specific notes:
The object exposes a readable attribute 'availableVirtualGeometry'. This is the getter.

availableVirtualSize

Signature: [const] QSize availableVirtualSize

Description: Method QSize QScreen::availableVirtualSize()

Python specific notes:
The object exposes a readable attribute 'availableVirtualSize'. This is the getter.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QScreen::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QScreen::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

depth

Signature: [const] int depth

Description: Method int QScreen::depth()

Python specific notes:
The object exposes a readable attribute 'depth'. This is the getter.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QScreen::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

devicePixelRatio

Signature: [const] double devicePixelRatio

Description: Method double QScreen::devicePixelRatio()

Python specific notes:
The object exposes a readable attribute 'devicePixelRatio'. This is the getter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QScreen::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_availableGeometryChanged

Signature: void emit_availableGeometryChanged (const QRect geometry)

Description: Emitter for signal void QScreen::availableGeometryChanged(const QRect &geometry)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QScreen::destroyed(QObject *)

Call this method to emit this signal.

emit_geometryChanged

Signature: void emit_geometryChanged (const QRect geometry)

Description: Emitter for signal void QScreen::geometryChanged(const QRect &geometry)

Call this method to emit this signal.

emit_logicalDotsPerInchChanged

Signature: void emit_logicalDotsPerInchChanged (double dpi)

Description: Emitter for signal void QScreen::logicalDotsPerInchChanged(double dpi)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QScreen::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_orientationChanged

Signature: void emit_orientationChanged (const Qt_ScreenOrientation orientation)

Description: Emitter for signal void QScreen::orientationChanged(Qt::ScreenOrientation orientation)

Call this method to emit this signal.

emit_physicalDotsPerInchChanged

Signature: void emit_physicalDotsPerInchChanged (double dpi)

Description: Emitter for signal void QScreen::physicalDotsPerInchChanged(double dpi)

Call this method to emit this signal.

emit_physicalSizeChanged

Signature: void emit_physicalSizeChanged (const QSizeF size)

Description: Emitter for signal void QScreen::physicalSizeChanged(const QSizeF &size)

Call this method to emit this signal.

emit_primaryOrientationChanged

Signature: void emit_primaryOrientationChanged (const Qt_ScreenOrientation orientation)

Description: Emitter for signal void QScreen::primaryOrientationChanged(Qt::ScreenOrientation orientation)

Call this method to emit this signal.

emit_refreshRateChanged

Signature: void emit_refreshRateChanged (double refreshRate)

Description: Emitter for signal void QScreen::refreshRateChanged(double refreshRate)

Call this method to emit this signal.

emit_virtualGeometryChanged

Signature: void emit_virtualGeometryChanged (const QRect rect)

Description: Emitter for signal void QScreen::virtualGeometryChanged(const QRect &rect)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QScreen::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QScreen::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

geometry

Signature: [const] QRect geometry

Description: Method QRect QScreen::geometry()

Python specific notes:
The object exposes a readable attribute 'geometry'. This is the getter.

geometryChanged

Signature: [signal] void geometryChanged (const QRect geometry)

Description: Signal declaration for QScreen::geometryChanged(const QRect &geometry)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'geometryChanged'. This is the getter.
The object exposes a writable attribute 'geometryChanged'. This is the setter.

grabWindow

Signature: QPixmap grabWindow (unsigned long long window, int x = 0, int y = 0, int w = -1, int h = -1)

Description: Method QPixmap QScreen::grabWindow(WId window, int x, int y, int w, int h)

isLandscape?

Signature: [const] bool isLandscape? (const Qt_ScreenOrientation orientation)

Description: Method bool QScreen::isLandscape(Qt::ScreenOrientation orientation)

isPortrait?

Signature: [const] bool isPortrait? (const Qt_ScreenOrientation orientation)

Description: Method bool QScreen::isPortrait(Qt::ScreenOrientation orientation)

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QScreen::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

logicalDotsPerInch

Signature: [const] double logicalDotsPerInch

Description: Method double QScreen::logicalDotsPerInch()

Python specific notes:
The object exposes a readable attribute 'logicalDotsPerInch'. This is the getter.

logicalDotsPerInchChanged

Signature: [signal] void logicalDotsPerInchChanged (double dpi)

Description: Signal declaration for QScreen::logicalDotsPerInchChanged(double dpi)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'logicalDotsPerInchChanged'. This is the getter.
The object exposes a writable attribute 'logicalDotsPerInchChanged'. This is the setter.

logicalDotsPerInchX

Signature: [const] double logicalDotsPerInchX

Description: Method double QScreen::logicalDotsPerInchX()

Python specific notes:
The object exposes a readable attribute 'logicalDotsPerInchX'. This is the getter.

logicalDotsPerInchY

Signature: [const] double logicalDotsPerInchY

Description: Method double QScreen::logicalDotsPerInchY()

Python specific notes:
The object exposes a readable attribute 'logicalDotsPerInchY'. This is the getter.

manufacturer

Signature: [const] string manufacturer

Description: Method QString QScreen::manufacturer()

Python specific notes:
The object exposes a readable attribute 'manufacturer'. This is the getter.

mapBetween

Signature: [const] QRect mapBetween (const Qt_ScreenOrientation a, const Qt_ScreenOrientation b, const QRect rect)

Description: Method QRect QScreen::mapBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, const QRect &rect)

model

Signature: [const] string model

Description: Method QString QScreen::model()

Python specific notes:
The object exposes a readable attribute 'model'. This is the getter.

name

Signature: [const] string name

Description: Method QString QScreen::name()

Python specific notes:
The object exposes a readable attribute 'name'. This is the getter.

nativeOrientation

Signature: [const] Qt_ScreenOrientation nativeOrientation

Description: Method Qt::ScreenOrientation QScreen::nativeOrientation()

Python specific notes:
The object exposes a readable attribute 'nativeOrientation'. This is the getter.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QScreen::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

orientation

Signature: [const] Qt_ScreenOrientation orientation

Description: Method Qt::ScreenOrientation QScreen::orientation()

Python specific notes:
The object exposes a readable attribute 'orientation'. This is the getter.

orientationChanged

Signature: [signal] void orientationChanged (const Qt_ScreenOrientation orientation)

Description: Signal declaration for QScreen::orientationChanged(Qt::ScreenOrientation orientation)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'orientationChanged'. This is the getter.
The object exposes a writable attribute 'orientationChanged'. This is the setter.

orientationUpdateMask

Signature: [const] Qt_QFlags_ScreenOrientation orientationUpdateMask

Description: Method QFlags<Qt::ScreenOrientation> QScreen::orientationUpdateMask()

Python specific notes:
The object exposes a readable attribute 'orientationUpdateMask'. This is the getter.

orientationUpdateMask=

Signature: void orientationUpdateMask= (Qt_QFlags_ScreenOrientation mask)

Description: Method void QScreen::setOrientationUpdateMask(QFlags<Qt::ScreenOrientation> mask)

Python specific notes:
The object exposes a writable attribute 'orientationUpdateMask'. This is the setter.

physicalDotsPerInch

Signature: [const] double physicalDotsPerInch

Description: Method double QScreen::physicalDotsPerInch()

Python specific notes:
The object exposes a readable attribute 'physicalDotsPerInch'. This is the getter.

physicalDotsPerInchChanged

Signature: [signal] void physicalDotsPerInchChanged (double dpi)

Description: Signal declaration for QScreen::physicalDotsPerInchChanged(double dpi)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'physicalDotsPerInchChanged'. This is the getter.
The object exposes a writable attribute 'physicalDotsPerInchChanged'. This is the setter.

physicalDotsPerInchX

Signature: [const] double physicalDotsPerInchX

Description: Method double QScreen::physicalDotsPerInchX()

Python specific notes:
The object exposes a readable attribute 'physicalDotsPerInchX'. This is the getter.

physicalDotsPerInchY

Signature: [const] double physicalDotsPerInchY

Description: Method double QScreen::physicalDotsPerInchY()

Python specific notes:
The object exposes a readable attribute 'physicalDotsPerInchY'. This is the getter.

physicalSize

Signature: [const] QSizeF physicalSize

Description: Method QSizeF QScreen::physicalSize()

Python specific notes:
The object exposes a readable attribute 'physicalSize'. This is the getter.

physicalSizeChanged

Signature: [signal] void physicalSizeChanged (const QSizeF size)

Description: Signal declaration for QScreen::physicalSizeChanged(const QSizeF &size)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'physicalSizeChanged'. This is the getter.
The object exposes a writable attribute 'physicalSizeChanged'. This is the setter.

primaryOrientation

Signature: [const] Qt_ScreenOrientation primaryOrientation

Description: Method Qt::ScreenOrientation QScreen::primaryOrientation()

Python specific notes:
The object exposes a readable attribute 'primaryOrientation'. This is the getter.

primaryOrientationChanged

Signature: [signal] void primaryOrientationChanged (const Qt_ScreenOrientation orientation)

Description: Signal declaration for QScreen::primaryOrientationChanged(Qt::ScreenOrientation orientation)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'primaryOrientationChanged'. This is the getter.
The object exposes a writable attribute 'primaryOrientationChanged'. This is the setter.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QScreen::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

refreshRate

Signature: [const] double refreshRate

Description: Method double QScreen::refreshRate()

Python specific notes:
The object exposes a readable attribute 'refreshRate'. This is the getter.

refreshRateChanged

Signature: [signal] void refreshRateChanged (double refreshRate)

Description: Signal declaration for QScreen::refreshRateChanged(double refreshRate)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'refreshRateChanged'. This is the getter.
The object exposes a writable attribute 'refreshRateChanged'. This is the setter.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QScreen::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QScreen::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

serialNumber

Signature: [const] string serialNumber

Description: Method QString QScreen::serialNumber()

Python specific notes:
The object exposes a readable attribute 'serialNumber'. This is the getter.

setOrientationUpdateMask

Signature: void setOrientationUpdateMask (Qt_QFlags_ScreenOrientation mask)

Description: Method void QScreen::setOrientationUpdateMask(QFlags<Qt::ScreenOrientation> mask)

Python specific notes:
The object exposes a writable attribute 'orientationUpdateMask'. This is the setter.

size

Signature: [const] QSize size

Description: Method QSize QScreen::size()

Python specific notes:
The object exposes a readable attribute 'size'. This is the getter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QScreen::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QScreen::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QScreen::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

transformBetween

Signature: [const] QTransform transformBetween (const Qt_ScreenOrientation a, const Qt_ScreenOrientation b, const QRect target)

Description: Method QTransform QScreen::transformBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, const QRect &target)

virtualGeometry

Signature: [const] QRect virtualGeometry

Description: Method QRect QScreen::virtualGeometry()

Python specific notes:
The object exposes a readable attribute 'virtualGeometry'. This is the getter.

virtualGeometryChanged

Signature: [signal] void virtualGeometryChanged (const QRect rect)

Description: Signal declaration for QScreen::virtualGeometryChanged(const QRect &rect)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'virtualGeometryChanged'. This is the getter.
The object exposes a writable attribute 'virtualGeometryChanged'. This is the setter.

virtualSiblings

Signature: [const] QScreen ptr[] virtualSiblings

Description: Method QList<QScreen *> QScreen::virtualSiblings()

virtualSize

Signature: [const] QSize virtualSize

Description: Method QSize QScreen::virtualSize()

Python specific notes:
The object exposes a readable attribute 'virtualSize'. This is the getter.