<html> <head> <title>Interface XDragSource</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XDragSource-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">datatransfer</a> :: <a href="module-ix.html" class="namechain">dnd</a> :: </p> </td> </tr> <tr> <td class="title">interface XDragSource</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This interface is implemented by a view or window that supports drag operations and will be received as part of a <a href="DragGestureEvent.html">DragGestureEvent</a> through a <a href="XDragGestureListener.html">XDragGestureListener</a>::<a href="XDragGestureListener.html#dragGestureRecognized">dragGestureRecognized()</a> callback. </dd> <dd><p>Differently to Java, the association between view and interface is fixed and can not be changed. Otherwise, the AWT messaging would have to be implemented for any window supporting Drag and Drop operations, which would be a real performance issue.</p> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#isDragImageSupported">isDragImageSupported</a></td> <td class="imsum_right">In order to query if drag image support is available. </td> </tr> <tr> <td class="imsum_left"><a href="#getDefaultCursor">getDefaultCursor</a></td> <td class="imsum_right">To get the default cursor for a specified drag action. </td> </tr> <tr> <td class="imsum_left"><a href="#startDrag">startDrag</a></td> <td class="imsum_right">Starts the drag operation. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="isDragImageSupported" class="membertitle">isDragImageSupported</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isDragImageSupported</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>In order to query if drag image support is available. </dd> <dt><b>Returns</b></dt> <dd>A boolean indicating whether or not drag image support is available on the underlying platform. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDefaultCursor" class="membertitle">getDefaultCursor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getDefaultCursor</b>(</td> <td valign="top">[in] byte</td> <td valign="bottom"> dragAction )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>To get the default cursor for a specified drag action. </dd> <dt><b>Parameter dragAction</b></dt> <dd>A drag action as specified in <a href="DNDConstants.html">DNDConstants</a>. </dd> <dt><b>Returns</b></dt> <dd>The default drag cursor for the specified drag action. <p>The returned value may be used as parameter for the method <a href="XDragSourceContext.html">XDragSourceContext</a>::<a href="XDragSourceContext.html#setCursor">setCursor()</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="startDrag" class="membertitle">startDrag</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>startDrag</b>(</td> <td valign="top">[in] <a href="DragGestureEvent.html">DragGestureEvent</a></td> <td valign="bottom"> trigger,</td> </tr> <tr> <td/><td valign="top">[in] byte</td> <td valign="bottom"> sourceActions,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> cursor,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> image,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../module-ix.html">datatransfer</a>::<a href="../XTransferable.html">XTransferable</a></td> <td valign="bottom"> trans,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XDragSourceListener.html">XDragSourceListener</a></td> <td valign="bottom"> listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Starts the drag operation. </dd> <dd><p>Note: this call does <em>not</em> block until the drag and drop operation ends. If the Drag and Drop system is unable to initiate a drag operation or if the user attempts to start a drag while an existing drag operation is still executing, the action fails immediately. This is indicated by calling <a href="XDragSourceListener.html">XDragSourceListener</a>::<a href="XDragSourceListener.html#dragDropEnd">dragDropEnd()</a> on the parameter listener with a DragSourceDragEvent showing a failure.</p> </dd> <dt><b>Parameter trigger</b></dt> <dd>The <a href="DragGestureEvent.html">DragGestureEvent</a> that initiated the drag. </dd> <dt><b>Parameter sourceActions</b></dt> <dd>The action or actions supported for this transferable as defined in <a href="DNDConstants.html">DNDConstants</a>. </dd> <dt><b>Parameter cursor</b></dt> <dd>The initial drag cursor id or 0 as default. </dd> <dt><b>Parameter image</b></dt> <dd>The initial drag image id or 0 as default. </dd> <dt><b>Parameter trans</b></dt> <dd>The transferable object dragged. </dd> <dt><b>Parameter listener</b></dt> <dd>The <a href="XDragSourceListener.html">XDragSourceListener</a>. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../module-ix.html">datatransfer</a>::<a href="../XTransferable.html">XTransferable</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>