API reference - Class QGraphicsLineItem

Notation used in Ruby API documentation

Description: Binding of QGraphicsLineItem

Class hierarchy: QGraphicsLineItem » QGraphicsItem

Public constructors

new QGraphicsLineItemnew(QGraphicsItem ptr parent = 0,
QGraphicsScene ptr scene = 0)
Constructor QGraphicsLineItem::QGraphicsLineItem(QGraphicsItem *parent, QGraphicsScene *scene)
new QGraphicsLineItemnew(const QLineF line,
QGraphicsItem ptr parent = 0,
QGraphicsScene ptr scene = 0)
Constructor QGraphicsLineItem::QGraphicsLineItem(const QLineF &line, QGraphicsItem *parent, QGraphicsScene *scene)
new QGraphicsLineItemnew(double x1,
double y1,
double x2,
double y2,
QGraphicsItem ptr parent = 0,
QGraphicsScene ptr scene = 0)
Constructor QGraphicsLineItem::QGraphicsLineItem(double x1, double y1, double x2, double y2, QGraphicsItem *parent, QGraphicsScene *scene)

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.
[virtual]voidadvance(int phase)Virtual method void QGraphicsLineItem::advance(int phase)
[virtual,const]QRectFboundingRectVirtual method QRectF QGraphicsLineItem::boundingRect()
[virtual,const]boolcollidesWithItem(const QGraphicsItem ptr other,
const Qt_ItemSelectionMode mode)
Virtual method bool QGraphicsLineItem::collidesWithItem(const QGraphicsItem *other, Qt::ItemSelectionMode mode)
[virtual,const]boolcollidesWithPath(const QPainterPath path,
const Qt_ItemSelectionMode mode)
Virtual method bool QGraphicsLineItem::collidesWithPath(const QPainterPath &path, Qt::ItemSelectionMode mode)
[virtual,const]boolcontains(const QPointF point)Virtual method bool QGraphicsLineItem::contains(const QPointF &point)
[virtual,const]boolisObscuredBy(const QGraphicsItem ptr item)Virtual method bool QGraphicsLineItem::isObscuredBy(const QGraphicsItem *item)
[const]boolisObscuredBy?(const QGraphicsItem ptr item)Method bool QGraphicsLineItem::isObscuredBy(const QGraphicsItem *item)
[const]QLineFlineMethod QLineF QGraphicsLineItem::line()
voidline=(const QLineF line)Method void QGraphicsLineItem::setLine(const QLineF &line)
[virtual,const]QPainterPathopaqueAreaVirtual method QPainterPath QGraphicsLineItem::opaqueArea()
[virtual]voidpaint(QPainter ptr painter,
const QStyleOptionGraphicsItem ptr option,
QWidget ptr widget)
Virtual method void QGraphicsLineItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
[const]QPenpenMethod QPen QGraphicsLineItem::pen()
voidpen=(const QPen pen)Method void QGraphicsLineItem::setPen(const QPen &pen)
voidsetLine(const QLineF line)Method void QGraphicsLineItem::setLine(const QLineF &line)
voidsetLine(double x1,
double y1,
double x2,
double y2)
Method void QGraphicsLineItem::setLine(double x1, double y1, double x2, double y2)
voidsetPen(const QPen pen)Method void QGraphicsLineItem::setPen(const QPen &pen)
[virtual,const]QPainterPathshapeVirtual method QPainterPath QGraphicsLineItem::shape()
[virtual,const]inttypeVirtual method int QGraphicsLineItem::type()

Protected methods (static, non-static and constructors)

