Compatibility Members for QDropEvent

The following members of class QDropEventare part of the Qt compatibility layer. We advise against using them in new code.

Public Types

enum Action { Copy, Link, Move, Private, UserAction }

Public Functions

void accept(bool accept)
void acceptAction(bool accept = true)
Action action() const
virtual QByteArray encodedData(const char * format) const
virtual const char * format(int n = 0) const
virtual bool provides(const char * mimeType) const
void setPoint(const QPoint & point)

Member Type Documentation

enum QDropEvent::Action

When a drag and drop action is completed, the target is expected to perform an action on the data provided by the source. This will be one of the following:

QDropEvent::Copy0The default action. The source simply uses the data provided in the operation.
QDropEvent::Link1The source should somehow create a link to the location specified by the data.
QDropEvent::Move2The source should somehow move the object from the location specified by the data to a new location.
QDropEvent::Private3The target has special knowledge of the MIME type, which the source should respond to in a similar way to a Copy.
QDropEvent::UserActionPrivateThe source and target can co-operate using special actions. This feature is not currently supported.

The Link and Move actions only makes sense if the data is a reference, for example, text/uri-list file lists (see QUriDrag).

Member Function Documentation

void QDropEvent::accept(bool accept)

Call setAccepted(accept) instead.

void QDropEvent::acceptAction(bool accept = true)

Call this to indicate that the action described by action() is accepted (i.e. if accept is true, which is the default), not merely the default copy action. If you call acceptAction(true), there is no need to also call accept(true).

Action QDropEvent::action() const

Use dropAction() instead.

The table below shows the correspondance between the return type of action() and the return type of dropAction().

[virtual] QByteArray QDropEvent::encodedData(const char * format) const

Reimplemented from QMimeSource::encodedData().

Returns a byte array containing the drag's data, in format.

data() normally needs to get the data from the drag source, which is potentially very slow, so it's advisable to call this function only if you're sure that you will need the data in that particular format.

The resulting data will have a size of 0 if the format was not available.

See also format() and QByteArray::size().

[virtual] const char * QDropEvent::format(int n = 0) const

Reimplemented from QMimeSource::format().

Returns a string describing one of the available data types for this drag. Common examples are "text/plain" and "image/gif". If n is less than zero or greater than the number of available data types, format() returns 0.

This function is provided mainly for debugging. Most drop targets will use provides().

See also data() and provides().

[virtual] bool QDropEvent::provides(const char * mimeType) const

Reimplemented from QMimeSource::provides().

Returns true if this event provides format mimeType; otherwise returns false.

See also data().

void QDropEvent::setPoint(const QPoint & point)

Sets the drop to happen at the given point. You do not normally need to use this as it will be set internally before your widget receives the drop event.

© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.