QDrag 类

QDrag class provides support for MIME-based drag and drop data transfer. 更多...

头: #include <QDrag>
qmake: QT += gui
继承: QObject

公共函数

QDrag (QObject * dragSource )
~QDrag ()
Qt::DropAction defaultAction () const
QPixmap dragCursor (Qt::DropAction action ) const
Qt::DropAction exec (Qt::DropActions supportedActions = Qt::MoveAction)
Qt::DropAction exec (Qt::DropActions supportedActions , Qt::DropAction defaultDropAction )
QPoint hotSpot () const
QMimeData * mimeData () const
QPixmap pixmap () const
void setDragCursor (const QPixmap & cursor , Qt::DropAction action )
void setHotSpot (const QPoint & hotspot )
void setMimeData (QMimeData * data )
void setPixmap (const QPixmap & pixmap )
QObject * source () const
Qt::DropActions supportedActions () const
QObject * target () const

信号

void actionChanged (Qt::DropAction action )
void targetChanged (QObject * newTarget )

静态公共成员

void cancel ()

额外继承成员

详细描述

QDrag class provides support for MIME-based drag and drop data transfer.

Drag and drop is an intuitive way for users to copy or move data around in an application, and is used in many desktop environments as a mechanism for copying data between applications. Drag and drop support in Qt is centered around the QDrag class that handles most of the details of a drag and drop operation.

拖放操作要转移的数据包含在 QMimeData 对象。指定这采用 setMimeData () 函数按以下方式:

        QDrag *drag = new QDrag(this);
        QMimeData *mimeData = new QMimeData;
        mimeData->setText(commentEdit->toPlainText());
        drag->setMimeData(mimeData);
					

注意, setMimeData () assigns ownership of the QMimeData 对象到 QDrag 对象。 QDrag must be constructed on the heap with a parent QObject to ensure that Qt can clean up after the drag and drop operation has been completed.

A pixmap can be used to represent the data while the drag is in progress, and will move with the cursor to the drop target. This pixmap typically shows an icon that represents the MIME type of the data being transferred, but any pixmap can be set with setPixmap (). The cursor's hot spot can be given a position relative to the top-left corner of the pixmap with the setHotSpot () function. The following code positions the pixmap so that the cursor's hot spot points to the center of its bottom edge:

    drag->setHotSpot(QPoint(drag->pixmap().width()/2,
                            drag->pixmap().height()));
					

注意: On X11, the pixmap may not be able to keep up with the mouse movements if the hot spot causes the pixmap to be displayed directly under the cursor.

可以找到源和目标 Widget 采用 source () 和 target (). These functions are often used to determine whether drag and drop operations started and finished at the same widget, so that special behavior can be implemented.

QDrag only deals with the drag and drop operation itself. It is up to the developer to decide when a drag operation begins, and how a QDrag object should be constructed and used. For a given widget, it is often necessary to reimplement mousePressEvent() to determine whether the user has pressed a mouse button, and reimplement mouseMoveEvent() to check whether a QDrag is required.

另请参阅 拖放 , QClipboard , QMimeData , QMacPasteboardMime , 可拖曳图标范例 , 可拖曳文本范例 , 掉落站点范例 ,和 冰箱磁贴范例 .

成员函数文档编制

QDrag:: QDrag ( QObject * dragSource )

为小部件构造新的拖拽对象指定通过 dragSource .

QDrag:: ~QDrag ()

销毁拖曳对象。

[signal] void QDrag:: actionChanged ( Qt::DropAction action )

此信号被发射当 action 关联的拖拽改变。

另请参阅 targetChanged ().

[static] void QDrag:: cancel ()

取消由 Qt 初始的拖拽操作。

注意: 目前这在 Windows 和 X11 上有实现。

该函数在 Qt 5.7 引入。

另请参阅 exec ().

Qt::DropAction QDrag:: defaultAction () const

返回此拖曳操作的默认提议拖曳动作。

另请参阅 exec () 和 supportedActions ().

QPixmap QDrag:: dragCursor ( Qt::DropAction action ) const

返回拖曳光标为 action .

该函数在 Qt 5.0 引入。

另请参阅 setDragCursor ().

Qt::DropAction QDrag:: exec ( Qt::DropActions supportedActions = Qt::MoveAction)

Starts the drag and drop operation and returns a value indicating the requested drop action when it is completed. The drop actions that the user can choose from are specified in supportedActions . The default proposed action will be selected among the allowed actions in the following order: Move, Copy and Link.

注意: On Linux and macOS, the drag and drop operation can take some time, but this function does not block the event loop. Other events are still delivered to the application while the operation is performed. On Windows, the Qt event loop is blocked during the operation.

该函数在 Qt 4.3 引入。

另请参阅 cancel ().

Qt::DropAction QDrag:: exec ( Qt::DropActions supportedActions , Qt::DropAction defaultDropAction )

Starts the drag and drop operation and returns a value indicating the requested drop action when it is completed. The drop actions that the user can choose from are specified in supportedActions .

defaultDropAction determines which action will be proposed when the user performs a drag without using modifier keys.

注意: On Linux and macOS, the drag and drop operation can take some time, but this function does not block the event loop. Other events are still delivered to the application while the operation is performed. On Windows, the Qt event loop is blocked during the operation. However, QDrag::exec () on Windows causes processEvents() to be called frequently to keep the GUI responsive. If any loops or operations are called while a drag operation is active, it will block the drag operation.

该函数在 Qt 4.3 引入。

QPoint QDrag:: hotSpot () const

返回相对于光标左上角的热点位置。

另请参阅 setHotSpot ().

QMimeData *QDrag:: mimeData () const

返回由拖曳对象封装的 MIME 数据。

另请参阅 setMimeData ().

QPixmap QDrag:: pixmap () const

返回用于在拖放操作中表示数据的像素图。

另请参阅 setPixmap ().

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

设置拖曳 cursor action . This allows you to override the default native cursors. To revert to using the native cursor for action pass in a null QPixmap as cursor .

action can only be CopyAction, MoveAction or LinkAction. All other values of DropAction are ignored.

另请参阅 dragCursor ().

void QDrag:: setHotSpot (const QPoint & hotspot )

Sets the position of the hot spot relative to the top-left corner of the pixmap used to the point specified by hotspot .

注意: on X11, the pixmap may not be able to keep up with the mouse movements if the hot spot causes the pixmap to be displayed directly under the cursor.

另请参阅 hotSpot ().

void QDrag:: setMimeData ( QMimeData * data )

将要发送数据设为给定 MIME data 。数据的所有权被转移给 QDrag 对象。

另请参阅 mimeData ().

void QDrag:: setPixmap (const QPixmap & pixmap )

pixmap as the pixmap used to represent the data in a drag and drop operation. You can only set a pixmap before the drag is started.

另请参阅 pixmap ().

QObject *QDrag:: source () const

Returns the source of the drag object. This is the widget where the drag and drop operation originated.

Qt::DropActions QDrag:: supportedActions () const

Returns the set of possible drop actions for this drag operation.

另请参阅 exec () 和 defaultAction ().

QObject *QDrag:: target () const

Returns the target of the drag and drop operation. This is the widget where the drag object was dropped.

[signal] void QDrag:: targetChanged ( QObject * newTarget )

This signal is emitted when the target of the drag and drop operation changes, with newTarget the new target.

另请参阅 target () 和 actionChanged ().