API reference - Class QLinearGradient

Notation used in Ruby API documentation

Description: Binding of QLinearGradient

Class hierarchy: QLinearGradient » QGradient

Public constructors

new QLinearGradientnewConstructor QLinearGradient::QLinearGradient()
new QLinearGradientnew(const QPointF start,
const QPointF finalStop)
Constructor QLinearGradient::QLinearGradient(const QPointF &start, const QPointF &finalStop)
new QLinearGradientnew(double xStart,
double yStart,
double xFinalStop,
double yFinalStop)
Constructor QLinearGradient::QLinearGradient(double xStart, double yStart, double xFinalStop, double yFinalStop)

Public methods

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 QLinearGradient other)Assigns another object to self
[const]new QLinearGradient ptrdupCreates a copy of self
[const]QPointFfinalStopMethod QPointF QLinearGradient::finalStop()
voidfinalStop=(const QPointF stop)Method void QLinearGradient::setFinalStop(const QPointF &stop)
voidsetFinalStop(const QPointF stop)Method void QLinearGradient::setFinalStop(const QPointF &stop)
voidsetFinalStop(double x,
double y)
Method void QLinearGradient::setFinalStop(double x, double y)
voidsetStart(const QPointF start)Method void QLinearGradient::setStart(const QPointF &start)
voidsetStart(double x,
double y)
Method void QLinearGradient::setStart(double x, double y)
[const]QPointFstartMethod QPointF QLinearGradient::start()
voidstart=(const QPointF start)Method void QLinearGradient::setStart(const QPointF &start)

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

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.

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.

[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.

[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.

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.

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.

void assign(const QLinearGradient other)

Description: Assigns another object to self

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new QLinearGradient ptr dup

Description: Creates a copy of self

[const] QPointF finalStop

Description: Method QPointF QLinearGradient::finalStop()

Python specific notes:

The object exposes a readable attribute 'finalStop'. This is the getter.

void finalStop=(const QPointF stop)

Description: Method void QLinearGradient::setFinalStop(const QPointF &stop)

Python specific notes:

The object exposes a writable attribute 'finalStop'. This is the setter.

[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

[static] new QLinearGradient new

Description: Constructor QLinearGradient::QLinearGradient()

This method creates an object of class QLinearGradient.

Python specific notes:

This method is the default initializer of the object

[static] new QLinearGradient new(const QPointF start,const QPointF finalStop)

Description: Constructor QLinearGradient::QLinearGradient(const QPointF &start, const QPointF &finalStop)

This method creates an object of class QLinearGradient.

Python specific notes:

This method is the default initializer of the object

[static] new QLinearGradient new(double xStart,double yStart,double xFinalStop,double yFinalStop)

Description: Constructor QLinearGradient::QLinearGradient(double xStart, double yStart, double xFinalStop, double yFinalStop)

This method creates an object of class QLinearGradient.

Python specific notes:

This method is the default initializer of the object

void setFinalStop(const QPointF stop)

Description: Method void QLinearGradient::setFinalStop(const QPointF &stop)

Python specific notes:

The object exposes a writable attribute 'finalStop'. This is the setter.

void setFinalStop(double x,double y)

Description: Method void QLinearGradient::setFinalStop(double x, double y)

void setStart(const QPointF start)

Description: Method void QLinearGradient::setStart(const QPointF &start)

Python specific notes:

The object exposes a writable attribute 'start'. This is the setter.

void setStart(double x,double y)

Description: Method void QLinearGradient::setStart(double x, double y)

[const] QPointF start

Description: Method QPointF QLinearGradient::start()

Python specific notes:

The object exposes a readable attribute 'start'. This is the getter.

void start=(const QPointF start)

Description: Method void QLinearGradient::setStart(const QPointF &start)

Python specific notes:

The object exposes a writable attribute 'start'. This is the setter.