voidaddToIndexMethod void QGraphicsLineItem::addToIndex()
[virtual]voidcontextMenuEvent(QGraphicsSceneContextMenuEvent ptr event)Virtual method void QGraphicsLineItem::contextMenuEvent(QGraphicsSceneContextMenuEvent *event)
[virtual]voiddragEnterEvent(QGraphicsSceneDragDropEvent ptr event)Virtual method void QGraphicsLineItem::dragEnterEvent(QGraphicsSceneDragDropEvent *event)
[virtual]voiddragLeaveEvent(QGraphicsSceneDragDropEvent ptr event)Virtual method void QGraphicsLineItem::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)
[virtual]voiddragMoveEvent(QGraphicsSceneDragDropEvent ptr event)Virtual method void QGraphicsLineItem::dragMoveEvent(QGraphicsSceneDragDropEvent *event)
[virtual]voiddropEvent(QGraphicsSceneDragDropEvent ptr event)Virtual method void QGraphicsLineItem::dropEvent(QGraphicsSceneDragDropEvent *event)
[virtual,const]QVariantextension(const QVariant variant)Virtual method QVariant QGraphicsLineItem::extension(const QVariant &variant)
[virtual]voidfocusInEvent(QFocusEvent ptr event)Virtual method void QGraphicsLineItem::focusInEvent(QFocusEvent *event)
[virtual]voidfocusOutEvent(QFocusEvent ptr event)Virtual method void QGraphicsLineItem::focusOutEvent(QFocusEvent *event)
[virtual]voidhoverEnterEvent(QGraphicsSceneHoverEvent ptr event)Virtual method void QGraphicsLineItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event)
[virtual]voidhoverLeaveEvent(QGraphicsSceneHoverEvent ptr event)Virtual method void QGraphicsLineItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event)
[virtual]voidhoverMoveEvent(QGraphicsSceneHoverEvent ptr event)Virtual method void QGraphicsLineItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event)
[virtual]voidinputMethodEvent(QInputMethodEvent ptr event)Virtual method void QGraphicsLineItem::inputMethodEvent(QInputMethodEvent *event)
[virtual,const]QVariantinputMethodQuery(const Qt_InputMethodQuery query)Virtual method QVariant QGraphicsLineItem::inputMethodQuery(Qt::InputMethodQuery query)
[virtual]QVariantitemChange(const QGraphicsItem_GraphicsItemChange change,
const QVariant value)
Virtual method QVariant QGraphicsLineItem::itemChange(QGraphicsItem::GraphicsItemChange change, const QVariant &value)
[virtual]voidkeyPressEvent(QKeyEvent ptr event)Virtual method void QGraphicsLineItem::keyPressEvent(QKeyEvent *event)
[virtual]voidkeyReleaseEvent(QKeyEvent ptr event)Virtual method void QGraphicsLineItem::keyReleaseEvent(QKeyEvent *event)
[virtual]voidmouseDoubleClickEvent(QGraphicsSceneMouseEvent ptr event)Virtual method void QGraphicsLineItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)
[virtual]voidmouseMoveEvent(QGraphicsSceneMouseEvent ptr event)Virtual method void QGraphicsLineItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event)
[virtual]voidmousePressEvent(QGraphicsSceneMouseEvent ptr event)Virtual method void QGraphicsLineItem::mousePressEvent(QGraphicsSceneMouseEvent *event)
[virtual]voidmouseReleaseEvent(QGraphicsSceneMouseEvent ptr event)Virtual method void QGraphicsLineItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
voidprepareGeometryChangeMethod void QGraphicsLineItem::prepareGeometryChange()
voidremoveFromIndexMethod void QGraphicsLineItem::removeFromIndex()
[virtual]boolsceneEvent(QEvent ptr event)Virtual method bool QGraphicsLineItem::sceneEvent(QEvent *event)
[virtual]boolsceneEventFilter(QGraphicsItem ptr watched,
QEvent ptr event)
Virtual method bool QGraphicsLineItem::sceneEventFilter(QGraphicsItem *watched, QEvent *event)
[virtual]voidsetExtension(unsigned int extension,
const QVariant variant)
Virtual method void QGraphicsLineItem::setExtension(QGraphicsItem::Extension extension, const QVariant &variant)
[virtual,const]boolsupportsExtension(unsigned int extension)Virtual method bool QGraphicsLineItem::supportsExtension(QGraphicsItem::Extension extension)
[virtual]voidwheelEvent(QGraphicsSceneWheelEvent ptr event)Virtual method void QGraphicsLineItem::wheelEvent(QGraphicsSceneWheelEvent *event)

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 addToIndex

Description: Method void QGraphicsLineItem::addToIndex()

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

[virtual] void advance(int phase)

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

This method can be reimplemented in a derived class.

[virtual,const] QRectF boundingRect

Description: Virtual method QRectF QGraphicsLineItem::boundingRect()

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[virtual,const] bool contains(const QPointF point)

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

This method can be reimplemented in a derived class.

[virtual] void contextMenuEvent(QGraphicsSceneContextMenuEvent ptr event)

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

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

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

