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

API reference - Class QScrollerProperties

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QScrollerProperties

Class hierarchy: QScrollerProperties

Sub-classes: ScrollMetric, QFlags_ScrollMetric

Public constructors

new QScrollerPropertiesnewConstructor QScrollerProperties::QScrollerProperties()
new QScrollerPropertiesnew(const QScrollerProperties sp)Constructor QScrollerProperties::QScrollerProperties(const QScrollerProperties &sp)

Public methods

[const]bool!=(const QScrollerProperties sp)Method bool QScrollerProperties::operator!=(const QScrollerProperties &sp)
[const]bool==(const QScrollerProperties sp)Method bool QScrollerProperties::operator==(const QScrollerProperties &sp)
void_assign(const QScrollerProperties other)Assigns another object to self
[const]QScrollerProperties 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]new QScrollerProperties ptr_dupCreates a copy of self
[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.
QScrollerPropertiesassign(const QScrollerProperties sp)Method QScrollerProperties &QScrollerProperties::operator=(const QScrollerProperties &sp)
[const]new QScrollerProperties ptrdupCreates a copy of self
[const]variantscrollMetric(const QScrollerProperties_ScrollMetric metric)Method QVariant QScrollerProperties::scrollMetric(QScrollerProperties::ScrollMetric metric)
voidsetScrollMetric(const QScrollerProperties_ScrollMetric metric,
variant value)
Method void QScrollerProperties::setScrollMetric(QScrollerProperties::ScrollMetric metric, const QVariant &value)

Public static methods and constants

[static,const]QScrollerProperties_ScrollMetricAcceleratingFlickMaximumTimeEnum constant QScrollerProperties::AcceleratingFlickMaximumTime
[static,const]QScrollerProperties_ScrollMetricAcceleratingFlickSpeedupFactorEnum constant QScrollerProperties::AcceleratingFlickSpeedupFactor
[static,const]QScrollerProperties_ScrollMetricAxisLockThresholdEnum constant QScrollerProperties::AxisLockThreshold
[static,const]QScrollerProperties_ScrollMetricDecelerationFactorEnum constant QScrollerProperties::DecelerationFactor
[static,const]QScrollerProperties_ScrollMetricDragStartDistanceEnum constant QScrollerProperties::DragStartDistance
[static,const]QScrollerProperties_ScrollMetricDragVelocitySmoothingFactorEnum constant QScrollerProperties::DragVelocitySmoothingFactor
[static,const]QScrollerProperties_ScrollMetricFrameRateEnum constant QScrollerProperties::FrameRate
[static,const]QScrollerProperties_ScrollMetricHorizontalOvershootPolicyEnum constant QScrollerProperties::HorizontalOvershootPolicy
[static,const]QScrollerProperties_ScrollMetricMaximumClickThroughVelocityEnum constant QScrollerProperties::MaximumClickThroughVelocity
[static,const]QScrollerProperties_ScrollMetricMaximumVelocityEnum constant QScrollerProperties::MaximumVelocity
[static,const]QScrollerProperties_ScrollMetricMinimumVelocityEnum constant QScrollerProperties::MinimumVelocity
[static,const]QScrollerProperties_ScrollMetricMousePressEventDelayEnum constant QScrollerProperties::MousePressEventDelay
[static,const]QScrollerProperties_ScrollMetricOvershootDragDistanceFactorEnum constant QScrollerProperties::OvershootDragDistanceFactor
[static,const]QScrollerProperties_ScrollMetricOvershootDragResistanceFactorEnum constant QScrollerProperties::OvershootDragResistanceFactor
[static,const]QScrollerProperties_ScrollMetricOvershootScrollDistanceFactorEnum constant QScrollerProperties::OvershootScrollDistanceFactor
[static,const]QScrollerProperties_ScrollMetricOvershootScrollTimeEnum constant QScrollerProperties::OvershootScrollTime
[static,const]QScrollerProperties_ScrollMetricScrollMetricCountEnum constant QScrollerProperties::ScrollMetricCount
[static,const]QScrollerProperties_ScrollMetricScrollingCurveEnum constant QScrollerProperties::ScrollingCurve
[static,const]QScrollerProperties_ScrollMetricSnapPositionRatioEnum constant QScrollerProperties::SnapPositionRatio
[static,const]QScrollerProperties_ScrollMetricSnapTimeEnum constant QScrollerProperties::SnapTime
[static,const]QScrollerProperties_ScrollMetricVerticalOvershootPolicyEnum constant QScrollerProperties::VerticalOvershootPolicy
voidsetDefaultScrollerProperties(const QScrollerProperties sp)Static method void QScrollerProperties::setDefaultScrollerProperties(const QScrollerProperties &sp)
voidunsetDefaultScrollerPropertiesStatic method void QScrollerProperties::unsetDefaultScrollerProperties()

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 QScrollerProperties sp)

Description: Method bool QScrollerProperties::operator!=(const QScrollerProperties &sp)

==

Signature: [const] bool == (const QScrollerProperties sp)

Description: Method bool QScrollerProperties::operator==(const QScrollerProperties &sp)

AcceleratingFlickMaximumTime

Signature: [static,const] QScrollerProperties_ScrollMetric AcceleratingFlickMaximumTime

Description: Enum constant QScrollerProperties::AcceleratingFlickMaximumTime

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

AcceleratingFlickSpeedupFactor

Signature: [static,const] QScrollerProperties_ScrollMetric AcceleratingFlickSpeedupFactor

