1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_datatransfer_dnd_XDropTargetListener_idl__
25#define __com_sun_star_datatransfer_dnd_XDropTargetListener_idl__
26
27#ifndef __com_sun_star_datatransfer_dnd_DropTargetDragEnterEvent_idl__
28#include <com/sun/star/datatransfer/dnd/DropTargetDragEnterEvent.idl>
29#endif
30
31#ifndef __com_sun_star_datatransfer_dnd_DropTargetDropEvent_idl__
32#include <com/sun/star/datatransfer/dnd/DropTargetDropEvent.idl>
33#endif
34
35#ifndef __com_sun_star_lang_XEventListener_idl__
36#include <com/sun/star/lang/XEventListener.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module datatransfer { module dnd {
42
43//=============================================================================
44/** This interface is the callback interface used by the drop target object to
45	provide notification of Drag and Drop operations that involve the subject
46	drop target.
47
48	<p>Methods of this interface may be implemented to provide "drag under"
49	visual feedback to the user throughout the Drag and Drop operation.</p>
50*/
51
52published interface XDropTargetListener: com::sun::star::lang::XEventListener
53{
54	//-------------------------------------------------------------------------
55	/** The drag operation has terminated with a drop on this drop target.
56
57		<p><strong>NOTE:</strong> This method should not be oneway. The implentation
58		has to wait until the method <method>XDropTargetDropContext::dropComplete</method>
59		is called before releasing the data for the drop operation. This
60		should occur before returning from drop in a normal flow of operation.
61		Also, the implementor of <type>XDropTargetListener</type> should not assume
62		the <type>DropTargetDropEvent</type> to be meaningful after returning
63		from the <member>XDropTargetListener::drop()</member> method.</p>
64
65		@param dtde
66		The <type>DropTargetDropEvent</type>.
67	*/
68
69	void drop( [in] DropTargetDropEvent dtde );
70
71  	//-------------------------------------------------------------------------
72	/** Called when a drag operation has encountered the drop target.
73
74		@param dtde
75		The <type>DropTargetDragEvent</type>.
76	*/
77
78	[oneway] void dragEnter( [in] DropTargetDragEnterEvent dtdee );
79
80  	//-------------------------------------------------------------------------
81	/** The drag operation has departed the drop target without dropping.
82
83		@param dte
84		The <type>DropTargetEvent</type>.
85	*/
86
87	[oneway] void dragExit( [in] DropTargetEvent dte );
88
89  	//-------------------------------------------------------------------------
90	/** Called when a drag operation is ongoing on the drop target.
91
92		@param dtde
93		The <type>DropTargetEvent</type>.
94	*/
95
96	[oneway] void dragOver( [in] DropTargetDragEvent dtde );
97
98  	//-------------------------------------------------------------------------
99	/** Called when the user has modified the drop gesture.
100
101		@param dtde
102		The <type>DropTargetEvent</type>.
103	*/
104
105	[oneway] void dropActionChanged( [in] DropTargetDragEvent dtde );
106};
107
108//=============================================================================
109
110}; }; }; }; };
111
112#endif
113