CopperSpice API  1.9.1
Public Methods | Friends | List of all members
QDropEvent Class Reference
CsGui | Drag and Drop | Event Classes

The QDropEvent class provides an event which is sent when a drag and drop action is completed. More...

Inheritance diagram for QDropEvent:
QEvent QDragMoveEvent QDragEnterEvent

Public Methods

 QDropEvent (const QPointF &pos, Qt::DropActions actions, const QMimeData *data, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Type type=Drop)
 
void acceptProposedAction ()
 
Qt::DropAction dropAction () const
 
Qt::KeyboardModifiers keyboardModifiers () const
 
const QMimeData * mimeData () const
 
Qt::MouseButtons mouseButtons () const
 
QPoint pos () const
 
const QPointF & posF () const
 
Qt::DropActions possibleActions () const
 
Qt::DropAction proposedAction () const
 
void setDropAction (Qt::DropAction action)
 
QObject * source () const
 
- Public Methods inherited from QEvent
 QEvent (const QEvent &other)
 
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
QEvent & operator= (const QEvent &other)
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Friends

class QApplication
 

Additional Inherited Members

- Public Types inherited from QEvent
enum  Type
 
- Static Public Methods inherited from QEvent
static int registerEventType (int hint=-1)
 

Detailed Description

The QDropEvent class provides an event which is sent when a drag and drop action is completed.

When a widget accepts drop events, it will receive this event if it has accepted the most recent QDragEnterEvent or QDragMoveEvent sent to it.

The drop event contains a proposed action, available from proposedAction(), for the widget to either accept or ignore. If the action can be handled by the widget, you should call the acceptProposedAction() function. Since the proposed action can be a combination of Qt::DropAction values, it may be useful to either select one of these values as a default action or ask the user to select their preferred action.

If the proposed drop action is not suitable, perhaps because your custom widget does not support that action, you can replace it with any of the possible drop actions by calling setDropAction() with your preferred action. If you set a value that is not present in the bitwise OR combination of values returned by possibleActions(), the default copy action will be used. Once a replacement drop action has been set, call accept() instead of acceptProposedAction() to complete the drop operation.

The mimeData() method provides the data dropped on the widget in a QMimeData object. This contains information about the MIME type of the data in addition to the data itself.

See also
QMimeData, QDrag, Drag and Drop

Constructor & Destructor Documentation

QDropEvent::QDropEvent ( const QPointF &  pos,
Qt::DropActions  actions,
const QMimeData *  data,
Qt::MouseButtons  buttons,
Qt::KeyboardModifiers  modifiers,
Type  type = Drop 
)

Constructs a drop event of a certain type corresponding to a drop at the point specified by pos in the destination widget's coordinate system.

The actions indicate which types of drag and drop operation can be performed, and the drag data is stored as MIME-encoded data in data.

The states of the mouse buttons and keyboard modifiers at the time of the drop are specified by buttons and modifiers.

Method Documentation

void QDropEvent::acceptProposedAction ( )
inline

Sets the drop action to be the proposed action.

See also
setDropAction(), proposedAction(), accept()
Qt::DropAction QDropEvent::dropAction ( ) const
inline

Returns the action to be performed on the data by the target. This may be different from the action supplied in proposedAction() if you have called setDropAction() to explicitly choose a drop action.

See also
setDropAction()
Qt::KeyboardModifiers QDropEvent::keyboardModifiers ( ) const
inline

Returns the modifier keys that are pressed.

const QMimeData * QDropEvent::mimeData ( ) const
inline

Returns the data that was dropped on the widget and its associated MIME type information.

Qt::MouseButtons QDropEvent::mouseButtons ( ) const
inline

Returns the mouse buttons that are pressed.

QPoint QDropEvent::pos ( ) const
inline

Returns the position where the drop was made.

const QPointF & QDropEvent::posF ( ) const
inline

Returns the position where the drop was made.

Qt::DropActions QDropEvent::possibleActions ( ) const
inline

Returns an OR-combination of possible drop actions.

See also
dropAction()
Qt::DropAction QDropEvent::proposedAction ( ) const
inline

Returns the proposed drop action.

See also
dropAction()
void QDropEvent::setDropAction ( Qt::DropAction  action)

Sets the action to be performed on the data by the target. Use this to override the proposed action with one of the possible actions.

If you set a drop action that is not one of the possible actions, the drag and drop operation will default to a copy operation.

Once you have supplied a replacement drop action, call accept() instead of acceptProposedAction().

See also
dropAction()
QObject * QDropEvent::source ( ) const

If the source of the drag operation is a widget in this application, this function returns that source, otherwise it returns a nullptr. The source of the operation is the first parameter to the QDrag object used instantiate the drag.

This is useful if your widget needs special behavior when dragging to itself.

See also
QDrag::QDrag()