API reference - Class QGestureRecognizer

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGestureRecognizer

Class hierarchy: QGestureRecognizer

Sub-classes: ResultFlag, QFlags_ResultFlag

Public constructors

new QGestureRecognizernewConstructor QGestureRecognizer::QGestureRecognizer()

Public methods

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.
voidassign(const QGestureRecognizer other)Assigns another object to self
[const]new QGestureRecognizer ptrdupCreates a copy of self
QGesture ptrqt_create(QObject ptr target)Virtual method QGesture *QGestureRecognizer::create(QObject *target)
QGestureRecognizer_QFlags_ResultFlagrecognize(QGesture ptr state,
QObject ptr watched,
QEvent ptr event)
Virtual method QFlags<QGestureRecognizer::ResultFlag> QGestureRecognizer::recognize(QGesture *state, QObject *watched, QEvent *event)
voidreset(QGesture ptr state)Virtual method void QGestureRecognizer::reset(QGesture *state)

Public static methods and constants

[static,const]QGestureRecognizer_ResultFlagCancelGestureEnum constant QGestureRecognizer::CancelGesture
[static,const]QGestureRecognizer_ResultFlagConsumeEventHintEnum constant QGestureRecognizer::ConsumeEventHint
[static,const]QGestureRecognizer_ResultFlagFinishGestureEnum constant QGestureRecognizer::FinishGesture
[static,const]QGestureRecognizer_ResultFlagIgnoreEnum constant QGestureRecognizer::Ignore
[static,const]QGestureRecognizer_ResultFlagMayBeGestureEnum constant QGestureRecognizer::MayBeGesture
[static,const]QGestureRecognizer_ResultFlagResultHint_MaskEnum constant QGestureRecognizer::ResultHint_Mask
[static,const]QGestureRecognizer_ResultFlagResultState_MaskEnum constant QGestureRecognizer::ResultState_Mask
[static,const]QGestureRecognizer_ResultFlagTriggerGestureEnum constant QGestureRecognizer::TriggerGesture
Qt_GestureTyperegisterRecognizer(QGestureRecognizer ptr recognizer)Static method Qt::GestureType QGestureRecognizer::registerRecognizer(QGestureRecognizer *recognizer)
voidunregisterRecognizer(const Qt_GestureType type)Static method void QGestureRecognizer::unregisterRecognizer(Qt::GestureType type)

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

CancelGesture

Signature: [static,const] QGestureRecognizer_ResultFlag CancelGesture

Description: Enum constant QGestureRecognizer::CancelGesture

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

ConsumeEventHint

Signature: [static,const] QGestureRecognizer_ResultFlag ConsumeEventHint

Description: Enum constant QGestureRecognizer::ConsumeEventHint

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

FinishGesture

Signature: [static,const] QGestureRecognizer_ResultFlag FinishGesture

Description: Enum constant QGestureRecognizer::FinishGesture

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

Ignore

Signature: [static,const] QGestureRecognizer_ResultFlag Ignore

Description: Enum constant QGestureRecognizer::Ignore

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

MayBeGesture

Signature: [static,const] QGestureRecognizer_ResultFlag MayBeGesture

Description: Enum constant QGestureRecognizer::MayBeGesture

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

ResultHint_Mask

Signature: [static,const] QGestureRecognizer_ResultFlag ResultHint_Mask

Description: Enum constant QGestureRecognizer::ResultHint_Mask

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

ResultState_Mask

Signature: [static,const] QGestureRecognizer_ResultFlag ResultState_Mask

Description: Enum constant QGestureRecognizer::ResultState_Mask

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

TriggerGesture

Signature: [static,const] QGestureRecognizer_ResultFlag TriggerGesture

Description: Enum constant QGestureRecognizer::TriggerGesture

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

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

assign

Signature: void assign (const QGestureRecognizer other)

Description: Assigns another object to self

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 QGestureRecognizer ptr dup

Description: Creates a copy of self

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

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

Signature: [static] new QGestureRecognizer new

Description: Constructor QGestureRecognizer::QGestureRecognizer()

This method creates an object of class QGestureRecognizer.

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

qt_create

Signature: QGesture ptr qt_create (QObject ptr target)

Description: Virtual method QGesture *QGestureRecognizer::create(QObject *target)

This method can be reimplemented in a derived class.

recognize

Signature: QGestureRecognizer_QFlags_ResultFlag recognize (QGesture ptr state, QObject ptr watched, QEvent ptr event)

Description: Virtual method QFlags<QGestureRecognizer::ResultFlag> QGestureRecognizer::recognize(QGesture *state, QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

registerRecognizer

Signature: [static] Qt_GestureType registerRecognizer (QGestureRecognizer ptr recognizer)

Description: Static method Qt::GestureType QGestureRecognizer::registerRecognizer(QGestureRecognizer *recognizer)

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

reset

Signature: void reset (QGesture ptr state)

Description: Virtual method void QGestureRecognizer::reset(QGesture *state)

This method can be reimplemented in a derived class.

unregisterRecognizer

Signature: [static] void unregisterRecognizer (const Qt_GestureType type)

Description: Static method void QGestureRecognizer::unregisterRecognizer(Qt::GestureType type)

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