API reference - Class QContextMenuEvent

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QContextMenuEvent

Class hierarchy: QContextMenuEvent » QInputEvent » QEvent

Sub-classes: Reason, QFlags_Reason

Public constructors

new QContextMenuEventnew(const QContextMenuEvent_Reason reason,
const QPoint pos,
const QPoint globalPos,
Qt_QFlags_KeyboardModifier modifiers)
Constructor QContextMenuEvent::QContextMenuEvent(QContextMenuEvent::Reason reason, const QPoint &pos, const QPoint &globalPos, QFlags<Qt::KeyboardModifier> modifiers)
new QContextMenuEventnew(const QContextMenuEvent_Reason reason,
const QPoint pos,
const QPoint globalPos)
Constructor QContextMenuEvent::QContextMenuEvent(QContextMenuEvent::Reason reason, const QPoint &pos, const QPoint &globalPos)
new QContextMenuEventnew(const QContextMenuEvent_Reason reason,
const QPoint pos)
Constructor QContextMenuEvent::QContextMenuEvent(QContextMenuEvent::Reason reason, const QPoint &pos)

Public methods

void_assign(const QContextMenuEvent other)Assigns another object to self
[const]QContextMenuEvent 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]new QContextMenuEvent ptr_dupCreates a copy of self
[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]QPointglobalPosMethod const QPoint &QContextMenuEvent::globalPos()
[const]intglobalXMethod int QContextMenuEvent::globalX()
[const]intglobalYMethod int QContextMenuEvent::globalY()
[const]QPointposMethod const QPoint &QContextMenuEvent::pos()
[const]QContextMenuEvent_ReasonreasonMethod QContextMenuEvent::Reason QContextMenuEvent::reason()
[const]intxMethod int QContextMenuEvent::x()
[const]intyMethod int QContextMenuEvent::y()

Public static methods and constants

[static,const]QContextMenuEvent_ReasonKeyboardEnum constant QContextMenuEvent::Keyboard
[static,const]QContextMenuEvent_ReasonMouseEnum constant QContextMenuEvent::Mouse
[static,const]QContextMenuEvent_ReasonOtherEnum constant QContextMenuEvent::Other

Detailed description

Keyboard

Signature: [static,const] QContextMenuEvent_Reason Keyboard

Description: Enum constant QContextMenuEvent::Keyboard

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

Mouse

Signature: [static,const] QContextMenuEvent_Reason Mouse

Description: Enum constant QContextMenuEvent::Mouse

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

Other

Signature: [static,const] QContextMenuEvent_Reason Other

Description: Enum constant QContextMenuEvent::Other

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

_assign

Signature: void _assign (const QContextMenuEvent other)

Description: Assigns another object to self

_const_cast

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

_dup

Signature: [const] new QContextMenuEvent ptr _dup

Description: Creates a copy of self

_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.

globalPos

Signature: [const] QPoint globalPos

Description: Method const QPoint &QContextMenuEvent::globalPos()

globalX

Signature: [const] int globalX

Description: Method int QContextMenuEvent::globalX()

globalY

Signature: [const] int globalY

Description: Method int QContextMenuEvent::globalY()

new

(1) Signature: [static] new QContextMenuEvent new (const QContextMenuEvent_Reason reason, const QPoint pos, const QPoint globalPos, Qt_QFlags_KeyboardModifier modifiers)

Description: Constructor QContextMenuEvent::QContextMenuEvent(QContextMenuEvent::Reason reason, const QPoint &pos, const QPoint &globalPos, QFlags<Qt::KeyboardModifier> modifiers)

This method creates an object of class QContextMenuEvent.

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

(2) Signature: [static] new QContextMenuEvent new (const QContextMenuEvent_Reason reason, const QPoint pos, const QPoint globalPos)

Description: Constructor QContextMenuEvent::QContextMenuEvent(QContextMenuEvent::Reason reason, const QPoint &pos, const QPoint &globalPos)

This method creates an object of class QContextMenuEvent.

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

(3) Signature: [static] new QContextMenuEvent new (const QContextMenuEvent_Reason reason, const QPoint pos)

Description: Constructor QContextMenuEvent::QContextMenuEvent(QContextMenuEvent::Reason reason, const QPoint &pos)

This method creates an object of class QContextMenuEvent.

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

pos

Signature: [const] QPoint pos

Description: Method const QPoint &QContextMenuEvent::pos()

reason

Signature: [const] QContextMenuEvent_Reason reason

Description: Method QContextMenuEvent::Reason QContextMenuEvent::reason()

x

Signature: [const] int x

Description: Method int QContextMenuEvent::x()

y

Signature: [const] int y

Description: Method int QContextMenuEvent::y()