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

API reference - Class QGradient

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QGradient

Sub-classes: CoordinateMode, QFlags_CoordinateMode, InterpolationMode, QFlags_InterpolationMode, Spread, QFlags_Spread, Type, QFlags_Type

Public constructors

new QGradientnewConstructor QGradient::QGradient()

Public methods

[const]bool!=(const QGradient other)Method bool QGradient::operator!=(const QGradient &other)
[const]bool==(const QGradient gradient)Method bool QGradient::operator==(const QGradient &gradient)
bool==(const QGradient gradient)Method bool QGradient::operator==(const QGradient &gradient)
[const]QGradient 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 QGradient other)Assigns another object to self
[const]QGradient_CoordinateModecoordinateModeMethod QGradient::CoordinateMode QGradient::coordinateMode()
voidcoordinateMode=(const QGradient_CoordinateMode mode)Method void QGradient::setCoordinateMode(QGradient::CoordinateMode mode)
[const]new QGradient ptrdupCreates a copy of self
[const]QGradient_InterpolationModeinterpolationModeMethod QGradient::InterpolationMode QGradient::interpolationMode()
voidinterpolationMode=(const QGradient_InterpolationMode mode)Method void QGradient::setInterpolationMode(QGradient::InterpolationMode mode)
voidsetColorAt(double pos,
const QColor color)
Method void QGradient::setColorAt(double pos, const QColor &color)
voidsetCoordinateMode(const QGradient_CoordinateMode mode)Method void QGradient::setCoordinateMode(QGradient::CoordinateMode mode)
voidsetInterpolationMode(const QGradient_InterpolationMode mode)Method void QGradient::setInterpolationMode(QGradient::InterpolationMode mode)
voidsetSpread(const QGradient_Spread spread)Method void QGradient::setSpread(QGradient::Spread spread)
voidsetStops(QPair_double_QColor[] stops)Method void QGradient::setStops(const QVector<QGradientStop> &stops)
[const]QGradient_SpreadspreadMethod QGradient::Spread QGradient::spread()
voidspread=(const QGradient_Spread spread)Method void QGradient::setSpread(QGradient::Spread spread)
[const]QPair_double_QColor[]stopsMethod QVector<QGradientStop> QGradient::stops()
voidstops=(QPair_double_QColor[] stops)Method void QGradient::setStops(const QVector<QGradientStop> &stops)
[const]QGradient_TypetypeMethod QGradient::Type QGradient::type()

Public static methods and constants

[static,const]QGradient_InterpolationModeColorInterpolationEnum constant QGradient::ColorInterpolation
[static,const]QGradient_InterpolationModeComponentInterpolationEnum constant QGradient::ComponentInterpolation
[static,const]QGradient_TypeConicalGradientEnum constant QGradient::ConicalGradient
[static,const]QGradient_TypeLinearGradientEnum constant QGradient::LinearGradient
[static,const]QGradient_CoordinateModeLogicalModeEnum constant QGradient::LogicalMode
[static,const]QGradient_TypeNoGradientEnum constant QGradient::NoGradient
[static,const]QGradient_CoordinateModeObjectBoundingModeEnum constant QGradient::ObjectBoundingMode
[static,const]QGradient_SpreadPadSpreadEnum constant QGradient::PadSpread
[static,const]QGradient_TypeRadialGradientEnum constant QGradient::RadialGradient
[static,const]QGradient_SpreadReflectSpreadEnum constant QGradient::ReflectSpread
[static,const]QGradient_SpreadRepeatSpreadEnum constant QGradient::RepeatSpread
[static,const]QGradient_CoordinateModeStretchToDeviceModeEnum constant QGradient::StretchToDeviceMode

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 QGradient other)

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

==

(1) Signature: [const] bool == (const QGradient gradient)

Description: Method bool QGradient::operator==(const QGradient &gradient)

(2) Signature: bool == (const QGradient gradient)

Description: Method bool QGradient::operator==(const QGradient &gradient)

ColorInterpolation

Signature: [static,const] QGradient_InterpolationMode ColorInterpolation

Description: Enum constant QGradient::ColorInterpolation

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