Description: Enum constant QScrollerProperties::AcceleratingFlickSpeedupFactor

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

AxisLockThreshold

Signature: [static,const] QScrollerProperties_ScrollMetric AxisLockThreshold

Description: Enum constant QScrollerProperties::AxisLockThreshold

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

DecelerationFactor

Signature: [static,const] QScrollerProperties_ScrollMetric DecelerationFactor

Description: Enum constant QScrollerProperties::DecelerationFactor

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

DragStartDistance

Signature: [static,const] QScrollerProperties_ScrollMetric DragStartDistance

Description: Enum constant QScrollerProperties::DragStartDistance

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

DragVelocitySmoothingFactor

Signature: [static,const] QScrollerProperties_ScrollMetric DragVelocitySmoothingFactor

Description: Enum constant QScrollerProperties::DragVelocitySmoothingFactor

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

FrameRate

Signature: [static,const] QScrollerProperties_ScrollMetric FrameRate

Description: Enum constant QScrollerProperties::FrameRate

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

HorizontalOvershootPolicy

Signature: [static,const] QScrollerProperties_ScrollMetric HorizontalOvershootPolicy

Description: Enum constant QScrollerProperties::HorizontalOvershootPolicy

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

MaximumClickThroughVelocity

Signature: [static,const] QScrollerProperties_ScrollMetric MaximumClickThroughVelocity

Description: Enum constant QScrollerProperties::MaximumClickThroughVelocity

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

MaximumVelocity

Signature: [static,const] QScrollerProperties_ScrollMetric MaximumVelocity

Description: Enum constant QScrollerProperties::MaximumVelocity

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

MinimumVelocity

Signature: [static,const] QScrollerProperties_ScrollMetric MinimumVelocity

Description: Enum constant QScrollerProperties::MinimumVelocity

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

MousePressEventDelay

Signature: [static,const] QScrollerProperties_ScrollMetric MousePressEventDelay

Description: Enum constant QScrollerProperties::MousePressEventDelay

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

OvershootDragDistanceFactor

Signature: [static,const] QScrollerProperties_ScrollMetric OvershootDragDistanceFactor

Description: Enum constant QScrollerProperties::OvershootDragDistanceFactor

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

OvershootDragResistanceFactor

Signature: [static,const] QScrollerProperties_ScrollMetric OvershootDragResistanceFactor

Description: Enum constant QScrollerProperties::OvershootDragResistanceFactor

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

OvershootScrollDistanceFactor

Signature: [static,const] QScrollerProperties_ScrollMetric OvershootScrollDistanceFactor

Description: Enum constant QScrollerProperties::OvershootScrollDistanceFactor

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

OvershootScrollTime

Signature: [static,const] QScrollerProperties_ScrollMetric OvershootScrollTime

Description: Enum constant QScrollerProperties::OvershootScrollTime

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

ScrollMetricCount

Signature: [static,const] QScrollerProperties_ScrollMetric ScrollMetricCount

Description: Enum constant QScrollerProperties::ScrollMetricCount

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

ScrollingCurve

Signature: [static,const] QScrollerProperties_ScrollMetric ScrollingCurve

Description: Enum constant QScrollerProperties::ScrollingCurve

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

SnapPositionRatio

Signature: [static,const] QScrollerProperties_ScrollMetric SnapPositionRatio

Description: Enum constant QScrollerProperties::SnapPositionRatio

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

SnapTime

Signature: [static,const] QScrollerProperties_ScrollMetric SnapTime

Description: Enum constant QScrollerProperties::SnapTime

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

VerticalOvershootPolicy

Signature: [static,const] QScrollerProperties_ScrollMetric VerticalOvershootPolicy

Description: Enum constant QScrollerProperties::VerticalOvershootPolicy

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

_assign

Signature: void _assign (const QScrollerProperties other)

Description: Assigns another object to self

_const_cast

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

_dup

Signature: [const] new QScrollerProperties ptr _dup

Description: Creates a copy of self

_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: QScrollerProperties assign (const QScrollerProperties sp)

Description: Method QScrollerProperties &QScrollerProperties::operator=(const QScrollerProperties &sp)

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 QScrollerProperties 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

(1) Signature: [static] new QScrollerProperties new

Description: Constructor QScrollerProperties::QScrollerProperties()

This method creates an object of class QScrollerProperties.

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

(2) Signature: [static] new QScrollerProperties new (const QScrollerProperties sp)

Description: Constructor QScrollerProperties::QScrollerProperties(const QScrollerProperties &sp)

This method creates an object of class QScrollerProperties.

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

scrollMetric

Signature: [const] variant scrollMetric (const QScrollerProperties_ScrollMetric metric)

Description: Method QVariant QScrollerProperties::scrollMetric(QScrollerProperties::ScrollMetric metric)

setDefaultScrollerProperties

Signature: [static] void setDefaultScrollerProperties (const QScrollerProperties sp)

Description: Static method void QScrollerProperties::setDefaultScrollerProperties(const QScrollerProperties &sp)

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

setScrollMetric

Signature: void setScrollMetric (const QScrollerProperties_ScrollMetric metric, variant value)

Description: Method void QScrollerProperties::setScrollMetric(QScrollerProperties::ScrollMetric metric, const QVariant &value)

unsetDefaultScrollerProperties

Signature: [static] void unsetDefaultScrollerProperties

Description: Static method void QScrollerProperties::unsetDefaultScrollerProperties()

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