KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QGraphicsSceneMouseEvent

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsSceneMouseEvent

Class hierarchy: QGraphicsSceneMouseEvent » QGraphicsSceneEvent » QEvent

Public constructors

new QGraphicsSceneMouseEventnew(const QEvent_Type type = QEvent::None)Constructor QGraphicsSceneMouseEvent::QGraphicsSceneMouseEvent(QEvent::Type type)

Public methods

[const]QGraphicsSceneMouseEvent 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]Qt_MouseButtonbuttonMethod Qt::MouseButton QGraphicsSceneMouseEvent::button()
voidbutton=(const Qt_MouseButton button)Method void QGraphicsSceneMouseEvent::setButton(Qt::MouseButton button)
[const]QPointFbuttonDownPos(const Qt_MouseButton button)Method QPointF QGraphicsSceneMouseEvent::buttonDownPos(Qt::MouseButton button)
[const]QPointFbuttonDownScenePos(const Qt_MouseButton button)Method QPointF QGraphicsSceneMouseEvent::buttonDownScenePos(Qt::MouseButton button)
[const]QPointbuttonDownScreenPos(const Qt_MouseButton button)Method QPoint QGraphicsSceneMouseEvent::buttonDownScreenPos(Qt::MouseButton button)
[const]Qt_QFlags_MouseButtonbuttonsMethod QFlags<Qt::MouseButton> QGraphicsSceneMouseEvent::buttons()
voidbuttons=(Qt_QFlags_MouseButton buttons)Method void QGraphicsSceneMouseEvent::setButtons(QFlags<Qt::MouseButton> buttons)
[const]Qt_QFlags_MouseEventFlagflagsMethod QFlags<Qt::MouseEventFlag> QGraphicsSceneMouseEvent::flags()
voidflags=(Qt_QFlags_MouseEventFlag arg1)Method void QGraphicsSceneMouseEvent::setFlags(QFlags<Qt::MouseEventFlag>)
[const]QPointFlastPosMethod QPointF QGraphicsSceneMouseEvent::lastPos()
voidlastPos=(const QPointF pos)Method void QGraphicsSceneMouseEvent::setLastPos(const QPointF &pos)
[const]QPointFlastScenePosMethod QPointF QGraphicsSceneMouseEvent::lastScenePos()
voidlastScenePos=(const QPointF pos)Method void QGraphicsSceneMouseEvent::setLastScenePos(const QPointF &pos)
[const]QPointlastScreenPosMethod QPoint QGraphicsSceneMouseEvent::lastScreenPos()
voidlastScreenPos=(const QPoint pos)Method void QGraphicsSceneMouseEvent::setLastScreenPos(const QPoint &pos)
[const]Qt_QFlags_KeyboardModifiermodifiersMethod QFlags<Qt::KeyboardModifier> QGraphicsSceneMouseEvent::modifiers()
voidmodifiers=(Qt_QFlags_KeyboardModifier modifiers)Method void QGraphicsSceneMouseEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)
[const]QPointFposMethod QPointF QGraphicsSceneMouseEvent::pos()
voidpos=(const QPointF pos)Method void QGraphicsSceneMouseEvent::setPos(const QPointF &pos)
[const]QPointFscenePosMethod QPointF QGraphicsSceneMouseEvent::scenePos()
voidscenePos=(const QPointF pos)Method void QGraphicsSceneMouseEvent::setScenePos(const QPointF &pos)
[const]QPointscreenPosMethod QPoint QGraphicsSceneMouseEvent::screenPos()
voidscreenPos=(const QPoint pos)Method void QGraphicsSceneMouseEvent::setScreenPos(const QPoint &pos)
voidsetButton(const Qt_MouseButton button)Method void QGraphicsSceneMouseEvent::setButton(Qt::MouseButton button)
voidsetButtonDownPos(const Qt_MouseButton button,
const QPointF pos)
Method void QGraphicsSceneMouseEvent::setButtonDownPos(Qt::MouseButton button, const QPointF &pos)
voidsetButtonDownScenePos(const Qt_MouseButton button,
const QPointF pos)
Method void QGraphicsSceneMouseEvent::setButtonDownScenePos(Qt::MouseButton button, const QPointF &pos)
voidsetButtonDownScreenPos(const Qt_MouseButton button,
const QPoint pos)
Method void QGraphicsSceneMouseEvent::setButtonDownScreenPos(Qt::MouseButton button, const QPoint &pos)
voidsetButtons(Qt_QFlags_MouseButton buttons)Method void QGraphicsSceneMouseEvent::setButtons(QFlags<Qt::MouseButton> buttons)
voidsetFlags(Qt_QFlags_MouseEventFlag arg1)Method void QGraphicsSceneMouseEvent::setFlags(QFlags<Qt::MouseEventFlag>)
voidsetLastPos(const QPointF pos)Method void QGraphicsSceneMouseEvent::setLastPos(const QPointF &pos)
voidsetLastScenePos(const QPointF pos)Method void QGraphicsSceneMouseEvent::setLastScenePos(const QPointF &pos)
voidsetLastScreenPos(const QPoint pos)Method void QGraphicsSceneMouseEvent::setLastScreenPos(const QPoint &pos)
voidsetModifiers(Qt_QFlags_KeyboardModifier modifiers)Method void QGraphicsSceneMouseEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)
voidsetPos(const QPointF pos)Method void QGraphicsSceneMouseEvent::setPos(const QPointF &pos)
voidsetScenePos(const QPointF pos)Method void QGraphicsSceneMouseEvent::setScenePos(const QPointF &pos)
voidsetScreenPos(const QPoint pos)Method void QGraphicsSceneMouseEvent::setScreenPos(const QPoint &pos)
voidsetSource(const Qt_MouseEventSource source)Method void QGraphicsSceneMouseEvent::setSource(Qt::MouseEventSource source)
[const]Qt_MouseEventSourcesourceMethod Qt::MouseEventSource QGraphicsSceneMouseEvent::source()
voidsource=(const Qt_MouseEventSource source)Method void QGraphicsSceneMouseEvent::setSource(Qt::MouseEventSource source)

