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

API reference - Class QDropEvent

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QDropEvent

Class hierarchy: QDropEvent » QEvent

Public constructors

new QDropEventnew(const QPointF pos,
Qt_QFlags_DropAction actions,
const QMimeData ptr data,
Qt_QFlags_MouseButton buttons,
Qt_QFlags_KeyboardModifier modifiers,
const QEvent_Type type = QEvent::Drop)
Constructor QDropEvent::QDropEvent(const QPointF &pos, QFlags<Qt::DropAction> actions, const QMimeData *data, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, QEvent::Type type)

Public methods

void_assign(const QDropEvent other)Assigns another object to self
[const]QDropEvent 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 QDropEvent 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.
voidacceptProposedActionMethod void QDropEvent::acceptProposedAction()
[const]Qt_DropActiondropActionMethod Qt::DropAction QDropEvent::dropAction()
voiddropAction=(const Qt_DropAction action)Method void QDropEvent::setDropAction(Qt::DropAction action)
[const]Qt_QFlags_KeyboardModifierkeyboardModifiersMethod QFlags<Qt::KeyboardModifier> QDropEvent::keyboardModifiers()
[const]const QMimeData ptrmimeDataMethod const QMimeData *QDropEvent::mimeData()
[const]Qt_QFlags_MouseButtonmouseButtonsMethod QFlags<Qt::MouseButton> QDropEvent::mouseButtons()
[const]QPointposMethod QPoint QDropEvent::pos()
[const]QPointFposFMethod const QPointF &QDropEvent::posF()
[const]Qt_QFlags_DropActionpossibleActionsMethod QFlags<Qt::DropAction> QDropEvent::possibleActions()
[const]Qt_DropActionproposedActionMethod Qt::DropAction QDropEvent::proposedAction()
voidsetDropAction(const Qt_DropAction action)Method void QDropEvent::setDropAction(Qt::DropAction action)
[const]QObject ptrsourceMethod QObject *QDropEvent::source()

Detailed description

_assign

Signature: void _assign (const QDropEvent other)

Description: Assigns another object to self

_const_cast

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

acceptProposedAction

Signature: void acceptProposedAction

Description: Method void QDropEvent::acceptProposedAction()

dropAction

Signature: [const] Qt_DropAction dropAction

Description: Method Qt::DropAction QDropEvent::dropAction()

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

dropAction=

Signature: void dropAction= (const Qt_DropAction action)

Description: Method void QDropEvent::setDropAction(Qt::DropAction action)

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

keyboardModifiers

Signature: [const] Qt_QFlags_KeyboardModifier keyboardModifiers

Description: Method QFlags<Qt::KeyboardModifier> QDropEvent::keyboardModifiers()

mimeData

Signature: [const] const QMimeData ptr mimeData

Description: Method const QMimeData *QDropEvent::mimeData()

mouseButtons

Signature: [const] Qt_QFlags_MouseButton mouseButtons

Description: Method QFlags<Qt::MouseButton> QDropEvent::mouseButtons()

new

Signature: [static] new QDropEvent new (const QPointF pos, Qt_QFlags_DropAction actions, const QMimeData ptr data, Qt_QFlags_MouseButton buttons, Qt_QFlags_KeyboardModifier modifiers, const QEvent_Type type = QEvent::Drop)

Description: Constructor QDropEvent::QDropEvent(const QPointF &pos, QFlags<Qt::DropAction> actions, const QMimeData *data, QFlags<Qt::MouseButton> buttons, QFlags<Qt::KeyboardModifier> modifiers, QEvent::Type type)

This method creates an object of class QDropEvent.

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

pos

Signature: [const] QPoint pos

Description: Method QPoint QDropEvent::pos()

posF

Signature: [const] QPointF posF

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

possibleActions

Signature: [const] Qt_QFlags_DropAction possibleActions

Description: Method QFlags<Qt::DropAction> QDropEvent::possibleActions()

proposedAction

Signature: [const] Qt_DropAction proposedAction

Description: Method Qt::DropAction QDropEvent::proposedAction()

setDropAction

Signature: void setDropAction (const Qt_DropAction action)

Description: Method void QDropEvent::setDropAction(Qt::DropAction action)

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

source

Signature: [const] QObject ptr source

Description: Method QObject *QDropEvent::source()