Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QDropEvent Class Reference

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

    #include <QDropEvent>

Inherits QEvent and QMimeSource.

Inherited by QDragMoveEvent.

- List of all members, including inherited members
- Obsolete members

### Public Types

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

### Public Functions

- QDropEvent ( const QPoint & point, Type type = Drop )
- void accept ( bool y = TRUE )
- void acceptAction ( bool y = TRUE )
- Action action () const
- virtual QByteArray encodedData ( const char * format ) const
- virtual const char * format ( int n = 0 ) const
- void ignore ()
- bool isAccepted () const
- bool isActionAccepted () const
- const QPoint & pos () const
- virtual bool provides ( const char * mimeType ) const
- void setAction ( Action action )
- void setPoint ( const QPoint & point )
- QWidget * source () const

- 2 public functions inherited from QEvent
- 4 public functions inherited from QMimeSource

## 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 widget should use data() to extract the data in an appropriate format.

## 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::Copy` | The default action. The source simply uses the data provided in the operation.
`QDropEvent::Link` | The source should somehow create a link to the location specified by the data.
`QDropEvent::Move` | The source should somehow move the object from the location specified by the data to a new location.
`QDropEvent::Private` | The target has special knowledge of the MIME type, which the source should respond to in a similar way to a Copy.
`QDropEvent::UserAction` | The 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

### QDropEvent::QDropEvent ( const QPoint & point, Type type = Drop )

Constructs a drop event of a certain type corresponding to a drop at the given point in a widget.

### void QDropEvent::accept ( bool y = TRUE )

Call this function to indicate whether the event provided data that your widget processed. Set y to true (the default) if your widget could process the data, otherwise set y to false. To get the data, use encodedData(), or preferably, the decode() methods of existing QDragObject subclasses, such as QTextDrag::decode(), or your own subclasses.

See also acceptAction().

### void QDropEvent::acceptAction ( bool y = TRUE )

Call this to indicate that the action described by action() is accepted (i.e. if y 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

Returns the Action that the target is expected to perform on the data. If your application understands the action and can process the supplied data, call acceptAction(); if your application can process the supplied data but can only perform the Copy action, call accept().

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

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.

Reimplemented from QMimeSource.

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

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

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().

Reimplemented from QMimeSource.

See also data() and provides().

### void QDropEvent::ignore ()

The opposite of accept(); i.e. you have ignored the drop event.

### bool QDropEvent::isAccepted () const

Returns true if the drop target accepts the event; otherwise returns false.

### bool QDropEvent::isActionAccepted () const

Returns true if the drop action was accepted by the drop site; otherwise returns false.

### const QPoint & QDropEvent::pos () const

Returns the position where the drop was made.

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

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

Reimplemented from QMimeSource.

See also data().

### void QDropEvent::setAction ( Action action )

Sets the action to be performed on the data by the target. This is used internally, you should not need to call this in your code: the source decides the action, not the target.

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

### QWidget * QDropEvent::source () const

If the source of the drag operation is a widget in this application, this function returns that source; otherwise it returns 0. The source of the operation is the first parameter to drag object subclasses.

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

See QDragObject::QDragObject() and subclasses.