API reference - Class QAbstractGraphicsShapeItem

_const_cast

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

addToIndex

Signature: void addToIndex

Description: Method void QAbstractGraphicsShapeItem::addToIndex()

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

advance

Signature: void advance (int phase)

Description: Virtual method void QAbstractGraphicsShapeItem::advance(int phase)

This method can be reimplemented in a derived class.

boundingRect

Signature: [const] QRectF boundingRect

Description: Virtual method QRectF QAbstractGraphicsShapeItem::boundingRect()

This method can be reimplemented in a derived class.

brush

Signature: [const] QBrush brush

Description: Method QBrush QAbstractGraphicsShapeItem::brush()

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

brush=

Signature: void brush= (const QBrush brush)

Description: Method void QAbstractGraphicsShapeItem::setBrush(const QBrush &brush)

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

collidesWithItem

Signature: [const] bool collidesWithItem (const QGraphicsItem ptr other, const Qt_ItemSelectionMode mode)

Description: Virtual method bool QAbstractGraphicsShapeItem::collidesWithItem(const QGraphicsItem *other, Qt::ItemSelectionMode mode)

This method can be reimplemented in a derived class.

collidesWithPath

Signature: [const] bool collidesWithPath (const QPainterPath path, const Qt_ItemSelectionMode mode)

Description: Virtual method bool QAbstractGraphicsShapeItem::collidesWithPath(const QPainterPath &path, Qt::ItemSelectionMode mode)

This method can be reimplemented in a derived class.

contains

Signature: [const] bool contains (const QPointF point)

Description: Virtual method bool QAbstractGraphicsShapeItem::contains(const QPointF &point)

This method can be reimplemented in a derived class.

contextMenuEvent

