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

API reference - Class QGraphicsColorizeEffect

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsColorizeEffect

Class hierarchy: QGraphicsColorizeEffect » QGraphicsEffect » QObject

Public constructors

new QGraphicsColorizeEffectnew(QObject ptr parent = nullptr)Constructor QGraphicsColorizeEffect::QGraphicsColorizeEffect(QObject *parent)

Public methods

[const]QGraphicsColorizeEffect 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]QRectFboundingRectFor(const QRectF sourceRect)Virtual method QRectF QGraphicsColorizeEffect::boundingRectFor(const QRectF &sourceRect)
[const]QColorcolorMethod QColor QGraphicsColorizeEffect::color()
voidcolor=(const QColor c)Method void QGraphicsColorizeEffect::setColor(const QColor &c)
[signal]voidcolorChanged(const QColor color)Signal declaration for QGraphicsColorizeEffect::colorChanged(const QColor &color)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QGraphicsColorizeEffect::destroyed(QObject *)
voidemit_colorChanged(const QColor color)Emitter for signal void QGraphicsColorizeEffect::colorChanged(const QColor &color)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QGraphicsColorizeEffect::destroyed(QObject *)
voidemit_enabledChanged(bool enabled)Emitter for signal void QGraphicsColorizeEffect::enabledChanged(bool enabled)
voidemit_objectNameChanged(string objectName)Emitter for signal void QGraphicsColorizeEffect::objectNameChanged(const QString &objectName)
voidemit_strengthChanged(double strength)Emitter for signal void QGraphicsColorizeEffect::strengthChanged(double strength)
[signal]voidenabledChanged(bool enabled)Signal declaration for QGraphicsColorizeEffect::enabledChanged(bool enabled)
boolevent(QEvent ptr event)Virtual method bool QGraphicsColorizeEffect::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QGraphicsColorizeEffect::eventFilter(QObject *watched, QEvent *event)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QGraphicsColorizeEffect::objectNameChanged(const QString &objectName)
voidsetColor(const QColor c)Method void QGraphicsColorizeEffect::setColor(const QColor &c)
voidsetStrength(double strength)Method void QGraphicsColorizeEffect::setStrength(double strength)
[const]doublestrengthMethod double QGraphicsColorizeEffect::strength()
voidstrength=(double strength)Method void QGraphicsColorizeEffect::setStrength(double strength)
[signal]voidstrengthChanged(double strength)Signal declaration for QGraphicsColorizeEffect::strengthChanged(double strength)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QGraphicsColorizeEffect::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QGraphicsColorizeEffect::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QGraphicsColorizeEffect::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QGraphicsColorizeEffect::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QGraphicsColorizeEffect::disconnectNotify(const QMetaMethod &signal)
voiddraw(QPainter ptr painter)Virtual method void QGraphicsColorizeEffect::draw(QPainter *painter)
voiddrawSource(QPainter ptr painter)Method void QGraphicsColorizeEffect::drawSource(QPainter *painter)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QGraphicsColorizeEffect::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QGraphicsColorizeEffect::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QGraphicsColorizeEffect::sender()
[const]intsenderSignalIndexMethod int QGraphicsColorizeEffect::senderSignalIndex()
[const]QRectFsourceBoundingRect(const Qt_CoordinateSystem system = Qt::LogicalCoordinates)Method QRectF QGraphicsColorizeEffect::sourceBoundingRect(Qt::CoordinateSystem system)
voidsourceChanged(QGraphicsEffect_QFlags_ChangeFlag flags)Virtual method void QGraphicsColorizeEffect::sourceChanged(QFlags<QGraphicsEffect::ChangeFlag> flags)
[const]boolsourceIsPixmapMethod bool QGraphicsColorizeEffect::sourceIsPixmap()
[const]QPixmapsourcePixmap(const Qt_CoordinateSystem system = Qt::LogicalCoordinates,
QPoint ptr offset = nullptr,
const QGraphicsEffect_PixmapPadMode mode = QGraphicsEffect::PadToEffectiveBoundingRect)
Method QPixmap QGraphicsColorizeEffect::sourcePixmap(Qt::CoordinateSystem system, QPoint *offset, QGraphicsEffect::PixmapPadMode mode)
voidtimerEvent(QTimerEvent ptr event)Virtual method void QGraphicsColorizeEffect::timerEvent(QTimerEvent *event)
voidupdateBoundingRectMethod void QGraphicsColorizeEffect::updateBoundingRect()

Detailed description

_const_cast

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

boundingRectFor

Signature: [const] QRectF boundingRectFor (const QRectF sourceRect)

Description: Virtual method QRectF QGraphicsColorizeEffect::boundingRectFor(const QRectF &sourceRect)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QGraphicsColorizeEffect::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

