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

API reference - Class QCameraFocusZone

Notation used in Ruby API documentation

Module: QtMultimedia

Description: Binding of QCameraFocusZone

Sub-classes: FocusZoneStatus, QFlags_FocusZoneStatus

Public constructors

new QCameraFocusZonenewConstructor QCameraFocusZone::QCameraFocusZone()
new QCameraFocusZonenew(const QRectF area,
const QCameraFocusZone_FocusZoneStatus status = QCameraFocusZone::Selected)
Constructor QCameraFocusZone::QCameraFocusZone(const QRectF &area, QCameraFocusZone::FocusZoneStatus status)
new QCameraFocusZonenew(const QCameraFocusZone other)Constructor QCameraFocusZone::QCameraFocusZone(const QCameraFocusZone &other)

Public methods

[const]bool!=(const QCameraFocusZone other)Method bool QCameraFocusZone::operator!=(const QCameraFocusZone &other)
[const]bool==(const QCameraFocusZone other)Method bool QCameraFocusZone::operator==(const QCameraFocusZone &other)
void_assign(const QCameraFocusZone other)Assigns another object to self
[const]QCameraFocusZone 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]QRectFareaMethod QRectF QCameraFocusZone::area()
QCameraFocusZoneassign(const QCameraFocusZone other)Method QCameraFocusZone &QCameraFocusZone::operator=(const QCameraFocusZone &other)
[const]new QCameraFocusZone ptrdupCreates a copy of self
[const]boolisValid?Method bool QCameraFocusZone::isValid()
voidsetStatus(const QCameraFocusZone_FocusZoneStatus status)Method void QCameraFocusZone::setStatus(QCameraFocusZone::FocusZoneStatus status)
[const]QCameraFocusZone_FocusZoneStatusstatusMethod QCameraFocusZone::FocusZoneStatus QCameraFocusZone::status()
voidstatus=(const QCameraFocusZone_FocusZoneStatus status)Method void QCameraFocusZone::setStatus(QCameraFocusZone::FocusZoneStatus status)

Public static methods and constants

[static,const]QCameraFocusZone_FocusZoneStatusFocusedEnum constant QCameraFocusZone::Focused
[static,const]QCameraFocusZone_FocusZoneStatusInvalidEnum constant QCameraFocusZone::Invalid
[static,const]QCameraFocusZone_FocusZoneStatusSelectedEnum constant QCameraFocusZone::Selected
[static,const]QCameraFocusZone_FocusZoneStatusUnusedEnum constant QCameraFocusZone::Unused

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QCameraFocusZone other)

Description: Method bool QCameraFocusZone::operator!=(const QCameraFocusZone &other)

==

Signature: [const] bool == (const QCameraFocusZone other)

Description: Method bool QCameraFocusZone::operator==(const QCameraFocusZone &other)

Focused

Signature: [static,const] QCameraFocusZone_FocusZoneStatus Focused

Description: Enum constant QCameraFocusZone::Focused

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

Invalid

Signature: [static,const] QCameraFocusZone_FocusZoneStatus Invalid

Description: Enum constant QCameraFocusZone::Invalid

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

Selected

Signature: [static,const] QCameraFocusZone_FocusZoneStatus Selected

Description: Enum constant QCameraFocusZone::Selected

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

Unused

Signature: [static,const] QCameraFocusZone_FocusZoneStatus Unused

Description: Enum constant QCameraFocusZone::Unused

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

_assign

Signature: void _assign (const QCameraFocusZone other)

Description: Assigns another object to self

_const_cast

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

area

Signature: [const] QRectF area

Description: Method QRectF QCameraFocusZone::area()

assign

Signature: QCameraFocusZone assign (const QCameraFocusZone other)

Description: Method QCameraFocusZone &QCameraFocusZone::operator=(const QCameraFocusZone &other)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QCameraFocusZone ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

isValid?

Signature: [const] bool isValid?

Description: Method bool QCameraFocusZone::isValid()

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

new

(1) Signature: [static] new QCameraFocusZone new

Description: Constructor QCameraFocusZone::QCameraFocusZone()

This method creates an object of class QCameraFocusZone.

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

(2) Signature: [static] new QCameraFocusZone new (const QRectF area, const QCameraFocusZone_FocusZoneStatus status = QCameraFocusZone::Selected)

Description: Constructor QCameraFocusZone::QCameraFocusZone(const QRectF &area, QCameraFocusZone::FocusZoneStatus status)

This method creates an object of class QCameraFocusZone.

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

(3) Signature: [static] new QCameraFocusZone new (const QCameraFocusZone other)

Description: Constructor QCameraFocusZone::QCameraFocusZone(const QCameraFocusZone &other)

This method creates an object of class QCameraFocusZone.

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

setStatus

Signature: void setStatus (const QCameraFocusZone_FocusZoneStatus status)

Description: Method void QCameraFocusZone::setStatus(QCameraFocusZone::FocusZoneStatus status)

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

status

Signature: [const] QCameraFocusZone_FocusZoneStatus status

Description: Method QCameraFocusZone::FocusZoneStatus QCameraFocusZone::status()

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

status=

Signature: void status= (const QCameraFocusZone_FocusZoneStatus status)

Description: Method void QCameraFocusZone::setStatus(QCameraFocusZone::FocusZoneStatus status)

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