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_XDropTargetDropContext_idl__
25#define __com_sun_star_datatransfer_dnd_XDropTargetDropContext_idl__
26
27#ifndef __com_sun_star_datatransfer_dnd_InvalidDNDOperationException_idl__
28#include <com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl>
29#endif
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module datatransfer { module dnd {
38
39//=============================================================================
40/** This interface is implemented by any drop target context object.
41
42	<p>A DropTargetContext is created whenever the logical cursor associated
43	with a Drag and Drop operation moves within the visible geometry of a
44	window associated with a DropTarget. </p>
45
46	<p>The drop target context provides the mechanism for a potential receiver
47	of a drop operation to provide the end user with the appropriate drag
48	under feedback and to effect the subsequent data transfer, if appropriate. </p>
49*/
50
51published interface XDropTargetDropContext : com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54	/** Accept the Drop.
55
56		<p>This method should be called from the
57		<member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::drop()</member>
58		method if the implementation wishes to accept the drop operation with the specified action.</p>
59
60		@param dragOperation
61		The operation accepted by the target.
62
63		@see DNDConstants
64		@see DropTargetDragEvent
65	*/
66
67	[oneway] void acceptDrop( [in] byte dragOperation );
68
69	//-------------------------------------------------------------------------
70	/** Reject the drop as a result of examining the available
71		<type scope="com::sun::star::datatransfer">DataFlavor</type> types
72		received in the <member>XDropTargetListener::dragEnter()</member> method.
73	*/
74
75	[oneway] void rejectDrop();
76
77	//-------------------------------------------------------------------------
78	/** Signals that the drop is completed and if it was successful or not.
79
80		@param success
81		A value of <TRUE/> means the drop completed successfully
82		<p>A value of <FALSE/> means the drop completed unsuccessfully.</p>
83	*/
84
85	[oneway] void dropComplete( [in] boolean success );
86};
87
88//=============================================================================
89
90}; }; }; }; };
91
92#endif
93