<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qevent.cpp -->
<title>Qt 4.8: QDropEvent Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QDropEvent</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDropEvent Class Reference</h1>
<!-- $$$QDropEvent-brief -->
<p>The QDropEvent class provides an event which is sent when a drag and drop action is completed. <a href="#details">More...</a></p>
<!-- @@@QDropEvent -->
<pre class="cpp"> <span class="preprocessor">#include <QDropEvent></span></pre><p><b>Inherits: </b><a href="qevent.html">QEvent</a> and <a href="qmimesource.html" class="obsolete">QMimeSource</a>.</p>
<p><b>Inherited by: </b><a href="qdragmoveevent.html">QDragMoveEvent</a>.</p>
<ul>
<li><a href="qdropevent-members.html">List of all members, including inherited members</a></li>
<li><a href="qdropevent-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#QDropEvent">QDropEvent</a></b> ( const QPoint & <i>pos</i>, Qt::DropActions <i>actions</i>, const QMimeData * <i>data</i>, Qt::MouseButtons <i>buttons</i>, Qt::KeyboardModifiers <i>modifiers</i>, Type <i>type</i> = Drop )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#acceptProposedAction">acceptProposedAction</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::DropAction </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#dropAction">dropAction</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::KeyboardModifiers </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#keyboardModifiers">keyboardModifiers</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMimeData * </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#mimeData">mimeData</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::MouseButtons </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#mouseButtons">mouseButtons</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint & </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#pos">pos</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::DropActions </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#possibleActions">possibleActions</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::DropAction </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#proposedAction">proposedAction</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#setDropAction">setDropAction</a></b> ( Qt::DropAction <i>action</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWidget * </td><td class="memItemRight bottomAlign"><b><a href="qdropevent.html#source">source</a></b> () const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qdropevent-qt3.html#encodedData">encodedData</a></b> ( const char * <i>format</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual const char * </td><td class="memItemRight bottomAlign"><b><a href="qdropevent-qt3.html#format">format</a></b> ( int <i>n</i> = 0 ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qdropevent-qt3.html#provides">provides</a></b> ( const char * <i>mimeType</i> ) const</td></tr>
</table>
<ul>
<li class="fn">6 public functions inherited from <a href="qevent.html#public-functions">QEvent</a></li>
<li class="fn">3 public functions inherited from <a href="qmimesource.html#public-functions">QMimeSource</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qevent.html#properties">QEvent</a></li>
<li class="fn">1 static public member inherited from <a href="qevent.html#static-public-members">QEvent</a></li>
</ul>
<a name="details"></a>
<!-- $$$QDropEvent-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDropEvent class provides an event which is sent when a drag and drop action is completed.</p>
<p>When a widget <a href="qwidget.html#acceptDrops-prop">accepts drop events</a>, it will receive this event if it has accepted the most recent <a href="qdragenterevent.html">QDragEnterEvent</a> or <a href="qdragmoveevent.html">QDragMoveEvent</a> sent to it.</p>
<p>The drop event contains a proposed action, available from <a href="qdropevent.html#proposedAction">proposedAction</a>(), for the widget to either accept or ignore. If the action can be handled by the widget, you should call the <a href="qdropevent.html#acceptProposedAction">acceptProposedAction</a>() function. Since the proposed action can be a combination of <a href="qt.html#DropAction-enum">Qt::DropAction</a> 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.</p>
<p>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 <a href="qdropevent.html#possibleActions">possible drop actions</a> by calling <a href="qdropevent.html#setDropAction">setDropAction</a>() with your preferred action. If you set a value that is not present in the bitwise OR combination of values returned by <a href="qdropevent.html#possibleActions">possibleActions</a>(), the default copy action will be used. Once a replacement drop action has been set, call accept() instead of <a href="qdropevent.html#acceptProposedAction">acceptProposedAction</a>() to complete the drop operation.</p>
<p>The <a href="qdropevent.html#mimeData">mimeData</a>() function provides the data dropped on the widget in a <a href="qmimedata.html">QMimeData</a> object. This contains information about the MIME type of the data in addition to the data itself.</p>
</div>
<p><b>See also </b><a href="qmimedata.html">QMimeData</a>, <a href="qdrag.html">QDrag</a>, and <a href="dnd.html">Drag and Drop</a>.</p>
<!-- @@@QDropEvent -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDropEvent[overload1]$$$QDropEventconstQPoint&Qt::DropActionsconstQMimeData*Qt::MouseButtonsQt::KeyboardModifiersType -->
<h3 class="fn"><a name="QDropEvent"></a>QDropEvent::<span class="name">QDropEvent</span> ( const <span class="type"><a href="qpoint.html">QPoint</a></span> & <i>pos</i>, <span class="type"><a href="qt.html#DropAction-enum">Qt::DropActions</a></span> <i>actions</i>, const <span class="type"><a href="qmimedata.html">QMimeData</a></span> * <i>data</i>, <span class="type"><a href="qt.html#MouseButton-enum">Qt::MouseButtons</a></span> <i>buttons</i>, <span class="type"><a href="qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> <i>modifiers</i>, <span class="type"><a href="qevent.html#Type-enum">Type</a></span> <i>type</i> = Drop )</h3>
<p>Constructs a drop event of a certain <i>type</i> corresponding to a drop at the point specified by <i>pos</i> in the destination widget's coordinate system.</p>
<p>The <i>actions</i> indicate which types of drag and drop operation can be performed, and the drag data is stored as MIME-encoded data in <i>data</i>.</p>
<p>The states of the mouse buttons and keyboard modifiers at the time of the drop are specified by <i>buttons</i> and <i>modifiers</i>.</p>
<!-- @@@QDropEvent -->
<!-- $$$acceptProposedAction[overload1]$$$acceptProposedAction -->
<h3 class="fn"><a name="acceptProposedAction"></a><span class="type">void</span> QDropEvent::<span class="name">acceptProposedAction</span> ()</h3>
<p>Sets the drop action to be the proposed action.</p>
<p><b>See also </b><a href="qdropevent.html#setDropAction">setDropAction</a>(), <a href="qdropevent.html#proposedAction">proposedAction</a>(), and <a href="qevent.html#accept">accept</a>().</p>
<!-- @@@acceptProposedAction -->
<!-- $$$dropAction[overload1]$$$dropAction -->
<h3 class="fn"><a name="dropAction"></a><span class="type"><a href="qt.html#DropAction-enum">Qt::DropAction</a></span> QDropEvent::<span class="name">dropAction</span> () const</h3>
<p>Returns the action to be performed on the data by the target. This may be different from the action supplied in <a href="qdropevent.html#proposedAction">proposedAction</a>() if you have called <a href="qdropevent.html#setDropAction">setDropAction</a>() to explicitly choose a drop action.</p>
<p><b>See also </b><a href="qdropevent.html#setDropAction">setDropAction</a>().</p>
<!-- @@@dropAction -->
<!-- $$$keyboardModifiers[overload1]$$$keyboardModifiers -->
<h3 class="fn"><a name="keyboardModifiers"></a><span class="type"><a href="qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> QDropEvent::<span class="name">keyboardModifiers</span> () const</h3>
<p>Returns the modifier keys that are pressed.</p>
<!-- @@@keyboardModifiers -->
<!-- $$$mimeData[overload1]$$$mimeData -->
<h3 class="fn"><a name="mimeData"></a>const <span class="type"><a href="qmimedata.html">QMimeData</a></span> * QDropEvent::<span class="name">mimeData</span> () const</h3>
<p>Returns the data that was dropped on the widget and its associated MIME type information.</p>
<!-- @@@mimeData -->
<!-- $$$mouseButtons[overload1]$$$mouseButtons -->
<h3 class="fn"><a name="mouseButtons"></a><span class="type"><a href="qt.html#MouseButton-enum">Qt::MouseButtons</a></span> QDropEvent::<span class="name">mouseButtons</span> () const</h3>
<p>Returns the mouse buttons that are pressed..</p>
<!-- @@@mouseButtons -->
<!-- $$$pos[overload1]$$$pos -->
<h3 class="fn"><a name="pos"></a>const <span class="type"><a href="qpoint.html">QPoint</a></span> & QDropEvent::<span class="name">pos</span> () const</h3>
<p>Returns the position where the drop was made.</p>
<!-- @@@pos -->
<!-- $$$possibleActions[overload1]$$$possibleActions -->
<h3 class="fn"><a name="possibleActions"></a><span class="type"><a href="qt.html#DropAction-enum">Qt::DropActions</a></span> QDropEvent::<span class="name">possibleActions</span> () const</h3>
<p>Returns an OR-combination of possible drop actions.</p>
<p><b>See also </b><a href="qdropevent.html#dropAction">dropAction</a>().</p>
<!-- @@@possibleActions -->
<!-- $$$proposedAction[overload1]$$$proposedAction -->
<h3 class="fn"><a name="proposedAction"></a><span class="type"><a href="qt.html#DropAction-enum">Qt::DropAction</a></span> QDropEvent::<span class="name">proposedAction</span> () const</h3>
<p>Returns the proposed drop action.</p>
<p><b>See also </b><a href="qdropevent.html#dropAction">dropAction</a>().</p>
<!-- @@@proposedAction -->
<!-- $$$setDropAction[overload1]$$$setDropActionQt::DropAction -->
<h3 class="fn"><a name="setDropAction"></a><span class="type">void</span> QDropEvent::<span class="name">setDropAction</span> ( <span class="type"><a href="qt.html#DropAction-enum">Qt::DropAction</a></span> <i>action</i> )</h3>
<p>Sets the <i>action</i> to be performed on the data by the target. Use this to override the <a href="qdropevent.html#proposedAction">proposed action</a> with one of the <a href="qdropevent.html#possibleActions">possible actions</a>.</p>
<p>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.</p>
<p>Once you have supplied a replacement drop action, call accept() instead of <a href="qdropevent.html#acceptProposedAction">acceptProposedAction</a>().</p>
<p><b>See also </b><a href="qdropevent.html#dropAction">dropAction</a>().</p>
<!-- @@@setDropAction -->
<!-- $$$source[overload1]$$$source -->
<h3 class="fn"><a name="source"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * QDropEvent::<span class="name">source</span> () const</h3>
<p>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 the <a href="qdrag.html">QDrag</a> object used instantiate the drag.</p>
<p>This is useful if your widget needs special behavior when dragging to itself.</p>
<p><b>See also </b><a href="qdrag.html#QDrag">QDrag::QDrag</a>().</p>
<!-- @@@source -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
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. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