ComponentInterpolation

Signature: [static,const] QGradient_InterpolationMode ComponentInterpolation

Description: Enum constant QGradient::ComponentInterpolation

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

ConicalGradient

Signature: [static,const] QGradient_Type ConicalGradient

Description: Enum constant QGradient::ConicalGradient

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

LinearGradient

Signature: [static,const] QGradient_Type LinearGradient

Description: Enum constant QGradient::LinearGradient

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

LogicalMode

Signature: [static,const] QGradient_CoordinateMode LogicalMode

Description: Enum constant QGradient::LogicalMode

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

NoGradient

Signature: [static,const] QGradient_Type NoGradient

Description: Enum constant QGradient::NoGradient

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

ObjectBoundingMode

Signature: [static,const] QGradient_CoordinateMode ObjectBoundingMode

Description: Enum constant QGradient::ObjectBoundingMode

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

PadSpread

Signature: [static,const] QGradient_Spread PadSpread

Description: Enum constant QGradient::PadSpread

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

RadialGradient

Signature: [static,const] QGradient_Type RadialGradient

Description: Enum constant QGradient::RadialGradient

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

ReflectSpread

Signature: [static,const] QGradient_Spread ReflectSpread

Description: Enum constant QGradient::ReflectSpread

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

RepeatSpread

Signature: [static,const] QGradient_Spread RepeatSpread

Description: Enum constant QGradient::RepeatSpread

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

StretchToDeviceMode

Signature: [static,const] QGradient_CoordinateMode StretchToDeviceMode

Description: Enum constant QGradient::StretchToDeviceMode

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

_const_cast

Signature: [const] QGradient 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 QGradient other)

Description: Assigns another object to self

coordinateMode

Signature: [const] QGradient_CoordinateMode coordinateMode

Description: Method QGradient::CoordinateMode QGradient::coordinateMode()

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

coordinateMode=

Signature: void coordinateMode= (const QGradient_CoordinateMode mode)

Description: Method void QGradient::setCoordinateMode(QGradient::CoordinateMode mode)

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

dup

Signature: [const] new QGradient ptr dup

Description: Creates a copy of self

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

interpolationMode

Signature: [const] QGradient_InterpolationMode interpolationMode

Description: Method QGradient::InterpolationMode QGradient::interpolationMode()

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

interpolationMode=

Signature: void interpolationMode= (const QGradient_InterpolationMode mode)

Description: Method void QGradient::setInterpolationMode(QGradient::InterpolationMode mode)

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

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 QGradient new

Description: Constructor QGradient::QGradient()

This method creates an object of class QGradient.

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

setColorAt

Signature: void setColorAt (double pos, const QColor color)

Description: Method void QGradient::setColorAt(double pos, const QColor &color)

setCoordinateMode

Signature: void setCoordinateMode (const QGradient_CoordinateMode mode)

Description: Method void QGradient::setCoordinateMode(QGradient::CoordinateMode mode)

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

setInterpolationMode

Signature: void setInterpolationMode (const QGradient_InterpolationMode mode)

Description: Method void QGradient::setInterpolationMode(QGradient::InterpolationMode mode)

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

setSpread

Signature: void setSpread (const QGradient_Spread spread)

Description: Method void QGradient::setSpread(QGradient::Spread spread)

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

setStops

Signature: void setStops (QPair_double_QColor[] stops)

Description: Method void QGradient::setStops(const QVector<QGradientStop> &stops)

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

spread

Signature: [const] QGradient_Spread spread

Description: Method QGradient::Spread QGradient::spread()

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

spread=

Signature: void spread= (const QGradient_Spread spread)

Description: Method void QGradient::setSpread(QGradient::Spread spread)

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

stops

Signature: [const] QPair_double_QColor[] stops

Description: Method QVector<QGradientStop> QGradient::stops()

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

stops=

Signature: void stops= (QPair_double_QColor[] stops)

Description: Method void QGradient::setStops(const QVector<QGradientStop> &stops)

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

type

Signature: [const] QGradient_Type type

Description: Method QGradient::Type QGradient::type()