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

API reference - Class QPainterPathStroker

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QPainterPathStroker

Public constructors

new QPainterPathStrokernewConstructor QPainterPathStroker::QPainterPathStroker()
new QPainterPathStrokernew(const QPen pen)Constructor QPainterPathStroker::QPainterPathStroker(const QPen &pen)

Public methods

[const]QPainterPathStroker 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]Qt_PenCapStylecapStyleMethod Qt::PenCapStyle QPainterPathStroker::capStyle()
voidcapStyle=(const Qt_PenCapStyle style)Method void QPainterPathStroker::setCapStyle(Qt::PenCapStyle style)
[const]QPainterPathcreateStroke(const QPainterPath path)Method QPainterPath QPainterPathStroker::createStroke(const QPainterPath &path)
[const]doublecurveThresholdMethod double QPainterPathStroker::curveThreshold()
voidcurveThreshold=(double threshold)Method void QPainterPathStroker::setCurveThreshold(double threshold)
[const]doubledashOffsetMethod double QPainterPathStroker::dashOffset()
voiddashOffset=(double offset)Method void QPainterPathStroker::setDashOffset(double offset)
[const]double[]dashPatternMethod QVector<qreal> QPainterPathStroker::dashPattern()
[const]Qt_PenJoinStylejoinStyleMethod Qt::PenJoinStyle QPainterPathStroker::joinStyle()
voidjoinStyle=(const Qt_PenJoinStyle style)Method void QPainterPathStroker::setJoinStyle(Qt::PenJoinStyle style)
[const]doublemiterLimitMethod double QPainterPathStroker::miterLimit()
voidmiterLimit=(double length)Method void QPainterPathStroker::setMiterLimit(double length)
voidsetCapStyle(const Qt_PenCapStyle style)Method void QPainterPathStroker::setCapStyle(Qt::PenCapStyle style)
voidsetCurveThreshold(double threshold)Method void QPainterPathStroker::setCurveThreshold(double threshold)
voidsetDashOffset(double offset)Method void QPainterPathStroker::setDashOffset(double offset)
voidsetDashPattern(const Qt_PenStyle arg1)Method void QPainterPathStroker::setDashPattern(Qt::PenStyle)
voidsetDashPattern(double[] dashPattern)Method void QPainterPathStroker::setDashPattern(const QVector<qreal> &dashPattern)
voidsetJoinStyle(const Qt_PenJoinStyle style)Method void QPainterPathStroker::setJoinStyle(Qt::PenJoinStyle style)
voidsetMiterLimit(double length)Method void QPainterPathStroker::setMiterLimit(double length)
voidsetWidth(double width)Method void QPainterPathStroker::setWidth(double width)
[const]doublewidthMethod double QPainterPathStroker::width()
voidwidth=(double width)Method void QPainterPathStroker::setWidth(double width)

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

_const_cast

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

capStyle

Signature: [const] Qt_PenCapStyle capStyle

Description: Method Qt::PenCapStyle QPainterPathStroker::capStyle()

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

capStyle=

Signature: void capStyle= (const Qt_PenCapStyle style)

Description: Method void QPainterPathStroker::setCapStyle(Qt::PenCapStyle style)

Python specific notes:
The object exposes a writable attribute 'capStyle'. 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.

createStroke

Signature: [const] QPainterPath createStroke (const QPainterPath path)

Description: Method QPainterPath QPainterPathStroker::createStroke(const QPainterPath &path)

curveThreshold

Signature: [const] double curveThreshold

Description: Method double QPainterPathStroker::curveThreshold()

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

curveThreshold=

Signature: void curveThreshold= (double threshold)

Description: Method void QPainterPathStroker::setCurveThreshold(double threshold)

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

dashOffset

Signature: [const] double dashOffset

Description: Method double QPainterPathStroker::dashOffset()

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

dashOffset=

Signature: void dashOffset= (double offset)

Description: Method void QPainterPathStroker::setDashOffset(double offset)

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

dashPattern

Signature: [const] double[] dashPattern

Description: Method QVector<qreal> QPainterPathStroker::dashPattern()

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.

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.

joinStyle

Signature: [const] Qt_PenJoinStyle joinStyle

Description: Method Qt::PenJoinStyle QPainterPathStroker::joinStyle()

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

joinStyle=

Signature: void joinStyle= (const Qt_PenJoinStyle style)

Description: Method void QPainterPathStroker::setJoinStyle(Qt::PenJoinStyle style)

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

miterLimit

Signature: [const] double miterLimit

Description: Method double QPainterPathStroker::miterLimit()

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

miterLimit=

Signature: void miterLimit= (double length)

Description: Method void QPainterPathStroker::setMiterLimit(double length)

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

new

(1) Signature: [static] new QPainterPathStroker new

Description: Constructor QPainterPathStroker::QPainterPathStroker()

This method creates an object of class QPainterPathStroker.

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

(2) Signature: [static] new QPainterPathStroker new (const QPen pen)

Description: Constructor QPainterPathStroker::QPainterPathStroker(const QPen &pen)

This method creates an object of class QPainterPathStroker.

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

setCapStyle

Signature: void setCapStyle (const Qt_PenCapStyle style)

Description: Method void QPainterPathStroker::setCapStyle(Qt::PenCapStyle style)

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

setCurveThreshold

Signature: void setCurveThreshold (double threshold)

Description: Method void QPainterPathStroker::setCurveThreshold(double threshold)

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

setDashOffset

Signature: void setDashOffset (double offset)

Description: Method void QPainterPathStroker::setDashOffset(double offset)

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

setDashPattern

(1) Signature: void setDashPattern (const Qt_PenStyle arg1)

Description: Method void QPainterPathStroker::setDashPattern(Qt::PenStyle)

(2) Signature: void setDashPattern (double[] dashPattern)

Description: Method void QPainterPathStroker::setDashPattern(const QVector<qreal> &dashPattern)

setJoinStyle

Signature: void setJoinStyle (const Qt_PenJoinStyle style)

Description: Method void QPainterPathStroker::setJoinStyle(Qt::PenJoinStyle style)

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

setMiterLimit

Signature: void setMiterLimit (double length)

Description: Method void QPainterPathStroker::setMiterLimit(double length)

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

setWidth

Signature: void setWidth (double width)

Description: Method void QPainterPathStroker::setWidth(double width)

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

width

Signature: [const] double width

Description: Method double QPainterPathStroker::width()

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

width=

Signature: void width= (double width)

Description: Method void QPainterPathStroker::setWidth(double width)

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