API reference - Class QVideoWindowControl

_const_cast

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

aspectRatioMode

Signature: [const] Qt_AspectRatioMode aspectRatioMode

Description: Virtual method Qt::AspectRatioMode QVideoWindowControl::aspectRatioMode()

This method can be reimplemented in a derived class.

aspectRatioMode=

Signature: void aspectRatioMode= (const Qt_AspectRatioMode mode)

Description: Method void QVideoWindowControl::setAspectRatioMode(Qt::AspectRatioMode mode)

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

brightness

Signature: [const] int brightness

Description: Virtual method int QVideoWindowControl::brightness()

This method can be reimplemented in a derived class.

brightness=

Signature: void brightness= (int brightness)

Description: Method void QVideoWindowControl::setBrightness(int brightness)

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

brightnessChanged

Signature: [signal] void brightnessChanged (int brightness)

Description: Signal declaration for QVideoWindowControl::brightnessChanged(int brightness)

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

contrast

Signature: [const] int contrast

Description: Virtual method int QVideoWindowControl::contrast()

This method can be reimplemented in a derived class.

contrast=

Signature: void contrast= (int contrast)

Description: Method void QVideoWindowControl::setContrast(int contrast)

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

contrastChanged

Signature: [signal] void contrastChanged (int contrast)

Description: Signal declaration for QVideoWindowControl::contrastChanged(int contrast)

You can bind a procedure to this signal.

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QVideoWindowControl::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 QVideoWindowControl::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

displayRect

Signature: [const] QRect displayRect

Description: Virtual method QRect QVideoWindowControl::displayRect()

This method can be reimplemented in a derived class.

displayRect=

Signature: void displayRect= (const QRect rect)

Description: Method void QVideoWindowControl::setDisplayRect(const QRect &rect)

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

emit_brightnessChanged

Signature: void emit_brightnessChanged (int brightness)

Description: Emitter for signal void QVideoWindowControl::brightnessChanged(int brightness)

Call this method to emit this signal.

emit_contrastChanged

Signature: void emit_contrastChanged (int contrast)

Description: Emitter for signal void QVideoWindowControl::contrastChanged(int contrast)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_fullScreenChanged

Signature: void emit_fullScreenChanged (bool fullScreen)

Description: Emitter for signal void QVideoWindowControl::fullScreenChanged(bool fullScreen)

Call this method to emit this signal.

emit_hueChanged

Signature: void emit_hueChanged (int hue)

Description: Emitter for signal void QVideoWindowControl::hueChanged(int hue)

Call this method to emit this signal.

emit_nativeSizeChanged

Signature: void emit_nativeSizeChanged

Description: Emitter for signal void QVideoWindowControl::nativeSizeChanged()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_saturationChanged

Signature: void emit_saturationChanged (int saturation)

Description: Emitter for signal void QVideoWindowControl::saturationChanged(int saturation)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

fullScreen

Signature: [const] bool fullScreen

Description: Method bool QVideoWindowControl::isFullScreen()

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

fullScreen=

Signature: void fullScreen= (bool fullScreen)

Description: Method void QVideoWindowControl::setFullScreen(bool fullScreen)

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

fullScreenChanged

Signature: [signal] void fullScreenChanged (bool fullScreen)

Description: Signal declaration for QVideoWindowControl::fullScreenChanged(bool fullScreen)

You can bind a procedure to this signal.

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

hue

Signature: [const] int hue

Description: Virtual method int QVideoWindowControl::hue()

This method can be reimplemented in a derived class.

hue=

Signature: void hue= (int hue)

Description: Method void QVideoWindowControl::setHue(int hue)

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

hueChanged

Signature: [signal] void hueChanged (int hue)

Description: Signal declaration for QVideoWindowControl::hueChanged(int hue)

You can bind a procedure to this signal.

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

isFullScreen

Signature: [const] bool isFullScreen

Description: Virtual method bool QVideoWindowControl::isFullScreen()

This method can be reimplemented in a derived class.

isFullScreen?

Signature: [const] bool isFullScreen?

Description: Method bool QVideoWindowControl::isFullScreen()

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

isSignalConnected

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

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

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

nativeSize

Signature: [const] QSize nativeSize

Description: Virtual method QSize QVideoWindowControl::nativeSize()

This method can be reimplemented in a derived class.

nativeSizeChanged

Signature: [signal] void nativeSizeChanged

Description: Signal declaration for QVideoWindowControl::nativeSizeChanged()

You can bind a procedure to this signal.

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

new

Signature: [static] new QVideoWindowControl new

Description: Constructor QVideoWindowControl::QVideoWindowControl()

This method creates an object of class QVideoWindowControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

receivers

Signature: [const] int receivers (string signal)

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

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

repaint

Signature: void repaint

Description: Virtual method void QVideoWindowControl::repaint()

This method can be reimplemented in a derived class.

saturation

Signature: [const] int saturation

Description: Virtual method int QVideoWindowControl::saturation()

This method can be reimplemented in a derived class.

saturation=

Signature: void saturation= (int saturation)

Description: Method void QVideoWindowControl::setSaturation(int saturation)

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

saturationChanged

Signature: [signal] void saturationChanged (int saturation)

Description: Signal declaration for QVideoWindowControl::saturationChanged(int saturation)

You can bind a procedure to this signal.

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QVideoWindowControl::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QVideoWindowControl::senderSignalIndex()

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

setAspectRatioMode

Signature: void setAspectRatioMode (const Qt_AspectRatioMode mode)

Description: Virtual method void QVideoWindowControl::setAspectRatioMode(Qt::AspectRatioMode mode)

This method can be reimplemented in a derived class.

setBrightness

Signature: void setBrightness (int brightness)

Description: Virtual method void QVideoWindowControl::setBrightness(int brightness)

This method can be reimplemented in a derived class.

setContrast

Signature: void setContrast (int contrast)

Description: Virtual method void QVideoWindowControl::setContrast(int contrast)

This method can be reimplemented in a derived class.

setDisplayRect

Signature: void setDisplayRect (const QRect rect)

Description: Virtual method void QVideoWindowControl::setDisplayRect(const QRect &rect)

This method can be reimplemented in a derived class.

setFullScreen

Signature: void setFullScreen (bool fullScreen)

Description: Virtual method void QVideoWindowControl::setFullScreen(bool fullScreen)

This method can be reimplemented in a derived class.

setHue

Signature: void setHue (int hue)

Description: Virtual method void QVideoWindowControl::setHue(int hue)

This method can be reimplemented in a derived class.

setSaturation

Signature: void setSaturation (int saturation)

Description: Virtual method void QVideoWindowControl::setSaturation(int saturation)

This method can be reimplemented in a derived class.

setWinId

Signature: void setWinId (unsigned long long id)

Description: Virtual method void QVideoWindowControl::setWinId(WId id)

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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

winId

Signature: [const] unsigned long long winId

Description: Virtual method WId QVideoWindowControl::winId()

This method can be reimplemented in a derived class.

winId=

Signature: void winId= (unsigned long long id)

Description: Method void QVideoWindowControl::setWinId(WId id)

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