API reference - Class QDesktopWidget

_const_cast

Signature: [const] QDesktopWidget 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.

actionEvent

Signature: void actionEvent (QActionEvent ptr event)

Description: Virtual method void QDesktopWidget::actionEvent(QActionEvent *event)

This method can be reimplemented in a derived class.

availableGeometry

(1) Signature: [const] QRect availableGeometry (const QWidget ptr widget)

Description: Method const QRect QDesktopWidget::availableGeometry(const QWidget *widget)

(2) Signature: [const] QRect availableGeometry (int screen = -1)

Description: Method const QRect QDesktopWidget::availableGeometry(int screen)

(3) Signature: [const] QRect availableGeometry (const QPoint point)

Description: Method const QRect QDesktopWidget::availableGeometry(const QPoint &point)

changeEvent

Signature: void changeEvent (QEvent ptr arg1)

Description: Virtual method void QDesktopWidget::changeEvent(QEvent *)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

closeEvent

Signature: void closeEvent (QCloseEvent ptr event)

Description: Virtual method void QDesktopWidget::closeEvent(QCloseEvent *event)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QContextMenuEvent ptr event)

Description: Virtual method void QDesktopWidget::contextMenuEvent(QContextMenuEvent *event)

This method can be reimplemented in a derived class.

create

Signature: void create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QDesktopWidget::create(WId, bool initializeWindow, bool destroyOldWindow)

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

customContextMenuRequested

Signature: [signal] void customContextMenuRequested (const QPoint pos)

Description: Signal declaration for QDesktopWidget::customContextMenuRequested(const QPoint &pos)

You can bind a procedure to this signal.

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroy

Signature: void destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QDesktopWidget::destroy(bool destroyWindow, bool destroySubWindows)

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

destroyed

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

Description: Signal declaration for QDesktopWidget::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.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

dragEnterEvent

Signature: void dragEnterEvent (QDragEnterEvent ptr event)

Description: Virtual method void QDesktopWidget::dragEnterEvent(QDragEnterEvent *event)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QDragLeaveEvent ptr event)

Description: Virtual method void QDesktopWidget::dragLeaveEvent(QDragLeaveEvent *event)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QDragMoveEvent ptr event)

Description: Virtual method void QDesktopWidget::dragMoveEvent(QDragMoveEvent *event)

This method can be reimplemented in a derived class.

dropEvent

Signature: void dropEvent (QDropEvent ptr event)

Description: Virtual method void QDesktopWidget::dropEvent(QDropEvent *event)

This method can be reimplemented in a derived class.

emit_customContextMenuRequested

Signature: void emit_customContextMenuRequested (const QPoint pos)

Description: Emitter for signal void QDesktopWidget::customContextMenuRequested(const QPoint &pos)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_primaryScreenChanged

Signature: void emit_primaryScreenChanged

Description: Emitter for signal void QDesktopWidget::primaryScreenChanged()

Call this method to emit this signal.

emit_resized

Signature: void emit_resized (int arg1)

Description: Emitter for signal void QDesktopWidget::resized(int)

Call this method to emit this signal.

emit_screenCountChanged

Signature: void emit_screenCountChanged (int arg1)

Description: Emitter for signal void QDesktopWidget::screenCountChanged(int)

Call this method to emit this signal.

emit_windowIconChanged

Signature: void emit_windowIconChanged (const QIcon icon)

Description: Emitter for signal void QDesktopWidget::windowIconChanged(const QIcon &icon)

Call this method to emit this signal.

emit_windowIconTextChanged

Signature: void emit_windowIconTextChanged (string iconText)

Description: Emitter for signal void QDesktopWidget::windowIconTextChanged(const QString &iconText)

Call this method to emit this signal.

emit_windowTitleChanged

Signature: void emit_windowTitleChanged (string title)

Description: Emitter for signal void QDesktopWidget::windowTitleChanged(const QString &title)

Call this method to emit this signal.

emit_workAreaResized

Signature: void emit_workAreaResized (int arg1)

Description: Emitter for signal void QDesktopWidget::workAreaResized(int)

Call this method to emit this signal.

enterEvent

Signature: void enterEvent (QEvent ptr event)

Description: Virtual method void QDesktopWidget::enterEvent(QEvent *event)