Signature: void contextMenuEvent (QGraphicsSceneContextMenuEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::contextMenuEvent(QGraphicsSceneContextMenuEvent *event)

This method can be reimplemented in a derived class.

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.

dragEnterEvent

Signature: void dragEnterEvent (QGraphicsSceneDragDropEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::dragEnterEvent(QGraphicsSceneDragDropEvent *event)

This method can be reimplemented in a derived class.

dragLeaveEvent

Signature: void dragLeaveEvent (QGraphicsSceneDragDropEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)

This method can be reimplemented in a derived class.

dragMoveEvent

Signature: void dragMoveEvent (QGraphicsSceneDragDropEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::dragMoveEvent(QGraphicsSceneDragDropEvent *event)

This method can be reimplemented in a derived class.

dropEvent

Signature: void dropEvent (QGraphicsSceneDragDropEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::dropEvent(QGraphicsSceneDragDropEvent *event)

This method can be reimplemented in a derived class.

extension

Signature: [const] variant extension (variant variant)

Description: Virtual method QVariant QAbstractGraphicsShapeItem::extension(const QVariant &variant)

This method can be reimplemented in a derived class.

focusInEvent

Signature: void focusInEvent (QFocusEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::focusInEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

focusOutEvent

Signature: void focusOutEvent (QFocusEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::focusOutEvent(QFocusEvent *event)

This method can be reimplemented in a derived class.

hoverEnterEvent

Signature: void hoverEnterEvent (QGraphicsSceneHoverEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event)

This method can be reimplemented in a derived class.

hoverLeaveEvent

Signature: void hoverLeaveEvent (QGraphicsSceneHoverEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event)

This method can be reimplemented in a derived class.

hoverMoveEvent

Signature: void hoverMoveEvent (QGraphicsSceneHoverEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event)

This method can be reimplemented in a derived class.

inputMethodEvent

Signature: void inputMethodEvent (QInputMethodEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::inputMethodEvent(QInputMethodEvent *event)

This method can be reimplemented in a derived class.

inputMethodQuery

Signature: [const] variant inputMethodQuery (const Qt_InputMethodQuery query)

Description: Virtual method QVariant QAbstractGraphicsShapeItem::inputMethodQuery(Qt::InputMethodQuery query)

This method can be reimplemented in a derived class.

isObscuredBy

Signature: [const] bool isObscuredBy (const QGraphicsItem ptr item)

Description: Virtual method bool QAbstractGraphicsShapeItem::isObscuredBy(const QGraphicsItem *item)

This method can be reimplemented in a derived class.

isObscuredBy?

Signature: [const] bool isObscuredBy? (const QGraphicsItem ptr item)

Description: Method bool QAbstractGraphicsShapeItem::isObscuredBy(const QGraphicsItem *item)

This is a reimplementation of QGraphicsItem::isObscuredBy

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.

itemChange

Signature: variant itemChange (const QGraphicsItem_GraphicsItemChange change, variant value)

Description: Virtual method QVariant QAbstractGraphicsShapeItem::itemChange(QGraphicsItem::GraphicsItemChange change, const QVariant &value)

This method can be reimplemented in a derived class.

keyPressEvent

Signature: void keyPressEvent (QKeyEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::keyPressEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

keyReleaseEvent

Signature: void keyReleaseEvent (QKeyEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::keyReleaseEvent(QKeyEvent *event)

This method can be reimplemented in a derived class.

mouseDoubleClickEvent

Signature: void mouseDoubleClickEvent (QGraphicsSceneMouseEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)

This method can be reimplemented in a derived class.

mouseMoveEvent

Signature: void mouseMoveEvent (QGraphicsSceneMouseEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event)

This method can be reimplemented in a derived class.

mousePressEvent

Signature: void mousePressEvent (QGraphicsSceneMouseEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::mousePressEvent(QGraphicsSceneMouseEvent *event)

This method can be reimplemented in a derived class.

mouseReleaseEvent

Signature: void mouseReleaseEvent (QGraphicsSceneMouseEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)

This method can be reimplemented in a derived class.

new

Signature: [static] new QAbstractGraphicsShapeItem new (QGraphicsItem ptr parent = nullptr)

Description: Constructor QAbstractGraphicsShapeItem::QAbstractGraphicsShapeItem(QGraphicsItem *parent)

This method creates an object of class QAbstractGraphicsShapeItem.

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

opaqueArea

Signature: [const] QPainterPath opaqueArea

Description: Virtual method QPainterPath QAbstractGraphicsShapeItem::opaqueArea()

This method can be reimplemented in a derived class.

paint

Signature: void paint (QPainter ptr painter, const QStyleOptionGraphicsItem ptr option, QWidget ptr widget)

Description: Virtual method void QAbstractGraphicsShapeItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)

This method can be reimplemented in a derived class.

pen

Signature: [const] QPen pen

Description: Method QPen QAbstractGraphicsShapeItem::pen()

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

pen=

Signature: void pen= (const QPen pen)

Description: Method void QAbstractGraphicsShapeItem::setPen(const QPen &pen)

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

prepareGeometryChange

Signature: void prepareGeometryChange

Description: Method void QAbstractGraphicsShapeItem::prepareGeometryChange()

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

removeFromIndex

Signature: void removeFromIndex

Description: Method void QAbstractGraphicsShapeItem::removeFromIndex()

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

sceneEvent

Signature: bool sceneEvent (QEvent ptr event)

Description: Virtual method bool QAbstractGraphicsShapeItem::sceneEvent(QEvent *event)

This method can be reimplemented in a derived class.

sceneEventFilter

Signature: bool sceneEventFilter (QGraphicsItem ptr watched, QEvent ptr event)

Description: Virtual method bool QAbstractGraphicsShapeItem::sceneEventFilter(QGraphicsItem *watched, QEvent *event)

This method can be reimplemented in a derived class.

setBrush

Signature: void setBrush (const QBrush brush)

Description: Method void QAbstractGraphicsShapeItem::setBrush(const QBrush &brush)

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

setExtension

Signature: void setExtension (unsigned int extension, variant variant)

Description: Virtual method void QAbstractGraphicsShapeItem::setExtension(QGraphicsItem::Extension extension, const QVariant &variant)

This method can be reimplemented in a derived class.

setPen

Signature: void setPen (const QPen pen)

Description: Method void QAbstractGraphicsShapeItem::setPen(const QPen &pen)

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

shape

Signature: [const] QPainterPath shape

Description: Virtual method QPainterPath QAbstractGraphicsShapeItem::shape()

This method can be reimplemented in a derived class.

supportsExtension

Signature: [const] bool supportsExtension (unsigned int extension)

Description: Virtual method bool QAbstractGraphicsShapeItem::supportsExtension(QGraphicsItem::Extension extension)

This method can be reimplemented in a derived class.

type

Signature: [const] int type

Description: Virtual method int QAbstractGraphicsShapeItem::type()

This method can be reimplemented in a derived class.

updateMicroFocus

Signature: void updateMicroFocus

Description: Method void QAbstractGraphicsShapeItem::updateMicroFocus()

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

wheelEvent

Signature: void wheelEvent (QGraphicsSceneWheelEvent ptr event)

Description: Virtual method void QAbstractGraphicsShapeItem::wheelEvent(QGraphicsSceneWheelEvent *event)

This method can be reimplemented in a derived class.