API reference - Class QDrag

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QDrag

Class hierarchy: QDrag » QObject

Public constructors

new QDragnew(QObject ptr dragSource)Constructor QDrag::QDrag(QObject *dragSource)

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.
[signal]voidactionChanged(const Qt_DropAction action)Signal declaration for QDrag::actionChanged(Qt::DropAction action)
[const]Qt_DropActiondefaultActionMethod Qt::DropAction QDrag::defaultAction()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QDrag::destroyed(QObject *)
[const]QPixmapdragCursor(const Qt_DropAction action)Method QPixmap QDrag::dragCursor(Qt::DropAction action)
voidemit_actionChanged(const Qt_DropAction action)Emitter for signal void QDrag::actionChanged(Qt::DropAction action)
voidemit_destroyed(QObject ptr arg1 = 0)Emitter for signal void QDrag::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QDrag::objectNameChanged(const QString &objectName)
voidemit_targetChanged(QObject ptr newTarget)Emitter for signal void QDrag::targetChanged(QObject *newTarget)
boolevent(QEvent ptr arg1)Virtual method bool QDrag::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QDrag::eventFilter(QObject *, QEvent *)
Qt_DropActionexec(Qt_QFlags_DropAction supportedActions = Qt::MoveAction)Method Qt::DropAction QDrag::exec(QFlags<Qt::DropAction> supportedActions)
Qt_DropActionexec(Qt_QFlags_DropAction supportedActions,
const Qt_DropAction defaultAction)
Method Qt::DropAction QDrag::exec(QFlags<Qt::DropAction> supportedActions, Qt::DropAction defaultAction)
[const]QPointhotSpotMethod QPoint QDrag::hotSpot()
voidhotSpot=(const QPoint hotspot)Method void QDrag::setHotSpot(const QPoint &hotspot)
[const]QMimeData ptrmimeDataMethod QMimeData *QDrag::mimeData()
voidmimeData=(QMimeData ptr data)Method void QDrag::setMimeData(QMimeData *data)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QDrag::objectNameChanged(const QString &objectName)
[const]QPixmappixmapMethod QPixmap QDrag::pixmap()
voidpixmap=(const QPixmap arg1)Method void QDrag::setPixmap(const QPixmap &)
voidsetDragCursor(const QPixmap cursor,
const Qt_DropAction action)
Method void QDrag::setDragCursor(const QPixmap &cursor, Qt::DropAction action)
voidsetHotSpot(const QPoint hotspot)Method void QDrag::setHotSpot(const QPoint &hotspot)
voidsetMimeData(QMimeData ptr data)Method void QDrag::setMimeData(QMimeData *data)
voidsetPixmap(const QPixmap arg1)Method void QDrag::setPixmap(const QPixmap &)
[const]QObject ptrsourceMethod QObject *QDrag::source()
Qt_DropActionstart(Qt_QFlags_DropAction supportedActions = Qt::CopyAction)Method Qt::DropAction QDrag::start(QFlags<Qt::DropAction> supportedActions)
[const]Qt_QFlags_DropActionsupportedActionsMethod QFlags<Qt::DropAction> QDrag::supportedActions()
[const]QObject ptrtargetMethod QObject *QDrag::target()
[signal]voidtargetChanged(QObject ptr newTarget)Signal declaration for QDrag::targetChanged(QObject *newTarget)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QDrag::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QDrag::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr arg1)Virtual method void QDrag::childEvent(QChildEvent *)
voidcustomEvent(QEvent ptr arg1)Virtual method void QDrag::customEvent(QEvent *)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QDrag::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QDrag::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QDrag::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QDrag::sender()
[const]intsenderSignalIndexMethod int QDrag::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QDrag::timerEvent(QTimerEvent *)

Detailed description

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

actionChanged

Signature: [signal] void actionChanged (const Qt_DropAction action)

Description: Signal declaration for QDrag::actionChanged(Qt::DropAction action)

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr arg1)

Description: Virtual method void QDrag::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QDrag::customEvent(QEvent *)