Detailed description

_const_cast

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

button

Signature: [const] Qt_MouseButton button

Description: Method Qt::MouseButton QGraphicsSceneMouseEvent::button()

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

button=

Signature: void button= (const Qt_MouseButton button)

Description: Method void QGraphicsSceneMouseEvent::setButton(Qt::MouseButton button)

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

buttonDownPos

Signature: [const] QPointF buttonDownPos (const Qt_MouseButton button)

Description: Method QPointF QGraphicsSceneMouseEvent::buttonDownPos(Qt::MouseButton button)

buttonDownScenePos

Signature: [const] QPointF buttonDownScenePos (const Qt_MouseButton button)

Description: Method QPointF QGraphicsSceneMouseEvent::buttonDownScenePos(Qt::MouseButton button)

buttonDownScreenPos

Signature: [const] QPoint buttonDownScreenPos (const Qt_MouseButton button)

Description: Method QPoint QGraphicsSceneMouseEvent::buttonDownScreenPos(Qt::MouseButton button)

buttons

Signature: [const] Qt_QFlags_MouseButton buttons

Description: Method QFlags<Qt::MouseButton> QGraphicsSceneMouseEvent::buttons()

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

buttons=

Signature: void buttons= (Qt_QFlags_MouseButton buttons)

Description: Method void QGraphicsSceneMouseEvent::setButtons(QFlags<Qt::MouseButton> buttons)

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

flags

Signature: [const] Qt_QFlags_MouseEventFlag flags

Description: Method QFlags<Qt::MouseEventFlag> QGraphicsSceneMouseEvent::flags()

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

flags=

Signature: void flags= (Qt_QFlags_MouseEventFlag arg1)

Description: Method void QGraphicsSceneMouseEvent::setFlags(QFlags<Qt::MouseEventFlag>)

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

lastPos

Signature: [const] QPointF lastPos

Description: Method QPointF QGraphicsSceneMouseEvent::lastPos()

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

lastPos=

