API reference - Class QGraphicsEffect

Notation used in Ruby API documentation

Description: Binding of QGraphicsEffect

Class hierarchy: QGraphicsEffect » QObject

Sub-classes: ChangeFlag, PixmapPadMode

Public constructors

new QGraphicsEffectnew(QObject ptr parent = 0)Constructor QGraphicsEffect::QGraphicsEffect(QObject *parent)

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.
[const]QRectFboundingRectMethod QRectF QGraphicsEffect::boundingRect()
[virtual,const]QRectFboundingRectFor(const QRectF sourceRect)Virtual method QRectF QGraphicsEffect::boundingRectFor(const QRectF &sourceRect)
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QGraphicsEffect::destroyed(QObject *)
[const]boolenabledMethod bool QGraphicsEffect::isEnabled()
voidenabled=(bool enable)Method void QGraphicsEffect::setEnabled(bool enable)
[event]voidenabledChanged(bool enabled)Signal declaration for QGraphicsEffect::enabledChanged(bool enabled)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QGraphicsEffect::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QGraphicsEffect::eventFilter(QObject *, QEvent *)
[const]boolisEnabled?Method bool QGraphicsEffect::isEnabled()
voidsetEnabled(bool enable)Method void QGraphicsEffect::setEnabled(bool enable)
voidupdateMethod void QGraphicsEffect::update()

Public static methods and constants

[static,const]new QGraphicsEffect_PixmapPadMode ptrNoPadEnum constant QGraphicsEffect::NoPad
[static,const]new QGraphicsEffect_PixmapPadMode ptrPadToEffectiveBoundingRectEnum constant QGraphicsEffect::PadToEffectiveBoundingRect
[static,const]new QGraphicsEffect_PixmapPadMode ptrPadToTransparentBorderEnum constant QGraphicsEffect::PadToTransparentBorder
[static,const]new QGraphicsEffect_ChangeFlag ptrSourceAttachedEnum constant QGraphicsEffect::SourceAttached
[static,const]new QGraphicsEffect_ChangeFlag ptrSourceBoundingRectChangedEnum constant QGraphicsEffect::SourceBoundingRectChanged
[static,const]new QGraphicsEffect_ChangeFlag ptrSourceDetachedEnum constant QGraphicsEffect::SourceDetached
[static,const]new QGraphicsEffect_ChangeFlag ptrSourceInvalidatedEnum constant QGraphicsEffect::SourceInvalidated
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QGraphicsEffect::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QGraphicsEffect::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QGraphicsEffect::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QGraphicsEffect::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

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

[static,const] new QGraphicsEffect_PixmapPadMode ptr NoPad

Description: Enum constant QGraphicsEffect::NoPad

[static,const] new QGraphicsEffect_PixmapPadMode ptr PadToEffectiveBoundingRect

Description: Enum constant QGraphicsEffect::PadToEffectiveBoundingRect

[static,const] new QGraphicsEffect_PixmapPadMode ptr PadToTransparentBorder

Description: Enum constant QGraphicsEffect::PadToTransparentBorder

[static,const] new QGraphicsEffect_ChangeFlag ptr SourceAttached

Description: Enum constant QGraphicsEffect::SourceAttached

[static,const] new QGraphicsEffect_ChangeFlag ptr SourceBoundingRectChanged

Description: Enum constant QGraphicsEffect::SourceBoundingRectChanged

[static,const] new QGraphicsEffect_ChangeFlag ptr SourceDetached

Description: Enum constant QGraphicsEffect::SourceDetached

[static,const] new QGraphicsEffect_ChangeFlag ptr SourceInvalidated

Description: Enum constant QGraphicsEffect::SourceInvalidated

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.

[const] QRectF boundingRect

Description: Method QRectF QGraphicsEffect::boundingRect()

[virtual,const] QRectF boundingRectFor(const QRectF sourceRect)

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

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QGraphicsEffect::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QGraphicsEffect::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QGraphicsEffect::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] void draw(QPainter ptr painter)

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

This method can be reimplemented in a derived class.

void drawSource(QPainter ptr painter)

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

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

[const] bool enabled

Description: Method bool QGraphicsEffect::isEnabled()

Python specific notes:

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

void enabled=(bool enable)

Description: Method void QGraphicsEffect::setEnabled(bool enable)

Python specific notes:

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

[event] void enabledChanged(bool enabled)

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

You can bind a procedure to this signal.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QGraphicsEffect::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[const] bool isEnabled?

Description: Method bool QGraphicsEffect::isEnabled()

Python specific notes:

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

[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 QGraphicsEffect new(QObject ptr parent = 0)

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

This method creates an object of class QGraphicsEffect.

Python specific notes:

This method is the default initializer of the object

[const] int receivers(string signal)

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

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

[const] QObject ptr sender

Description: Method QObject *QGraphicsEffect::sender()

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

void setEnabled(bool enable)

Description: Method void QGraphicsEffect::setEnabled(bool enable)

Python specific notes:

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

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

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

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

[virtual] void sourceChanged(const QGraphicsEffect_QFlags_ChangeFlag flags)

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

This method can be reimplemented in a derived class.

[const] bool sourceIsPixmap

Description: Method bool QGraphicsEffect::sourceIsPixmap()

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

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

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

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QGraphicsEffect::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QGraphicsEffect::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

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

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

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QGraphicsEffect::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

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

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

void update

Description: Method void QGraphicsEffect::update()

void updateBoundingRect

Description: Method void QGraphicsEffect::updateBoundingRect()

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