KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QWheelEvent

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QWheelEvent

Class hierarchy: QWheelEvent » QInputEvent » QEvent

Public constructors

new QWheelEventnew(const QPointF pos,
int delta,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const Qt_Orientation orient = Qt::Vertical)
Constructor QWheelEvent::QWheelEvent(const QPointF &pos, int delta, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::Orientation orient)
new QWheelEventnew(const QPointF pos,
const QPointF globalPos,
int delta,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const Qt_Orientation orient = Qt::Vertical)
Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, int delta, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::Orientation orient)
new QWheelEventnew(const QPointF pos,
const QPointF globalPos,
QPoint pixelDelta,
QPoint angleDelta,
int qt4Delta,
const Qt_Orientation qt4Orientation,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers)
Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)
new QWheelEventnew(const QPointF pos,
const QPointF globalPos,
QPoint pixelDelta,
QPoint angleDelta,
int qt4Delta,
const Qt_Orientation qt4Orientation,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const Qt_ScrollPhase phase)
Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase)
new QWheelEventnew(const QPointF pos,
const QPointF globalPos,
QPoint pixelDelta,
QPoint angleDelta,
int qt4Delta,
const Qt_Orientation qt4Orientation,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const Qt_ScrollPhase phase,
const Qt_MouseEventSource source)
Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase, Qt::MouseEventSource source)
new QWheelEventnew(const QPointF pos,
const QPointF globalPos,
QPoint pixelDelta,
QPoint angleDelta,
int qt4Delta,
const Qt_Orientation qt4Orientation,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const Qt_ScrollPhase phase,
const Qt_MouseEventSource source,
bool inverted)
Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase, Qt::MouseEventSource source, bool inverted)
new QWheelEventnew(QPointF pos,
QPointF globalPos,
QPoint pixelDelta,
QPoint angleDelta,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const Qt_ScrollPhase phase,
bool inverted,
const Qt_MouseEventSource source = Qt::MouseEventNotSynthesized)
Constructor QWheelEvent::QWheelEvent(QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase, bool inverted, Qt::MouseEventSource source)

Public methods

void_assign(const QWheelEvent other)Assigns another object to self
[const]QWheelEvent 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 QWheelEvent 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]QPointangleDeltaMethod QPoint QWheelEvent::angleDelta()
[const]Qt_QFlags_MouseButtonbuttonsMethod QFlags<Qt::MouseButton> QWheelEvent::buttons()
[const]intdeltaMethod int QWheelEvent::delta()
[const]QPointglobalPosMethod QPoint QWheelEvent::globalPos()
[const]QPointFglobalPosFMethod const QPointF &QWheelEvent::globalPosF()
[const]intglobalXMethod int QWheelEvent::globalX()
[const]intglobalYMethod int QWheelEvent::globalY()
[const]boolinvertedMethod bool QWheelEvent::inverted()
[const]Qt_OrientationorientationMethod Qt::Orientation QWheelEvent::orientation()
[const]Qt_ScrollPhasephaseMethod Qt::ScrollPhase QWheelEvent::phase()
[const]QPointpixelDeltaMethod QPoint QWheelEvent::pixelDelta()
[const]QPointposMethod QPoint QWheelEvent::pos()
[const]QPointFposFMethod const QPointF &QWheelEvent::posF()
[const]Qt_MouseEventSourcesourceMethod Qt::MouseEventSource QWheelEvent::source()
[const]intxMethod int QWheelEvent::x()
[const]intyMethod int QWheelEvent::y()

Detailed description

_assign

Signature: void _assign (const QWheelEvent other)

Description: Assigns another object to self

_const_cast

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

angleDelta

Signature: [const] QPoint angleDelta

Description: Method QPoint QWheelEvent::angleDelta()

buttons

Signature: [const] Qt_QFlags_MouseButton buttons

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

delta

Signature: [const] int delta

Description: Method int QWheelEvent::delta()

globalPos

Signature: [const] QPoint globalPos

Description: Method QPoint QWheelEvent::globalPos()

globalPosF

Signature: [const] QPointF globalPosF

Description: Method const QPointF &QWheelEvent::globalPosF()

globalX

Signature: [const] int globalX

Description: Method int QWheelEvent::globalX()

globalY

Signature: [const] int globalY

Description: Method int QWheelEvent::globalY()

inverted

Signature: [const] bool inverted

Description: Method bool QWheelEvent::inverted()

new

(1) Signature: [static] new QWheelEvent new (const QPointF pos, int delta, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const Qt_Orientation orient = Qt::Vertical)

Description: Constructor QWheelEvent::QWheelEvent(const QPointF &pos, int delta, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::Orientation orient)

This method creates an object of class QWheelEvent.

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

(2) Signature: [static] new QWheelEvent new (const QPointF pos, const QPointF globalPos, int delta, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const Qt_Orientation orient = Qt::Vertical)

Description: Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, int delta, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::Orientation orient)

This method creates an object of class QWheelEvent.

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

(3) Signature: [static] new QWheelEvent new (const QPointF pos, const QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, const Qt_Orientation qt4Orientation, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers)

Description: Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers)

This method creates an object of class QWheelEvent.

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

(4) Signature: [static] new QWheelEvent new (const QPointF pos, const QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, const Qt_Orientation qt4Orientation, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const Qt_ScrollPhase phase)

Description: Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase)

This method creates an object of class QWheelEvent.

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

(5) Signature: [static] new QWheelEvent new (const QPointF pos, const QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, const Qt_Orientation qt4Orientation, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const Qt_ScrollPhase phase, const Qt_MouseEventSource source)

Description: Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase, Qt::MouseEventSource source)

This method creates an object of class QWheelEvent.

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

(6) Signature: [static] new QWheelEvent new (const QPointF pos, const QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, const Qt_Orientation qt4Orientation, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const Qt_ScrollPhase phase, const Qt_MouseEventSource source, bool inverted)

Description: Constructor QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF &globalPos, QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase, Qt::MouseEventSource source, bool inverted)

This method creates an object of class QWheelEvent.

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

(7) Signature: [static] new QWheelEvent new (QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const Qt_ScrollPhase phase, bool inverted, const Qt_MouseEventSource source = Qt::MouseEventNotSynthesized)

Description: Constructor QWheelEvent::QWheelEvent(QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoint angleDelta, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, Qt::ScrollPhase phase, bool inverted, Qt::MouseEventSource source)

This method creates an object of class QWheelEvent.

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

orientation

Signature: [const] Qt_Orientation orientation

Description: Method Qt::Orientation QWheelEvent::orientation()

phase

Signature: [const] Qt_ScrollPhase phase

Description: Method Qt::ScrollPhase QWheelEvent::phase()

pixelDelta

Signature: [const] QPoint pixelDelta

Description: Method QPoint QWheelEvent::pixelDelta()

pos

Signature: [const] QPoint pos

Description: Method QPoint QWheelEvent::pos()

posF

Signature: [const] QPointF posF

Description: Method const QPointF &QWheelEvent::posF()

source

Signature: [const] Qt_MouseEventSource source

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

x

Signature: [const] int x

Description: Method int QWheelEvent::x()

y

Signature: [const] int y

Description: Method int QWheelEvent::y()