KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QCameraFocusControl

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraFocusControl

Class hierarchy: QCameraFocusControl » QMediaControl » QObject

Public constructors

new QCameraFocusControlnewConstructor QCameraFocusControl::QCameraFocusControl()

Public methods

[const]QCameraFocusControl ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]QPointFcustomFocusPointVirtual method QPointF QCameraFocusControl::customFocusPoint()
voidcustomFocusPoint=(const QPointF point)Method void QCameraFocusControl::setCustomFocusPoint(const QPointF &point)
[signal]voidcustomFocusPointChanged(const QPointF point)Signal declaration for QCameraFocusControl::customFocusPointChanged(const QPointF &point)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QCameraFocusControl::destroyed(QObject *)
voidemit_customFocusPointChanged(const QPointF point)Emitter for signal void QCameraFocusControl::customFocusPointChanged(const QPointF &point)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QCameraFocusControl::destroyed(QObject *)
voidemit_focusModeChanged(QCameraFocus_QFlags_FocusMode mode)Emitter for signal void QCameraFocusControl::focusModeChanged(QFlags<QCameraFocus::FocusMode> mode)
voidemit_focusPointModeChanged(const QCameraFocus_FocusPointMode mode)Emitter for signal void QCameraFocusControl::focusPointModeChanged(QCameraFocus::FocusPointMode mode)
voidemit_focusZonesChangedEmitter for signal void QCameraFocusControl::focusZonesChanged()
voidemit_objectNameChanged(string objectName)Emitter for signal void QCameraFocusControl::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QCameraFocusControl::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QCameraFocusControl::eventFilter(QObject *watched, QEvent *event)
[const]QCameraFocus_QFlags_FocusModefocusModeVirtual method QFlags<QCameraFocus::FocusMode> QCameraFocusControl::focusMode()
voidfocusMode=(QCameraFocus_QFlags_FocusMode mode)Method void QCameraFocusControl::setFocusMode(QFlags<QCameraFocus::FocusMode> mode)
[signal]voidfocusModeChanged(QCameraFocus_QFlags_FocusMode mode)Signal declaration for QCameraFocusControl::focusModeChanged(QFlags<QCameraFocus::FocusMode> mode)
[const]QCameraFocus_FocusPointModefocusPointModeVirtual method QCameraFocus::FocusPointMode QCameraFocusControl::focusPointMode()
voidfocusPointMode=(const QCameraFocus_FocusPointMode mode)Method void QCameraFocusControl::setFocusPointMode(QCameraFocus::FocusPointMode mode)
[signal]voidfocusPointModeChanged(const QCameraFocus_FocusPointMode mode)Signal declaration for QCameraFocusControl::focusPointModeChanged(QCameraFocus::FocusPointMode mode)
[const]QCameraFocusZone[]focusZonesVirtual method QList<QCameraFocusZone> QCameraFocusControl::focusZones()
[signal]voidfocusZonesChangedSignal declaration for QCameraFocusControl::focusZonesChanged()
[const]boolisFocusModeSupported(QCameraFocus_QFlags_FocusMode mode)Virtual method bool QCameraFocusControl::isFocusModeSupported(QFlags<QCameraFocus::FocusMode> mode)
[const]boolisFocusModeSupported?(QCameraFocus_QFlags_FocusMode mode)Method bool QCameraFocusControl::isFocusModeSupported(QFlags<QCameraFocus::FocusMode> mode)
[const]boolisFocusPointModeSupported(const QCameraFocus_FocusPointMode mode)Virtual method bool QCameraFocusControl::isFocusPointModeSupported(QCameraFocus::FocusPointMode mode)
[const]boolisFocusPointModeSupported?(const QCameraFocus_FocusPointMode mode)Method bool QCameraFocusControl::isFocusPointModeSupported(QCameraFocus::FocusPointMode mode)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QCameraFocusControl::objectNameChanged(const QString &objectName)
voidsetCustomFocusPoint(const QPointF point)Virtual method void QCameraFocusControl::setCustomFocusPoint(const QPointF &point)
voidsetFocusMode(QCameraFocus_QFlags_FocusMode mode)Virtual method void QCameraFocusControl::setFocusMode(QFlags<QCameraFocus::FocusMode> mode)
voidsetFocusPointMode(const QCameraFocus_FocusPointMode mode)Virtual method void QCameraFocusControl::setFocusPointMode(QCameraFocus::FocusPointMode mode)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraFocusControl::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraFocusControl::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QCameraFocusControl::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QCameraFocusControl::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QCameraFocusControl::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QCameraFocusControl::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QCameraFocusControl::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QCameraFocusControl::sender()
[const]intsenderSignalIndexMethod int QCameraFocusControl::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QCameraFocusControl::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

customFocusPoint

Signature: [const] QPointF customFocusPoint

Description: Virtual method QPointF QCameraFocusControl::customFocusPoint()

This method can be reimplemented in a derived class.

customFocusPoint=

Signature: void customFocusPoint= (const QPointF point)

Description: Method void QCameraFocusControl::setCustomFocusPoint(const QPointF &point)

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

customFocusPointChanged

Signature: [signal] void customFocusPointChanged (const QPointF point)

Description: Signal declaration for QCameraFocusControl::customFocusPointChanged(const QPointF &point)

