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

API reference - Class QGraphicsSceneContextMenuEvent

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsSceneContextMenuEvent

Class hierarchy: QGraphicsSceneContextMenuEvent » QGraphicsSceneEvent » QEvent

Sub-classes: Reason, QFlags_Reason

Public constructors

new QGraphicsSceneContextMenuEventnew(const QEvent_Type type = QEvent::None)Constructor QGraphicsSceneContextMenuEvent::QGraphicsSceneContextMenuEvent(QEvent::Type type)

Public methods

[const]QGraphicsSceneContextMenuEvent 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_QFlags_KeyboardModifiermodifiersMethod QFlags<Qt::KeyboardModifier> QGraphicsSceneContextMenuEvent::modifiers()
voidmodifiers=(Qt_QFlags_KeyboardModifier modifiers)Method void QGraphicsSceneContextMenuEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)
[const]QPointFposMethod QPointF QGraphicsSceneContextMenuEvent::pos()
voidpos=(const QPointF pos)Method void QGraphicsSceneContextMenuEvent::setPos(const QPointF &pos)
[const]QGraphicsSceneContextMenuEvent_ReasonreasonMethod QGraphicsSceneContextMenuEvent::Reason QGraphicsSceneContextMenuEvent::reason()
voidreason=(const QGraphicsSceneContextMenuEvent_Reason reason)Method void QGraphicsSceneContextMenuEvent::setReason(QGraphicsSceneContextMenuEvent::Reason reason)
[const]QPointFscenePosMethod QPointF QGraphicsSceneContextMenuEvent::scenePos()
voidscenePos=(const QPointF pos)Method void QGraphicsSceneContextMenuEvent::setScenePos(const QPointF &pos)
[const]QPointscreenPosMethod QPoint QGraphicsSceneContextMenuEvent::screenPos()
voidscreenPos=(const QPoint pos)Method void QGraphicsSceneContextMenuEvent::setScreenPos(const QPoint &pos)
voidsetModifiers(Qt_QFlags_KeyboardModifier modifiers)Method void QGraphicsSceneContextMenuEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)
voidsetPos(const QPointF pos)Method void QGraphicsSceneContextMenuEvent::setPos(const QPointF &pos)
voidsetReason(const QGraphicsSceneContextMenuEvent_Reason reason)Method void QGraphicsSceneContextMenuEvent::setReason(QGraphicsSceneContextMenuEvent::Reason reason)
voidsetScenePos(const QPointF pos)Method void QGraphicsSceneContextMenuEvent::setScenePos(const QPointF &pos)
voidsetScreenPos(const QPoint pos)Method void QGraphicsSceneContextMenuEvent::setScreenPos(const QPoint &pos)

Public static methods and constants

[static,const]QGraphicsSceneContextMenuEvent_ReasonKeyboardEnum constant QGraphicsSceneContextMenuEvent::Keyboard
[static,const]QGraphicsSceneContextMenuEvent_ReasonMouseEnum constant QGraphicsSceneContextMenuEvent::Mouse
[static,const]QGraphicsSceneContextMenuEvent_ReasonOtherEnum constant QGraphicsSceneContextMenuEvent::Other

Detailed description

Keyboard

Signature: [static,const] QGraphicsSceneContextMenuEvent_Reason Keyboard

Description: Enum constant QGraphicsSceneContextMenuEvent::Keyboard

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

Mouse

Signature: [static,const] QGraphicsSceneContextMenuEvent_Reason Mouse

Description: Enum constant QGraphicsSceneContextMenuEvent::Mouse

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

Other

Signature: [static,const] QGraphicsSceneContextMenuEvent_Reason Other

Description: Enum constant QGraphicsSceneContextMenuEvent::Other

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

_const_cast

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

modifiers

Signature: [const] Qt_QFlags_KeyboardModifier modifiers

Description: Method QFlags<Qt::KeyboardModifier> QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::setModifiers(QFlags<Qt::KeyboardModifier> modifiers)

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

new

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

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

This method creates an object of class QGraphicsSceneContextMenuEvent.

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

pos

Signature: [const] QPointF pos

Description: Method QPointF QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::setPos(const QPointF &pos)

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

reason

Signature: [const] QGraphicsSceneContextMenuEvent_Reason reason

Description: Method QGraphicsSceneContextMenuEvent::Reason QGraphicsSceneContextMenuEvent::reason()

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

reason=

Signature: void reason= (const QGraphicsSceneContextMenuEvent_Reason reason)

Description: Method void QGraphicsSceneContextMenuEvent::setReason(QGraphicsSceneContextMenuEvent::Reason reason)

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

scenePos

Signature: [const] QPointF scenePos

Description: Method QPointF QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::setScreenPos(const QPoint &pos)

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

setModifiers

Signature: void setModifiers (Qt_QFlags_KeyboardModifier modifiers)

Description: Method void QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::setPos(const QPointF &pos)

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

setReason

Signature: void setReason (const QGraphicsSceneContextMenuEvent_Reason reason)

Description: Method void QGraphicsSceneContextMenuEvent::setReason(QGraphicsSceneContextMenuEvent::Reason reason)

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

setScenePos

Signature: void setScenePos (const QPointF pos)

Description: Method void QGraphicsSceneContextMenuEvent::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 QGraphicsSceneContextMenuEvent::setScreenPos(const QPoint &pos)

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