1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_datatransfer_dnd_XDropTargetDropContext_idl__
29#define __com_sun_star_datatransfer_dnd_XDropTargetDropContext_idl__
30
31#ifndef __com_sun_star_datatransfer_dnd_InvalidDNDOperationException_idl__
32#include <com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl>
33#endif
34
35#ifndef __com_sun_star_uno_XInterface_idl__
36#include <com/sun/star/uno/XInterface.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module datatransfer { module dnd {
42
43//=============================================================================
44/** This interface is implemented by any drop target context object.
45
46	<p>A DropTargetContext is created whenever the logical cursor associated
47	with a Drag and Drop operation moves within the visible geometry of a
48	window associated with a DropTarget. </p>
49
50	<p>The drop target context provides the mechanism for a potential receiver
51	of a drop operation to provide the end user with the appropriate drag
52	under feedback and to effect the subsequent data transfer, if appropriate. </p>
53*/
54
55published interface XDropTargetDropContext : com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58	/** Accept the Drop.
59
60		<p>This method should be called from the
61		<member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::drop()</member>
62		method if the implementation wishes to accept the drop operation with the specified action.</p>
63
64		@param dragOperation
65		The operation accepted by the target.
66
67		@see DNDConstants
68		@see DropTargetDragEvent
69	*/
70
71	[oneway] void acceptDrop( [in] byte dragOperation );
72
73	//-------------------------------------------------------------------------
74	/** Reject the drop as a result of examining the available
75		<type scope="com::sun::star::datatransfer">DataFlavor</type> types
76		received in the <member>XDropTargetListener::dragEnter()</member> method.
77	*/
78
79	[oneway] void rejectDrop();
80
81	//-------------------------------------------------------------------------
82	/** Signals that the drop is completed and if it was successful or not.
83
84		@param success
85		A value of <TRUE/> means the drop completed successfully
86		<p>A value of <FALSE/> means the drop completed unsuccessfully.</p>
87	*/
88
89	[oneway] void dropComplete( [in] boolean success );
90};
91
92//=============================================================================
93
94}; }; }; }; };
95
96#endif
97