This method can be reimplemented in a derived class.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QDesktopWidget::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 QDesktopWidget::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr event)

Description: Virtual method void QDesktopWidget::focusInEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusNextChild

Signature: bool focusNextChild

Description: Method bool QDesktopWidget::focusNextChild()

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

focusNextPrevChild

Signature: bool focusNextPrevChild (bool next)

Description: Virtual method bool QDesktopWidget::focusNextPrevChild(bool next)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr event)

Description: Virtual method void QDesktopWidget::focusOutEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusPreviousChild

Signature: bool focusPreviousChild

Description: Method bool QDesktopWidget::focusPreviousChild()

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

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QDesktopWidget::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

Description: Virtual method int QDesktopWidget::heightForWidth(int)

This method can be reimplemented in a derived class.

hideEvent

Signature: void hideEvent (QHideEvent ptr event)

Description: Virtual method void QDesktopWidget::hideEvent(QHideEvent *event)

This method can be reimplemented in a derived class.

initPainter

Signature: [const] void initPainter (QPainter ptr painter)

Description: Virtual method void QDesktopWidget::initPainter(QPainter *painter)

This method can be reimplemented in a derived class.

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr arg1)

Description: Virtual method void QDesktopWidget::inputMethodEvent(QInputMethodEvent *)

This method can be reimplemented in a derived class.

inputMethodQuery

Signature: [const] variant inputMethodQuery (const Qt_InputMethodQuery arg1)

Description: Virtual method QVariant QDesktopWidget::inputMethodQuery(Qt::InputMethodQuery)

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

isVirtualDesktop?

Signature: [const] bool isVirtualDesktop?

Description: Method bool QDesktopWidget::isVirtualDesktop()

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

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr event)

Description: Virtual method void QDesktopWidget::keyPressEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr event)

Description: Virtual method void QDesktopWidget::keyReleaseEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

leaveEvent

Signature: void leaveEvent (QEvent ptr event)

Description: Virtual method void QDesktopWidget::leaveEvent(QEvent *event)

This method can be reimplemented in a derived class.

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric arg1)

Description: Virtual method int QDesktopWidget::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

minimumSizeHint

Signature: [const] QSize minimumSizeHint

Description: Virtual method QSize QDesktopWidget::minimumSizeHint()

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QMouseEvent ptr event)

Description: Virtual method void QDesktopWidget::mouseDoubleClickEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QMouseEvent ptr event)

Description: Virtual method void QDesktopWidget::mouseMoveEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QMouseEvent ptr event)

Description: Virtual method void QDesktopWidget::mousePressEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QMouseEvent ptr event)

Description: Virtual method void QDesktopWidget::mouseReleaseEvent(QMouseEvent *event)

This method can be reimplemented in a derived class.

moveEvent

Signature: void moveEvent (QMoveEvent ptr event)

Description: Virtual method void QDesktopWidget::moveEvent(QMoveEvent *event)

This method can be reimplemented in a derived class.

nativeEvent

Signature: bool nativeEvent (bytes eventType, void * message, long ptr result)

Description: Virtual method bool QDesktopWidget::nativeEvent(const QByteArray &eventType, void *message, long int *result)

This method can be reimplemented in a derived class.

new

Signature: [static] new QDesktopWidget new

Description: Constructor QDesktopWidget::QDesktopWidget()

This method creates an object of class QDesktopWidget.

Python specific notes:
This method is the default initializer of the object.

numScreens

Signature: [const] int numScreens

Description: Method int QDesktopWidget::numScreens()

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QDesktopWidget::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.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QDesktopWidget::paintEngine()

This method can be reimplemented in a derived class.

paintEvent

Signature: void paintEvent (QPaintEvent ptr event)

Description: Virtual method void QDesktopWidget::paintEvent(QPaintEvent *event)

This method can be reimplemented in a derived class.

primaryScreen

Signature: [const] int primaryScreen

Description: Method int QDesktopWidget::primaryScreen()

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

primaryScreenChanged

Signature: [signal] void primaryScreenChanged

Description: Signal declaration for QDesktopWidget::primaryScreenChanged()

You can bind a procedure to this signal.

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

qt_create

Signature: void qt_create (unsigned long long arg1 = 0, bool initializeWindow = true, bool destroyOldWindow = true)

