API reference - Class QMouseEvent

Notation used in Ruby API documentation

Description: Binding of QMouseEvent

Class hierarchy: QMouseEvent » QInputEvent » QEvent

Public constructors

new QMouseEventnew(const QEvent_Type type,
const QPoint pos,
const Qt_MouseButton button,
const Qt_QFlags_MouseButton buttons,
const Qt_QFlags_KeyboardModifier modifiers)
Constructor QMouseEvent::QMouseEvent(QEvent::Type type, const QPoint &pos, Qt::MouseButton button, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)
new QMouseEventnew(const QEvent_Type type,
const QPoint pos,
const QPoint globalPos,
const Qt_MouseButton button,
const Qt_QFlags_MouseButton buttons,
const Qt_QFlags_KeyboardModifier modifiers)
Constructor QMouseEvent::QMouseEvent(QEvent::Type type, const QPoint &pos, const QPoint &globalPos, Qt::MouseButton button, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)

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.
voidassign(const QMouseEvent other)Assigns another object to self
[const]Qt_MouseButtonbuttonMethod Qt::MouseButton QMouseEvent::button()
[const]Qt_QFlags_MouseButtonbuttonsMethod QFlags<Qt::MouseButton> QMouseEvent::buttons()
[const]new QMouseEvent ptrdupCreates a copy of self
[const]QPointglobalPosMethod const QPoint &QMouseEvent::globalPos()
[const]intglobalXMethod int QMouseEvent::globalX()
[const]intglobalYMethod int QMouseEvent::globalY()
[const]boolhasExtendedInfoMethod bool QMouseEvent::hasExtendedInfo()
[const]QPointposMethod const QPoint &QMouseEvent::pos()
[const]QPointFposFMethod QPointF QMouseEvent::posF()
[const]intxMethod int QMouseEvent::x()
[const]intyMethod int QMouseEvent::y()

Public static methods and constants

QMouseEvent ptrcreateExtendedMouseEvent(const QEvent_Type type,
const QPointF pos,
const QPoint globalPos,
const Qt_MouseButton button,
const Qt_QFlags_MouseButton buttons,
const Qt_QFlags_KeyboardModifier modifiers)
Static method QMouseEvent *QMouseEvent::createExtendedMouseEvent(QEvent::Type type, const QPointF &pos, const QPoint &globalPos, Qt::MouseButton button, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)

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 assign(const QMouseEvent other)

Description: Assigns another object to self

[const] Qt_MouseButton button

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

[const] Qt_QFlags_MouseButton buttons

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

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[static] QMouseEvent ptr createExtendedMouseEvent(const QEvent_Type type,const QPointF pos,const QPoint globalPos,const Qt_MouseButton button,const Qt_QFlags_MouseButton buttons,const Qt_QFlags_KeyboardModifier modifiers)

Description: Static method QMouseEvent *QMouseEvent::createExtendedMouseEvent(QEvent::Type type, const QPointF &pos, const QPoint &globalPos, Qt::MouseButton button, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)

This method is static and can be called without an instance.

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

[const] new QMouseEvent ptr dup

Description: Creates a copy of self

[const] QPoint globalPos

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

[const] int globalX

Description: Method int QMouseEvent::globalX()

[const] int globalY

Description: Method int QMouseEvent::globalY()

[const] bool hasExtendedInfo

Description: Method bool QMouseEvent::hasExtendedInfo()

[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

[static] new QMouseEvent new(const QEvent_Type type,const QPoint pos,const Qt_MouseButton button,const Qt_QFlags_MouseButton buttons,const Qt_QFlags_KeyboardModifier modifiers)

Description: Constructor QMouseEvent::QMouseEvent(QEvent::Type type, const QPoint &pos, Qt::MouseButton button, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)

This method creates an object of class QMouseEvent.

Python specific notes:

This method is the default initializer of the object

[static] new QMouseEvent new(const QEvent_Type type,const QPoint pos,const QPoint globalPos,const Qt_MouseButton button,const Qt_QFlags_MouseButton buttons,const Qt_QFlags_KeyboardModifier modifiers)

Description: Constructor QMouseEvent::QMouseEvent(QEvent::Type type, const QPoint &pos, const QPoint &globalPos, Qt::MouseButton button, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)

This method creates an object of class QMouseEvent.

Python specific notes:

This method is the default initializer of the object

[const] QPoint pos

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

[const] QPointF posF

Description: Method QPointF QMouseEvent::posF()

[const] int x

Description: Method int QMouseEvent::x()

[const] int y

Description: Method int QMouseEvent::y()