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

API reference - Class QRadialGradient

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QRadialGradient

Class hierarchy: QRadialGradient » QGradient

Public constructors

new QRadialGradientnewConstructor QRadialGradient::QRadialGradient()
new QRadialGradientnew(const QPointF center,
double radius,
const QPointF focalPoint)
Constructor QRadialGradient::QRadialGradient(const QPointF &center, double radius, const QPointF &focalPoint)
new QRadialGradientnew(double cx,
double cy,
double radius,
double fx,
double fy)
Constructor QRadialGradient::QRadialGradient(double cx, double cy, double radius, double fx, double fy)
new QRadialGradientnew(const QPointF center,
double radius)
Constructor QRadialGradient::QRadialGradient(const QPointF &center, double radius)
new QRadialGradientnew(double cx,
double cy,
double radius)
Constructor QRadialGradient::QRadialGradient(double cx, double cy, double radius)
new QRadialGradientnew(const QPointF center,
double centerRadius,
const QPointF focalPoint,
double focalRadius)
Constructor QRadialGradient::QRadialGradient(const QPointF &center, double centerRadius, const QPointF &focalPoint, double focalRadius)
new QRadialGradientnew(double cx,
double cy,
double centerRadius,
double fx,
double fy,
double focalRadius)
Constructor QRadialGradient::QRadialGradient(double cx, double cy, double centerRadius, double fx, double fy, double focalRadius)

Public methods

void_assign(const QRadialGradient other)Assigns another object to self
[const]QRadialGradient 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 QRadialGradient 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.
[const]QPointFcenterMethod QPointF QRadialGradient::center()
voidcenter=(const QPointF center)Method void QRadialGradient::setCenter(const QPointF &center)
[const]doublecenterRadiusMethod double QRadialGradient::centerRadius()
voidcenterRadius=(double radius)Method void QRadialGradient::setCenterRadius(double radius)
[const]QPointFfocalPointMethod QPointF QRadialGradient::focalPoint()
voidfocalPoint=(const QPointF focalPoint)Method void QRadialGradient::setFocalPoint(const QPointF &focalPoint)
[const]doublefocalRadiusMethod double QRadialGradient::focalRadius()
voidfocalRadius=(double radius)Method void QRadialGradient::setFocalRadius(double radius)
[const]doubleradiusMethod double QRadialGradient::radius()
voidradius=(double radius)Method void QRadialGradient::setRadius(double radius)
voidsetCenter(const QPointF center)Method void QRadialGradient::setCenter(const QPointF &center)
voidsetCenter(double x,
double y)
Method void QRadialGradient::setCenter(double x, double y)
voidsetCenterRadius(double radius)Method void QRadialGradient::setCenterRadius(double radius)
voidsetFocalPoint(const QPointF focalPoint)Method void QRadialGradient::setFocalPoint(const QPointF &focalPoint)
voidsetFocalPoint(double x,
double y)
Method void QRadialGradient::setFocalPoint(double x, double y)
voidsetFocalRadius(double radius)Method void QRadialGradient::setFocalRadius(double radius)
voidsetRadius(double radius)Method void QRadialGradient::setRadius(double radius)

Detailed description

_assign

Signature: void _assign (const QRadialGradient other)

Description: Assigns another object to self

_const_cast

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

center

Signature: [const] QPointF center

Description: Method QPointF QRadialGradient::center()

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

center=

Signature: void center= (const QPointF center)

Description: Method void QRadialGradient::setCenter(const QPointF &center)

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

centerRadius

Signature: [const] double centerRadius

Description: Method double QRadialGradient::centerRadius()

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

centerRadius=

Signature: void centerRadius= (double radius)

Description: Method void QRadialGradient::setCenterRadius(double radius)

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

focalPoint

Signature: [const] QPointF focalPoint

Description: Method QPointF QRadialGradient::focalPoint()

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

focalPoint=

Signature: void focalPoint= (const QPointF focalPoint)

Description: Method void QRadialGradient::setFocalPoint(const QPointF &focalPoint)

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

focalRadius

Signature: [const] double focalRadius

Description: Method double QRadialGradient::focalRadius()

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

focalRadius=

Signature: void focalRadius= (double radius)

Description: Method void QRadialGradient::setFocalRadius(double radius)

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

new

(1) Signature: [static] new QRadialGradient new

Description: Constructor QRadialGradient::QRadialGradient()

This method creates an object of class QRadialGradient.

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

(2) Signature: [static] new QRadialGradient new (const QPointF center, double radius, const QPointF focalPoint)

Description: Constructor QRadialGradient::QRadialGradient(const QPointF &center, double radius, const QPointF &focalPoint)

This method creates an object of class QRadialGradient.

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

(3) Signature: [static] new QRadialGradient new (double cx, double cy, double radius, double fx, double fy)

Description: Constructor QRadialGradient::QRadialGradient(double cx, double cy, double radius, double fx, double fy)

This method creates an object of class QRadialGradient.

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

(4) Signature: [static] new QRadialGradient new (const QPointF center, double radius)

Description: Constructor QRadialGradient::QRadialGradient(const QPointF &center, double radius)

This method creates an object of class QRadialGradient.

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

(5) Signature: [static] new QRadialGradient new (double cx, double cy, double radius)

Description: Constructor QRadialGradient::QRadialGradient(double cx, double cy, double radius)

This method creates an object of class QRadialGradient.

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

(6) Signature: [static] new QRadialGradient new (const QPointF center, double centerRadius, const QPointF focalPoint, double focalRadius)

Description: Constructor QRadialGradient::QRadialGradient(const QPointF &center, double centerRadius, const QPointF &focalPoint, double focalRadius)

This method creates an object of class QRadialGradient.

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

(7) Signature: [static] new QRadialGradient new (double cx, double cy, double centerRadius, double fx, double fy, double focalRadius)

Description: Constructor QRadialGradient::QRadialGradient(double cx, double cy, double centerRadius, double fx, double fy, double focalRadius)

This method creates an object of class QRadialGradient.

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

radius

Signature: [const] double radius

Description: Method double QRadialGradient::radius()

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

radius=

Signature: void radius= (double radius)

Description: Method void QRadialGradient::setRadius(double radius)

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

setCenter

(1) Signature: void setCenter (const QPointF center)

Description: Method void QRadialGradient::setCenter(const QPointF &center)

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

(2) Signature: void setCenter (double x, double y)

Description: Method void QRadialGradient::setCenter(double x, double y)

setCenterRadius

Signature: void setCenterRadius (double radius)

Description: Method void QRadialGradient::setCenterRadius(double radius)

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

setFocalPoint

(1) Signature: void setFocalPoint (const QPointF focalPoint)

Description: Method void QRadialGradient::setFocalPoint(const QPointF &focalPoint)

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

(2) Signature: void setFocalPoint (double x, double y)

Description: Method void QRadialGradient::setFocalPoint(double x, double y)

setFocalRadius

Signature: void setFocalRadius (double radius)

Description: Method void QRadialGradient::setFocalRadius(double radius)

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

setRadius

Signature: void setRadius (double radius)

Description: Method void QRadialGradient::setRadius(double radius)

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