Description: Method void QDesktopWidget::create(WId, bool initializeWindow, bool destroyOldWindow)

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

qt_destroy

Signature: void qt_destroy (bool destroyWindow = true, bool destroySubWindows = true)

Description: Method void QDesktopWidget::destroy(bool destroyWindow, bool destroySubWindows)

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

receivers

Signature: [const] int receivers (string signal)

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

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

redirected

Signature: [const] QPaintDevice ptr redirected (QPoint ptr offset)

Description: Virtual method QPaintDevice *QDesktopWidget::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

resizeEvent

Signature: void resizeEvent (QResizeEvent ptr e)

Description: Virtual method void QDesktopWidget::resizeEvent(QResizeEvent *e)

This method can be reimplemented in a derived class.

resized

Signature: [signal] void resized (int arg1)

Description: Signal declaration for QDesktopWidget::resized(int)

You can bind a procedure to this signal.

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

screen

Signature: QWidget ptr screen (int screen = -1)

Description: Method QWidget *QDesktopWidget::screen(int screen)

screenCount

Signature: [const] int screenCount

Description: Method int QDesktopWidget::screenCount()

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

screenCountChanged

Signature: [signal] void screenCountChanged (int arg1)

Description: Signal declaration for QDesktopWidget::screenCountChanged(int)

You can bind a procedure to this signal.

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

screenGeometry

(1) Signature: [const] QRect screenGeometry (const QWidget ptr widget)

Description: Method const QRect QDesktopWidget::screenGeometry(const QWidget *widget)

(2) Signature: [const] QRect screenGeometry (int screen = -1)

Description: Method const QRect QDesktopWidget::screenGeometry(int screen)

(3) Signature: [const] QRect screenGeometry (const QPoint point)

Description: Method const QRect QDesktopWidget::screenGeometry(const QPoint &point)

screenNumber

(1) Signature: [const] int screenNumber (const QWidget ptr widget = nullptr)

Description: Method int QDesktopWidget::screenNumber(const QWidget *widget)

(2) Signature: [const] int screenNumber (const QPoint arg1)

Description: Method int QDesktopWidget::screenNumber(const QPoint &)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QDesktopWidget::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QDesktopWidget::senderSignalIndex()

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

setVisible

Signature: void setVisible (bool visible)

Description: Virtual method void QDesktopWidget::setVisible(bool visible)

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

Description: Virtual method QPainter *QDesktopWidget::sharedPainter()

This method can be reimplemented in a derived class.

showEvent

Signature: void showEvent (QShowEvent ptr event)

Description: Virtual method void QDesktopWidget::showEvent(QShowEvent *event)

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QDesktopWidget::sizeHint()

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tabletEvent

Signature: void tabletEvent (QTabletEvent ptr event)

Description: Virtual method void QDesktopWidget::tabletEvent(QTabletEvent *event)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QDesktopWidget::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 QDesktopWidget::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 QDesktopWidget::trUtf8(const char *s, const char *c, int n)

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

updateMicroFocus

Signature: void updateMicroFocus

Description: Method void QDesktopWidget::updateMicroFocus()

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

virtualDesktop

Signature: [const] bool virtualDesktop

Description: Method bool QDesktopWidget::isVirtualDesktop()

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

wheelEvent

Signature: void wheelEvent (QWheelEvent ptr event)

Description: Virtual method void QDesktopWidget::wheelEvent(QWheelEvent *event)

This method can be reimplemented in a derived class.

windowIconChanged

Signature: [signal] void windowIconChanged (const QIcon icon)

Description: Signal declaration for QDesktopWidget::windowIconChanged(const QIcon &icon)

You can bind a procedure to this signal.

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

windowIconTextChanged

Signature: [signal] void windowIconTextChanged (string iconText)

Description: Signal declaration for QDesktopWidget::windowIconTextChanged(const QString &iconText)

You can bind a procedure to this signal.

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

windowTitleChanged

Signature: [signal] void windowTitleChanged (string title)

Description: Signal declaration for QDesktopWidget::windowTitleChanged(const QString &title)

You can bind a procedure to this signal.

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

workAreaResized

Signature: [signal] void workAreaResized (int arg1)

Description: Signal declaration for QDesktopWidget::workAreaResized(int)

You can bind a procedure to this signal.

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