[virtual] void dragEnterEvent(QGraphicsSceneDragDropEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void dragLeaveEvent(QGraphicsSceneDragDropEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void dragMoveEvent(QGraphicsSceneDragDropEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void dropEvent(QGraphicsSceneDragDropEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual,const] QVariant extension(const QVariant variant)

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

This method can be reimplemented in a derived class.

[virtual] void focusInEvent(QFocusEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void focusOutEvent(QFocusEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void hoverEnterEvent(QGraphicsSceneHoverEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void hoverLeaveEvent(QGraphicsSceneHoverEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void hoverMoveEvent(QGraphicsSceneHoverEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void inputMethodEvent(QInputMethodEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual,const] QVariant inputMethodQuery(const Qt_InputMethodQuery query)

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

This method can be reimplemented in a derived class.

[virtual,const] bool isObscuredBy(const QGraphicsItem ptr item)

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

This method can be reimplemented in a derived class.

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

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

This is a reimplementation of QGraphicsItem::isObscuredBy

[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

[virtual] QVariant itemChange(const QGraphicsItem_GraphicsItemChange change,const QVariant value)

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

This method can be reimplemented in a derived class.

[virtual] void keyPressEvent(QKeyEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void keyReleaseEvent(QKeyEvent ptr event)

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

This method can be reimplemented in a derived class.

[const] QLineF line

Description: Method QLineF QGraphicsLineItem::line()

Python specific notes:

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

void line=(const QLineF line)

Description: Method void QGraphicsLineItem::setLine(const QLineF &line)

Python specific notes:

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

[virtual] void mouseDoubleClickEvent(QGraphicsSceneMouseEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void mouseMoveEvent(QGraphicsSceneMouseEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void mousePressEvent(QGraphicsSceneMouseEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void mouseReleaseEvent(QGraphicsSceneMouseEvent ptr event)

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

This method can be reimplemented in a derived class.

[static] new QGraphicsLineItem new(QGraphicsItem ptr parent = 0,QGraphicsScene ptr scene = 0)

Description: Constructor QGraphicsLineItem::QGraphicsLineItem(QGraphicsItem *parent, QGraphicsScene *scene)

This method creates an object of class QGraphicsLineItem.

Python specific notes:

This method is the default initializer of the object

[static] new QGraphicsLineItem new(const QLineF line,QGraphicsItem ptr parent = 0,QGraphicsScene ptr scene = 0)

Description: Constructor QGraphicsLineItem::QGraphicsLineItem(const QLineF &line, QGraphicsItem *parent, QGraphicsScene *scene)

This method creates an object of class QGraphicsLineItem.

Python specific notes:

This method is the default initializer of the object

[static] new QGraphicsLineItem new(double x1,double y1,double x2,double y2,QGraphicsItem ptr parent = 0,QGraphicsScene ptr scene = 0)

Description: Constructor QGraphicsLineItem::QGraphicsLineItem(double x1, double y1, double x2, double y2, QGraphicsItem *parent, QGraphicsScene *scene)

This method creates an object of class QGraphicsLineItem.

Python specific notes:

This method is the default initializer of the object

[virtual,const] QPainterPath opaqueArea

Description: Virtual method QPainterPath QGraphicsLineItem::opaqueArea()

This method can be reimplemented in a derived class.

[virtual] void paint(QPainter ptr painter,const QStyleOptionGraphicsItem ptr option,QWidget ptr widget)

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

This method can be reimplemented in a derived class.

[const] QPen pen

Description: Method QPen QGraphicsLineItem::pen()

Python specific notes:

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

void pen=(const QPen pen)

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

Python specific notes:

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

void prepareGeometryChange

Description: Method void QGraphicsLineItem::prepareGeometryChange()

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

void removeFromIndex

Description: Method void QGraphicsLineItem::removeFromIndex()

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

[virtual] bool sceneEvent(QEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] bool sceneEventFilter(QGraphicsItem ptr watched,QEvent ptr event)

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

This method can be reimplemented in a derived class.

[virtual] void setExtension(unsigned int extension,const QVariant variant)

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

This method can be reimplemented in a derived class.

void setLine(const QLineF line)

Description: Method void QGraphicsLineItem::setLine(const QLineF &line)

Python specific notes:

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

void setLine(double x1,double y1,double x2,double y2)

Description: Method void QGraphicsLineItem::setLine(double x1, double y1, double x2, double y2)

void setPen(const QPen pen)

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

Python specific notes:

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

[virtual,const] QPainterPath shape

Description: Virtual method QPainterPath QGraphicsLineItem::shape()

This method can be reimplemented in a derived class.

[virtual,const] bool supportsExtension(unsigned int extension)

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

This method can be reimplemented in a derived class.

[virtual,const] int type

Description: Virtual method int QGraphicsLineItem::type()

This method can be reimplemented in a derived class.

[virtual] void wheelEvent(QGraphicsSceneWheelEvent ptr event)

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

This method can be reimplemented in a derived class.