1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_dnd_XDragSource_idl__ 25cdf0e10cSrcweir#define __com_sun_star_datatransfer_dnd_XDragSource_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_dnd_InvalidDNDOperationException_idl__ 28cdf0e10cSrcweir#include <com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_dnd_DragGestureEvent_idl__ 32cdf0e10cSrcweir#include <com/sun/star/datatransfer/dnd/DragGestureEvent.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_datatransfer_XTransferable_idl__ 36cdf0e10cSrcweir#include <com/sun/star/datatransfer/XTransferable.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 40cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweirmodule com { module sun { module star { module datatransfer { module dnd { 46cdf0e10cSrcweir 47cdf0e10cSrcweir published interface XDragSourceListener; 48cdf0e10cSrcweir 49cdf0e10cSrcweir//============================================================================= 50cdf0e10cSrcweir/** This interface is implemented by a view or window that supports drag 51cdf0e10cSrcweir operations and will be received as part of a <type>DragGestureEvent</type> 52cdf0e10cSrcweir through a <member scope="com::sun::star::datatransfer::dnd">XDragGestureListener::dragGestureRecognized()</member> 53cdf0e10cSrcweir callback. 54cdf0e10cSrcweir 55cdf0e10cSrcweir <p>Differently to Java, the association between view and interface is fixed 56cdf0e10cSrcweir and can not be changed. Otherwise, the AWT messaging would have to be 57cdf0e10cSrcweir implemented for any window supporting Drag and Drop operations, which would 58cdf0e10cSrcweir be a real performance issue.</p> 59cdf0e10cSrcweir*/ 60cdf0e10cSrcweir 61cdf0e10cSrcweirpublished interface XDragSource: com::sun::star::uno::XInterface 62cdf0e10cSrcweir{ 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir /** In order to query if drag image support is available. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @returns 68cdf0e10cSrcweir A boolean indicating whether or not drag image support is 69cdf0e10cSrcweir available on the underlying platform. 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir 72cdf0e10cSrcweir boolean isDragImageSupported(); 73cdf0e10cSrcweir 74cdf0e10cSrcweir //------------------------------------------------------------------------- 75cdf0e10cSrcweir /** To get the default cursor for a specified drag action. 76cdf0e10cSrcweir 77cdf0e10cSrcweir @param dragAction 78cdf0e10cSrcweir A drag action as specified in <type>DNDConstants</type>. 79cdf0e10cSrcweir 80cdf0e10cSrcweir @returns 81cdf0e10cSrcweir The default drag cursor for the specified drag action. 82cdf0e10cSrcweir <p>The returned value may be used as parameter for the method 83cdf0e10cSrcweir <member scope="com::sun::star::datatransfer::dnd">XDragSourceContext::setCursor()</member>.</p> 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir 86cdf0e10cSrcweir long getDefaultCursor( [in] byte dragAction ) 87cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir /** Starts the drag operation. 91cdf0e10cSrcweir 92cdf0e10cSrcweir <p>Note: this call does <em>not</em> block until the drag and drop 93cdf0e10cSrcweir operation ends. If the Drag and Drop system is unable to initiate 94cdf0e10cSrcweir a drag operation or if the user attempts to start a drag while an 95cdf0e10cSrcweir existing drag operation is still executing, the action fails immediately. 96cdf0e10cSrcweir This is indicated by calling 97cdf0e10cSrcweir <member scope="com::sun::star::datatransfer::dnd">XDragSourceListener::dragDropEnd()</member> 98cdf0e10cSrcweir on the parameter listener with a DragSourceDragEvent showing a failure.</p> 99cdf0e10cSrcweir 100cdf0e10cSrcweir @param trigger 101cdf0e10cSrcweir The <type>DragGestureEvent</type> that initiated the drag. 102cdf0e10cSrcweir 103cdf0e10cSrcweir @param sourceActions 104cdf0e10cSrcweir The action or actions supported for this transferable as defined 105cdf0e10cSrcweir in <type>DNDConstants</type>. 106cdf0e10cSrcweir 107cdf0e10cSrcweir @param cursor 108cdf0e10cSrcweir The initial drag cursor id or 0 as default. 109cdf0e10cSrcweir 110cdf0e10cSrcweir @param image 111cdf0e10cSrcweir The initial drag image id or 0 as default. 112cdf0e10cSrcweir 113cdf0e10cSrcweir @param trans 114cdf0e10cSrcweir The transferable object dragged. 115cdf0e10cSrcweir 116cdf0e10cSrcweir @param listener 117cdf0e10cSrcweir The <type>XDragSourceListener</type>. 118cdf0e10cSrcweir 119cdf0e10cSrcweir @see com::sun::star::datatransfer::XTransferable 120cdf0e10cSrcweir */ 121cdf0e10cSrcweir 122cdf0e10cSrcweir [oneway] void startDrag( 123cdf0e10cSrcweir [in] DragGestureEvent trigger, 124cdf0e10cSrcweir [in] byte sourceActions, 125cdf0e10cSrcweir [in] long cursor, 126cdf0e10cSrcweir [in] long image, 127cdf0e10cSrcweir [in] com::sun::star::datatransfer::XTransferable trans, 128cdf0e10cSrcweir [in] XDragSourceListener listener ); 129cdf0e10cSrcweir}; 130cdf0e10cSrcweir 131cdf0e10cSrcweir//============================================================================= 132cdf0e10cSrcweir 133cdf0e10cSrcweir}; }; }; }; }; 134cdf0e10cSrcweir 135cdf0e10cSrcweir#endif 136