KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QTouchDevice

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QTouchDevice

Sub-classes: CapabilityFlag, QFlags_CapabilityFlag, DeviceType, QFlags_DeviceType

Public constructors

new QTouchDevicenewConstructor QTouchDevice::QTouchDevice()

Public methods

[const]QTouchDevice 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.
voidassign(const QTouchDevice other)Assigns another object to self
[const]QTouchDevice_QFlags_CapabilityFlagcapabilitiesMethod QFlags<QTouchDevice::CapabilityFlag> QTouchDevice::capabilities()
voidcapabilities=(QTouchDevice_QFlags_CapabilityFlag caps)Method void QTouchDevice::setCapabilities(QFlags<QTouchDevice::CapabilityFlag> caps)
[const]new QTouchDevice ptrdupCreates a copy of self
[const]intmaximumTouchPointsMethod int QTouchDevice::maximumTouchPoints()
voidmaximumTouchPoints=(int max)Method void QTouchDevice::setMaximumTouchPoints(int max)
[const]stringnameMethod QString QTouchDevice::name()
voidname=(string name)Method void QTouchDevice::setName(const QString &name)
voidsetCapabilities(QTouchDevice_QFlags_CapabilityFlag caps)Method void QTouchDevice::setCapabilities(QFlags<QTouchDevice::CapabilityFlag> caps)
voidsetMaximumTouchPoints(int max)Method void QTouchDevice::setMaximumTouchPoints(int max)
voidsetName(string name)Method void QTouchDevice::setName(const QString &name)
voidsetType(const QTouchDevice_DeviceType devType)Method void QTouchDevice::setType(QTouchDevice::DeviceType devType)
[const]QTouchDevice_DeviceTypetypeMethod QTouchDevice::DeviceType QTouchDevice::type()
voidtype=(const QTouchDevice_DeviceType devType)Method void QTouchDevice::setType(QTouchDevice::DeviceType devType)

Public static methods and constants

[static,const]QTouchDevice_CapabilityFlagAreaEnum constant QTouchDevice::Area
[static,const]QTouchDevice_CapabilityFlagMouseEmulationEnum constant QTouchDevice::MouseEmulation
[static,const]QTouchDevice_CapabilityFlagNormalizedPositionEnum constant QTouchDevice::NormalizedPosition
[static,const]QTouchDevice_CapabilityFlagPositionEnum constant QTouchDevice::Position
[static,const]QTouchDevice_CapabilityFlagPressureEnum constant QTouchDevice::Pressure
[static,const]QTouchDevice_CapabilityFlagRawPositionsEnum constant QTouchDevice::RawPositions
[static,const]QTouchDevice_DeviceTypeTouchPadEnum constant QTouchDevice::TouchPad
[static,const]QTouchDevice_DeviceTypeTouchScreenEnum constant QTouchDevice::TouchScreen
[static,const]QTouchDevice_CapabilityFlagVelocityEnum constant QTouchDevice::Velocity
const QTouchDevice ptr[]devicesStatic method QList<const QTouchDevice *> QTouchDevice::devices()

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

Area

Signature: [static,const] QTouchDevice_CapabilityFlag Area

Description: Enum constant QTouchDevice::Area

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

MouseEmulation

Signature: [static,const] QTouchDevice_CapabilityFlag MouseEmulation

Description: Enum constant QTouchDevice::MouseEmulation

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

NormalizedPosition

Signature: [static,const] QTouchDevice_CapabilityFlag NormalizedPosition

Description: Enum constant QTouchDevice::NormalizedPosition

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

Position

Signature: [static,const] QTouchDevice_CapabilityFlag Position

Description: Enum constant QTouchDevice::Position

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

Pressure

Signature: [static,const] QTouchDevice_CapabilityFlag Pressure

Description: Enum constant QTouchDevice::Pressure

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

RawPositions

Signature: [static,const] QTouchDevice_CapabilityFlag RawPositions

Description: Enum constant QTouchDevice::RawPositions

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

TouchPad

Signature: [static,const] QTouchDevice_DeviceType TouchPad

Description: Enum constant QTouchDevice::TouchPad

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

TouchScreen

Signature: [static,const] QTouchDevice_DeviceType TouchScreen

Description: Enum constant QTouchDevice::TouchScreen

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

Velocity

Signature: [static,const] QTouchDevice_CapabilityFlag Velocity

Description: Enum constant QTouchDevice::Velocity

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

_const_cast

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

assign

Signature: void assign (const QTouchDevice other)

Description: Assigns another object to self

capabilities

Signature: [const] QTouchDevice_QFlags_CapabilityFlag capabilities

Description: Method QFlags<QTouchDevice::CapabilityFlag> QTouchDevice::capabilities()

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

capabilities=

Signature: void capabilities= (QTouchDevice_QFlags_CapabilityFlag caps)

Description: Method void QTouchDevice::setCapabilities(QFlags<QTouchDevice::CapabilityFlag> caps)

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

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.

devices

Signature: [static] const QTouchDevice ptr[] devices

Description: Static method QList<const QTouchDevice *> QTouchDevice::devices()

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

dup

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

maximumTouchPoints

Signature: [const] int maximumTouchPoints

Description: Method int QTouchDevice::maximumTouchPoints()

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

maximumTouchPoints=

Signature: void maximumTouchPoints= (int max)

Description: Method void QTouchDevice::setMaximumTouchPoints(int max)

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

name

Signature: [const] string name

Description: Method QString QTouchDevice::name()

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

name=

Signature: void name= (string name)

Description: Method void QTouchDevice::setName(const QString &name)

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

new

Signature: [static] new QTouchDevice new

Description: Constructor QTouchDevice::QTouchDevice()

This method creates an object of class QTouchDevice.

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

setCapabilities

Signature: void setCapabilities (QTouchDevice_QFlags_CapabilityFlag caps)

Description: Method void QTouchDevice::setCapabilities(QFlags<QTouchDevice::CapabilityFlag> caps)

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

setMaximumTouchPoints

Signature: void setMaximumTouchPoints (int max)

Description: Method void QTouchDevice::setMaximumTouchPoints(int max)

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

setName

Signature: void setName (string name)

Description: Method void QTouchDevice::setName(const QString &name)

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

setType

Signature: void setType (const QTouchDevice_DeviceType devType)

Description: Method void QTouchDevice::setType(QTouchDevice::DeviceType devType)

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

type

Signature: [const] QTouchDevice_DeviceType type

Description: Method QTouchDevice::DeviceType QTouchDevice::type()

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

type=

Signature: void type= (const QTouchDevice_DeviceType devType)

Description: Method void QTouchDevice::setType(QTouchDevice::DeviceType devType)

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