You can bind a procedure to this signal.

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

destroyed

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

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

This method can be reimplemented in a derived class.

emit_customFocusPointChanged

Signature: void emit_customFocusPointChanged (const QPointF point)

Description: Emitter for signal void QCameraFocusControl::customFocusPointChanged(const QPointF &point)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_focusModeChanged

Signature: void emit_focusModeChanged (QCameraFocus_QFlags_FocusMode mode)

Description: Emitter for signal void QCameraFocusControl::focusModeChanged(QFlags<QCameraFocus::FocusMode> mode)

Call this method to emit this signal.

emit_focusPointModeChanged

Signature: void emit_focusPointModeChanged (const QCameraFocus_FocusPointMode mode)

Description: Emitter for signal void QCameraFocusControl::focusPointModeChanged(QCameraFocus::FocusPointMode mode)

Call this method to emit this signal.

emit_focusZonesChanged

Signature: void emit_focusZonesChanged

Description: Emitter for signal void QCameraFocusControl::focusZonesChanged()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

focusMode

Signature: [const] QCameraFocus_QFlags_FocusMode focusMode

Description: Virtual method QFlags<QCameraFocus::FocusMode> QCameraFocusControl::focusMode()

This method can be reimplemented in a derived class.

focusMode=

Signature: void focusMode= (QCameraFocus_QFlags_FocusMode mode)

Description: Method void QCameraFocusControl::setFocusMode(QFlags<QCameraFocus::FocusMode> mode)

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

focusModeChanged

Signature: [signal] void focusModeChanged (QCameraFocus_QFlags_FocusMode mode)

Description: Signal declaration for QCameraFocusControl::focusModeChanged(QFlags<QCameraFocus::FocusMode> mode)

You can bind a procedure to this signal.

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

focusPointMode

Signature: [const] QCameraFocus_FocusPointMode focusPointMode

Description: Virtual method QCameraFocus::FocusPointMode QCameraFocusControl::focusPointMode()

This method can be reimplemented in a derived class.

focusPointMode=

Signature: void focusPointMode= (const QCameraFocus_FocusPointMode mode)

Description: Method void QCameraFocusControl::setFocusPointMode(QCameraFocus::FocusPointMode mode)

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

focusPointModeChanged

Signature: [signal] void focusPointModeChanged (const QCameraFocus_FocusPointMode mode)

Description: Signal declaration for QCameraFocusControl::focusPointModeChanged(QCameraFocus::FocusPointMode mode)

You can bind a procedure to this signal.

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

focusZones

Signature: [const] QCameraFocusZone[] focusZones

Description: Virtual method QList<QCameraFocusZone> QCameraFocusControl::focusZones()

This method can be reimplemented in a derived class.

focusZonesChanged

Signature: [signal] void focusZonesChanged

Description: Signal declaration for QCameraFocusControl::focusZonesChanged()

You can bind a procedure to this signal.

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

isFocusModeSupported

Signature: [const] bool isFocusModeSupported (QCameraFocus_QFlags_FocusMode mode)

Description: Virtual method bool QCameraFocusControl::isFocusModeSupported(QFlags<QCameraFocus::FocusMode> mode)

This method can be reimplemented in a derived class.

isFocusModeSupported?

Signature: [const] bool isFocusModeSupported? (QCameraFocus_QFlags_FocusMode mode)

Description: Method bool QCameraFocusControl::isFocusModeSupported(QFlags<QCameraFocus::FocusMode> mode)

isFocusPointModeSupported

Signature: [const] bool isFocusPointModeSupported (const QCameraFocus_FocusPointMode mode)

Description: Virtual method bool QCameraFocusControl::isFocusPointModeSupported(QCameraFocus::FocusPointMode mode)

This method can be reimplemented in a derived class.

isFocusPointModeSupported?

Signature: [const] bool isFocusPointModeSupported? (const QCameraFocus_FocusPointMode mode)

Description: Method bool QCameraFocusControl::isFocusPointModeSupported(QCameraFocus::FocusPointMode mode)

isSignalConnected

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

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

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

new

Signature: [static] new QCameraFocusControl new

Description: Constructor QCameraFocusControl::QCameraFocusControl()

This method creates an object of class QCameraFocusControl.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QCameraFocusControl::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 QCameraFocusControl::receivers(const char *signal)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QCameraFocusControl::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QCameraFocusControl::senderSignalIndex()

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

setCustomFocusPoint

Signature: void setCustomFocusPoint (const QPointF point)

Description: Virtual method void QCameraFocusControl::setCustomFocusPoint(const QPointF &point)

This method can be reimplemented in a derived class.

setFocusMode

Signature: void setFocusMode (QCameraFocus_QFlags_FocusMode mode)

Description: Virtual method void QCameraFocusControl::setFocusMode(QFlags<QCameraFocus::FocusMode> mode)

This method can be reimplemented in a derived class.

setFocusPointMode

Signature: void setFocusPointMode (const QCameraFocus_FocusPointMode mode)

Description: Virtual method void QCameraFocusControl::setFocusPointMode(QCameraFocus::FocusPointMode mode)

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 QCameraFocusControl::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 QCameraFocusControl::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 QCameraFocusControl::trUtf8(const char *s, const char *c, int n)

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