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

API reference - Class QCameraFocus

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraFocus

Class hierarchy: QCameraFocus » QObject

Sub-classes: FocusMode, QFlags_FocusMode, FocusPointMode, QFlags_FocusPointMode

Public methods

[const]QCameraFocus ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
[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]QPointFcustomFocusPointMethod QPointF QCameraFocus::customFocusPoint()
voidcustomFocusPoint=(const QPointF point)Method void QCameraFocus::setCustomFocusPoint(const QPointF &point)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QCameraFocus::destroyed(QObject *)
[const]doubledigitalZoomMethod double QCameraFocus::digitalZoom()
[signal]voiddigitalZoomChanged(double arg1)Signal declaration for QCameraFocus::digitalZoomChanged(double)
[const]QCameraFocus_QFlags_FocusModefocusModeMethod QFlags<QCameraFocus::FocusMode> QCameraFocus::focusMode()
voidfocusMode=(QCameraFocus_QFlags_FocusMode mode)Method void QCameraFocus::setFocusMode(QFlags<QCameraFocus::FocusMode> mode)
[const]QCameraFocus_FocusPointModefocusPointModeMethod QCameraFocus::FocusPointMode QCameraFocus::focusPointMode()
voidfocusPointMode=(const QCameraFocus_FocusPointMode mode)Method void QCameraFocus::setFocusPointMode(QCameraFocus::FocusPointMode mode)
[const]QCameraFocusZone[]focusZonesMethod QList<QCameraFocusZone> QCameraFocus::focusZones()
[signal]voidfocusZonesChangedSignal declaration for QCameraFocus::focusZonesChanged()
[const]boolisAvailable?Method bool QCameraFocus::isAvailable()
[const]boolisFocusModeSupported?(QCameraFocus_QFlags_FocusMode mode)Method bool QCameraFocus::isFocusModeSupported(QFlags<QCameraFocus::FocusMode> mode)
[const]boolisFocusPointModeSupported?(const QCameraFocus_FocusPointMode arg1)Method bool QCameraFocus::isFocusPointModeSupported(QCameraFocus::FocusPointMode)
[const]doublemaximumDigitalZoomMethod double QCameraFocus::maximumDigitalZoom()
[signal]voidmaximumDigitalZoomChanged(double arg1)Signal declaration for QCameraFocus::maximumDigitalZoomChanged(double)
[const]doublemaximumOpticalZoomMethod double QCameraFocus::maximumOpticalZoom()
[signal]voidmaximumOpticalZoomChanged(double arg1)Signal declaration for QCameraFocus::maximumOpticalZoomChanged(double)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QCameraFocus::objectNameChanged(const QString &objectName)
[const]doubleopticalZoomMethod double QCameraFocus::opticalZoom()
[signal]voidopticalZoomChanged(double arg1)Signal declaration for QCameraFocus::opticalZoomChanged(double)
voidsetCustomFocusPoint(const QPointF point)Method void QCameraFocus::setCustomFocusPoint(const QPointF &point)
voidsetFocusMode(QCameraFocus_QFlags_FocusMode mode)Method void QCameraFocus::setFocusMode(QFlags<QCameraFocus::FocusMode> mode)
voidsetFocusPointMode(const QCameraFocus_FocusPointMode mode)Method void QCameraFocus::setFocusPointMode(QCameraFocus::FocusPointMode mode)
voidzoomTo(double opticalZoom,
double digitalZoom)
Method void QCameraFocus::zoomTo(double opticalZoom, double digitalZoom)

Public static methods and constants

[static,const]QCameraFocus_FocusModeAutoFocusEnum constant QCameraFocus::AutoFocus
[static,const]QCameraFocus_FocusModeContinuousFocusEnum constant QCameraFocus::ContinuousFocus
[static,const]QCameraFocus_FocusPointModeFocusPointAutoEnum constant QCameraFocus::FocusPointAuto
[static,const]QCameraFocus_FocusPointModeFocusPointCenterEnum constant QCameraFocus::FocusPointCenter
[static,const]QCameraFocus_FocusPointModeFocusPointCustomEnum constant QCameraFocus::FocusPointCustom
[static,const]QCameraFocus_FocusPointModeFocusPointFaceDetectionEnum constant QCameraFocus::FocusPointFaceDetection
[static,const]QCameraFocus_FocusModeHyperfocalFocusEnum constant QCameraFocus::HyperfocalFocus
[static,const]QCameraFocus_FocusModeInfinityFocusEnum constant QCameraFocus::InfinityFocus
[static,const]QCameraFocus_FocusModeMacroFocusEnum constant QCameraFocus::MacroFocus
[static,const]QCameraFocus_FocusModeManualFocusEnum constant QCameraFocus::ManualFocus
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraFocus::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QCameraFocus::trUtf8(const char *s, const char *c, int n)

Detailed description

AutoFocus

Signature: [static,const] QCameraFocus_FocusMode AutoFocus