color

Signature: [const] QColor color

Description: Method QColor QGraphicsColorizeEffect::color()

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

color=

Signature: void color= (const QColor c)

Description: Method void QGraphicsColorizeEffect::setColor(const QColor &c)

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

colorChanged

Signature: [signal] void colorChanged (const QColor color)

Description: Signal declaration for QGraphicsColorizeEffect::colorChanged(const QColor &color)

You can bind a procedure to this signal.

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

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QGraphicsColorizeEffect::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QGraphicsColorizeEffect::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QGraphicsColorizeEffect::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

draw

Signature: void draw (QPainter ptr painter)

Description: Virtual method void QGraphicsColorizeEffect::draw(QPainter *painter)

This method can be reimplemented in a derived class.

drawSource

Signature: void drawSource (QPainter ptr painter)

Description: Method void QGraphicsColorizeEffect::drawSource(QPainter *painter)

This method is protected and can only be called from inside a derived class.

emit_colorChanged

Signature: void emit_colorChanged (const QColor color)

Description: Emitter for signal void QGraphicsColorizeEffect::colorChanged(const QColor &color)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QGraphicsColorizeEffect::destroyed(QObject *)

Call this method to emit this signal.

emit_enabledChanged

Signature: void emit_enabledChanged (bool enabled)

Description: Emitter for signal void QGraphicsColorizeEffect::enabledChanged(bool enabled)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QGraphicsColorizeEffect::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_strengthChanged

Signature: void emit_strengthChanged (double strength)

Description: Emitter for signal void QGraphicsColorizeEffect::strengthChanged(double strength)

Call this method to emit this signal.

enabledChanged

Signature: [signal] void enabledChanged (bool enabled)

Description: Signal declaration for QGraphicsColorizeEffect::enabledChanged(bool enabled)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QGraphicsColorizeEffect::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QGraphicsColorizeEffect::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QGraphicsColorizeEffect::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

new

Signature: [static] new QGraphicsColorizeEffect new (QObject ptr parent = nullptr)

Description: Constructor QGraphicsColorizeEffect::QGraphicsColorizeEffect(QObject *parent)

This method creates an object of class QGraphicsColorizeEffect.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QGraphicsColorizeEffect::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QGraphicsColorizeEffect::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QGraphicsColorizeEffect::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QGraphicsColorizeEffect::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setColor

Signature: void setColor (const QColor c)

Description: Method void QGraphicsColorizeEffect::setColor(const QColor &c)

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

setStrength

Signature: void setStrength (double strength)

Description: Method void QGraphicsColorizeEffect::setStrength(double strength)

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

sourceBoundingRect

Signature: [const] QRectF sourceBoundingRect (const Qt_CoordinateSystem system = Qt::LogicalCoordinates)

Description: Method QRectF QGraphicsColorizeEffect::sourceBoundingRect(Qt::CoordinateSystem system)

This method is protected and can only be called from inside a derived class.

sourceChanged

Signature: void sourceChanged (QGraphicsEffect_QFlags_ChangeFlag flags)

Description: Virtual method void QGraphicsColorizeEffect::sourceChanged(QFlags<QGraphicsEffect::ChangeFlag> flags)

This method can be reimplemented in a derived class.

sourceIsPixmap

Signature: [const] bool sourceIsPixmap

Description: Method bool QGraphicsColorizeEffect::sourceIsPixmap()

This method is protected and can only be called from inside a derived class.

sourcePixmap

Signature: [const] QPixmap sourcePixmap (const Qt_CoordinateSystem system = Qt::LogicalCoordinates, QPoint ptr offset = nullptr, const QGraphicsEffect_PixmapPadMode mode = QGraphicsEffect::PadToEffectiveBoundingRect)

Description: Method QPixmap QGraphicsColorizeEffect::sourcePixmap(Qt::CoordinateSystem system, QPoint *offset, QGraphicsEffect::PixmapPadMode mode)

This method is protected and can only be called from inside a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

strength

Signature: [const] double strength

Description: Method double QGraphicsColorizeEffect::strength()

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

strength=

Signature: void strength= (double strength)

Description: Method void QGraphicsColorizeEffect::setStrength(double strength)

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

strengthChanged

Signature: [signal] void strengthChanged (double strength)

Description: Signal declaration for QGraphicsColorizeEffect::strengthChanged(double strength)

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QGraphicsColorizeEffect::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QGraphicsColorizeEffect::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QGraphicsColorizeEffect::trUtf8(const char *s, const char *c, int n)

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

updateBoundingRect

Signature: void updateBoundingRect

Description: Method void QGraphicsColorizeEffect::updateBoundingRect()

This method is protected and can only be called from inside a derived class.