This method can be reimplemented in a derived class.

defaultAction

Signature: [const] Qt_DropAction defaultAction

Description: Method Qt::DropAction QDrag::defaultAction()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QDrag::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QDrag::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

dragCursor

Signature: [const] QPixmap dragCursor (const Qt_DropAction action)

Description: Method QPixmap QDrag::dragCursor(Qt::DropAction action)

emit_actionChanged

Signature: void emit_actionChanged (const Qt_DropAction action)

Description: Emitter for signal void QDrag::actionChanged(Qt::DropAction action)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

Description: Emitter for signal void QDrag::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QDrag::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_targetChanged

Signature: void emit_targetChanged (QObject ptr newTarget)

Description: Emitter for signal void QDrag::targetChanged(QObject *newTarget)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

Description: Virtual method bool QDrag::event(QEvent *)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QDrag::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

exec

(1) Signature: Qt_DropAction exec (Qt_QFlags_DropAction supportedActions = Qt::MoveAction)

Description: Method Qt::DropAction QDrag::exec(QFlags<Qt::DropAction> supportedActions)

Python specific notes:
This attribute is available as 'exec_' in Python.

(2) Signature: Qt_DropAction exec (Qt_QFlags_DropAction supportedActions, const Qt_DropAction defaultAction)

Description: Method Qt::DropAction QDrag::exec(QFlags<Qt::DropAction> supportedActions, Qt::DropAction defaultAction)

Python specific notes:
This attribute is available as 'exec_' in Python.

hotSpot

Signature: [const] QPoint hotSpot

Description: Method QPoint QDrag::hotSpot()

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

hotSpot=

Signature: void hotSpot= (const QPoint hotspot)

Description: Method void QDrag::setHotSpot(const QPoint &hotspot)

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

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QDrag::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

mimeData

Signature: [const] QMimeData ptr mimeData

Description: Method QMimeData *QDrag::mimeData()

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

mimeData=

Signature: void mimeData= (QMimeData ptr data)

Description: Method void QDrag::setMimeData(QMimeData *data)

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

new

Signature: [static] new QDrag new (QObject ptr dragSource)

Description: Constructor QDrag::QDrag(QObject *dragSource)

This method creates an object of class QDrag.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QDrag::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

pixmap

Signature: [const] QPixmap pixmap

Description: Method QPixmap QDrag::pixmap()

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

pixmap=

Signature: void pixmap= (const QPixmap arg1)

Description: Method void QDrag::setPixmap(const QPixmap &)

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QDrag::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QDrag::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QDrag::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setDragCursor

Signature: void setDragCursor (const QPixmap cursor, const Qt_DropAction action)

Description: Method void QDrag::setDragCursor(const QPixmap &cursor, Qt::DropAction action)

setHotSpot

Signature: void setHotSpot (const QPoint hotspot)

Description: Method void QDrag::setHotSpot(const QPoint &hotspot)

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

setMimeData

Signature: void setMimeData (QMimeData ptr data)

Description: Method void QDrag::setMimeData(QMimeData *data)

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

setPixmap

Signature: void setPixmap (const QPixmap arg1)

Description: Method void QDrag::setPixmap(const QPixmap &)

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

source

Signature: [const] QObject ptr source

Description: Method QObject *QDrag::source()

start

Signature: Qt_DropAction start (Qt_QFlags_DropAction supportedActions = Qt::CopyAction)

Description: Method Qt::DropAction QDrag::start(QFlags<Qt::DropAction> supportedActions)

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

supportedActions

Signature: [const] Qt_QFlags_DropAction supportedActions

Description: Method QFlags<Qt::DropAction> QDrag::supportedActions()

target

Signature: [const] QObject ptr target

Description: Method QObject *QDrag::target()

targetChanged

Signature: [signal] void targetChanged (QObject ptr newTarget)

Description: Signal declaration for QDrag::targetChanged(QObject *newTarget)

You can bind a procedure to this signal.

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QDrag::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QDrag::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QDrag::trUtf8(const char *s, const char *c, int n)

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