Description: Enum constant QCameraFocus::AutoFocus

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

ContinuousFocus

Signature: [static,const] QCameraFocus_FocusMode ContinuousFocus

Description: Enum constant QCameraFocus::ContinuousFocus

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

FocusPointAuto

Signature: [static,const] QCameraFocus_FocusPointMode FocusPointAuto

Description: Enum constant QCameraFocus::FocusPointAuto

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

FocusPointCenter

Signature: [static,const] QCameraFocus_FocusPointMode FocusPointCenter

Description: Enum constant QCameraFocus::FocusPointCenter

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

FocusPointCustom

Signature: [static,const] QCameraFocus_FocusPointMode FocusPointCustom

Description: Enum constant QCameraFocus::FocusPointCustom

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

FocusPointFaceDetection

Signature: [static,const] QCameraFocus_FocusPointMode FocusPointFaceDetection

Description: Enum constant QCameraFocus::FocusPointFaceDetection

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

HyperfocalFocus

Signature: [static,const] QCameraFocus_FocusMode HyperfocalFocus

Description: Enum constant QCameraFocus::HyperfocalFocus

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

InfinityFocus

Signature: [static,const] QCameraFocus_FocusMode InfinityFocus

Description: Enum constant QCameraFocus::InfinityFocus

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

MacroFocus

Signature: [static,const] QCameraFocus_FocusMode MacroFocus

Description: Enum constant QCameraFocus::MacroFocus

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

ManualFocus

Signature: [static,const] QCameraFocus_FocusMode ManualFocus

Description: Enum constant QCameraFocus::ManualFocus

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

_const_cast

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

_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.

customFocusPoint

Signature: [const] QPointF customFocusPoint

Description: Method QPointF QCameraFocus::customFocusPoint()

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

customFocusPoint=

Signature: void customFocusPoint= (const QPointF point)

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

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

destroyed

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

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

digitalZoom

Signature: [const] double digitalZoom

Description: Method double QCameraFocus::digitalZoom()

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

digitalZoomChanged

Signature: [signal] void digitalZoomChanged (double arg1)

Description: Signal declaration for QCameraFocus::digitalZoomChanged(double)

You can bind a procedure to this signal.

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

focusMode

Signature: [const] QCameraFocus_QFlags_FocusMode focusMode

Description: Method QFlags<QCameraFocus::FocusMode> QCameraFocus::focusMode()

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

focusMode=

Signature: void focusMode= (QCameraFocus_QFlags_FocusMode mode)

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

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

focusPointMode

Signature: [const] QCameraFocus_FocusPointMode focusPointMode

Description: Method QCameraFocus::FocusPointMode QCameraFocus::focusPointMode()

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

focusPointMode=

Signature: void focusPointMode= (const QCameraFocus_FocusPointMode mode)

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

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

focusZones

Signature: [const] QCameraFocusZone[] focusZones

Description: Method QList<QCameraFocusZone> QCameraFocus::focusZones()

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

focusZonesChanged

Signature: [signal] void focusZonesChanged

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

isAvailable?

Signature: [const] bool isAvailable?

Description: Method bool QCameraFocus::isAvailable()

isFocusModeSupported?

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

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

isFocusPointModeSupported?

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

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

maximumDigitalZoom

Signature: [const] double maximumDigitalZoom

Description: Method double QCameraFocus::maximumDigitalZoom()

maximumDigitalZoomChanged

Signature: [signal] void maximumDigitalZoomChanged (double arg1)

Description: Signal declaration for QCameraFocus::maximumDigitalZoomChanged(double)

You can bind a procedure to this signal.

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

maximumOpticalZoom

Signature: [const] double maximumOpticalZoom

Description: Method double QCameraFocus::maximumOpticalZoom()

maximumOpticalZoomChanged

Signature: [signal] void maximumOpticalZoomChanged (double arg1)

Description: Signal declaration for QCameraFocus::maximumOpticalZoomChanged(double)

You can bind a procedure to this signal.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

opticalZoom

Signature: [const] double opticalZoom

Description: Method double QCameraFocus::opticalZoom()

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

opticalZoomChanged

Signature: [signal] void opticalZoomChanged (double arg1)

Description: Signal declaration for QCameraFocus::opticalZoomChanged(double)

You can bind a procedure to this signal.

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

setCustomFocusPoint

Signature: void setCustomFocusPoint (const QPointF point)

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

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

setFocusMode

Signature: void setFocusMode (QCameraFocus_QFlags_FocusMode mode)

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

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

setFocusPointMode

Signature: void setFocusPointMode (const QCameraFocus_FocusPointMode mode)

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

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

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

Description: Static method QString QCameraFocus::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 QCameraFocus::trUtf8(const char *s, const char *c, int n)

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

zoomTo

Signature: void zoomTo (double opticalZoom, double digitalZoom)

Description: Method void QCameraFocus::zoomTo(double opticalZoom, double digitalZoom)