Signature: void lastPos= (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setLastPos(const QPointF &pos)

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

lastScenePos

Signature: [const] QPointF lastScenePos

Description: Method QPointF QGraphicsSceneMouseEvent::lastScenePos()

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

lastScenePos=

Signature: void lastScenePos= (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setLastScenePos(const QPointF &pos)

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

lastScreenPos

Signature: [const] QPoint lastScreenPos

Description: Method QPoint QGraphicsSceneMouseEvent::lastScreenPos()

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

lastScreenPos=

Signature: void lastScreenPos= (const QPoint pos)

Description: Method void QGraphicsSceneMouseEvent::setLastScreenPos(const QPoint &pos)

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

modifiers

Signature: [const] Qt_QFlags_KeyboardModifier modifiers

Description: Method QFlags<Qt::KeyboardModifier> QGraphicsSceneMouseEvent::modifiers()

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

modifiers=

Signature: void modifiers= (Qt_QFlags_KeyboardModifier modifiers)

Description: Method void QGraphicsSceneMouseEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)

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

new

Signature: [static] new QGraphicsSceneMouseEvent new (const QEvent_Type type = QEvent::None)

Description: Constructor QGraphicsSceneMouseEvent::QGraphicsSceneMouseEvent(QEvent::Type type)

This method creates an object of class QGraphicsSceneMouseEvent.

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

pos

Signature: [const] QPointF pos

Description: Method QPointF QGraphicsSceneMouseEvent::pos()

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

pos=

Signature: void pos= (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setPos(const QPointF &pos)

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

scenePos

Signature: [const] QPointF scenePos

Description: Method QPointF QGraphicsSceneMouseEvent::scenePos()

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

scenePos=

Signature: void scenePos= (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setScenePos(const QPointF &pos)

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

screenPos

Signature: [const] QPoint screenPos

Description: Method QPoint QGraphicsSceneMouseEvent::screenPos()

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

screenPos=

Signature: void screenPos= (const QPoint pos)

Description: Method void QGraphicsSceneMouseEvent::setScreenPos(const QPoint &pos)

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

setButton

Signature: void setButton (const Qt_MouseButton button)

Description: Method void QGraphicsSceneMouseEvent::setButton(Qt::MouseButton button)

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

setButtonDownPos

Signature: void setButtonDownPos (const Qt_MouseButton button, const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setButtonDownPos(Qt::MouseButton button, const QPointF &pos)

setButtonDownScenePos

Signature: void setButtonDownScenePos (const Qt_MouseButton button, const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setButtonDownScenePos(Qt::MouseButton button, const QPointF &pos)

setButtonDownScreenPos

Signature: void setButtonDownScreenPos (const Qt_MouseButton button, const QPoint pos)

Description: Method void QGraphicsSceneMouseEvent::setButtonDownScreenPos(Qt::MouseButton button, const QPoint &pos)

setButtons

Signature: void setButtons (Qt_QFlags_MouseButton buttons)

Description: Method void QGraphicsSceneMouseEvent::setButtons(QFlags<Qt::MouseButton> buttons)

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

setFlags

Signature: void setFlags (Qt_QFlags_MouseEventFlag arg1)

Description: Method void QGraphicsSceneMouseEvent::setFlags(QFlags<Qt::MouseEventFlag>)

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

setLastPos

Signature: void setLastPos (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setLastPos(const QPointF &pos)

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

setLastScenePos

Signature: void setLastScenePos (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setLastScenePos(const QPointF &pos)

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

setLastScreenPos

Signature: void setLastScreenPos (const QPoint pos)

Description: Method void QGraphicsSceneMouseEvent::setLastScreenPos(const QPoint &pos)

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

setModifiers

Signature: void setModifiers (Qt_QFlags_KeyboardModifier modifiers)

Description: Method void QGraphicsSceneMouseEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)

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

setPos

Signature: void setPos (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setPos(const QPointF &pos)

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

setScenePos

Signature: void setScenePos (const QPointF pos)

Description: Method void QGraphicsSceneMouseEvent::setScenePos(const QPointF &pos)

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

setScreenPos

Signature: void setScreenPos (const QPoint pos)

Description: Method void QGraphicsSceneMouseEvent::setScreenPos(const QPoint &pos)

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

setSource

Signature: void setSource (const Qt_MouseEventSource source)

Description: Method void QGraphicsSceneMouseEvent::setSource(Qt::MouseEventSource source)

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

source

Signature: [const] Qt_MouseEventSource source

Description: Method Qt::MouseEventSource QGraphicsSceneMouseEvent::source()

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

source=

Signature: void source= (const Qt_MouseEventSource source)

Description: Method void QGraphicsSceneMouseEvent::setSource(Qt::MouseEventSource source)

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