TQDropEvent Class

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

# TQDropEvent Class Reference

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

`#include <tqevent.h>`

Inherits TQEvent and TQMimeSource.

Inherited by TQDragMoveEvent.

List of all member functions.

## Public Members

- TQDropEvent ( const TQPoint & pos, Type typ = Drop )
- const TQPoint & pos () const
- bool isAccepted () const
- void accept ( bool y = true )
- void ignore ()
- bool isActionAccepted () const
- void acceptAction ( bool y = true )
- enum Action { Copy, Link, Move, Private, UserAction = 100 }
- void setAction ( Action a )
- Action action () const
- TQWidget * source () const
- virtual const char * format ( int n = 0 ) const
- virtual TQByteArray encodedData ( const char * format ) const
- virtual bool provides ( const char * mimeType ) const
- TQByteArray data ( const char * f ) const (obsolete)
- void setPoint ( const TQPoint & np )

## Detailed Description

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

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

The widget should use data() to extract the data in an appropriate format.

See also Drag And Drop Classes and Event Classes.

## Member Type Documentation

### TQDropEvent::Action

This enum describes the action which a source requests that a target perform with dropped data.

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

## Member Function Documentation

### TQDropEvent::TQDropEvent ( const TQPoint & pos, Type typ = Drop )

Constructs a drop event that drops a drop of type typ on point pos.

### void TQDropEvent::accept ( bool y = true )

Call this function to indicate whether the event provided data which 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 TQDragObject subclasses, such as TQTextDrag::decode(), or your own subclasses.

See also acceptAction().

Example: iconview/simple_dd/main.cpp.

### void TQDropEvent::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).

Examples: dirview/dirview.cpp and fileiconview/tqfileiconview.cpp.

### Action TQDropEvent::action () const

Returns the Action which the target is requesting to be performed with 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().

Examples: dirview/dirview.cpp and fileiconview/tqfileiconview.cpp.

### TQByteArray TQDropEvent::data ( const char * f ) const

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

Use TQDropEvent::encodedData().

### TQByteArray TQDropEvent::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 format.

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

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

Reimplemented from TQMimeSource.

### const char * TQDropEvent::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().

See also data() and provides().

Example: iconview/main.cpp.

Reimplemented from TQMimeSource.

### void TQDropEvent::ignore ()

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

Example: fileiconview/tqfileiconview.cpp.

### bool TQDropEvent::isAccepted () const

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

### bool TQDropEvent::isActionAccepted () const

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

### const TQPoint & TQDropEvent::pos () const

Returns the position where the drop was made.

Example: dirview/dirview.cpp.

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

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

See also data().

Example: fileiconview/tqfileiconview.cpp.

Reimplemented from TQMimeSource.

### void TQDropEvent::setAction ( Action a )

Sets the action to a. This is used internally, you should not need to call this in your code: the source decides the action, not the target.

### void TQDropEvent::setPoint ( const TQPoint & np )

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

### TQWidget * TQDropEvent::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, etc.

See TQDragObject::TQDragObject() and subclasses.

This file is part of the TQt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.