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_XDragSourceContext_idl__
25#define __com_sun_star_datatransfer_dnd_XDragSourceContext_idl__
26
27#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
28#include <com/sun/star/lang/IllegalArgumentException.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module datatransfer { module dnd {
34
35 published interface XDragSourceListener;
36
37//=============================================================================
38/** The drag source context class is responsible for managing the initiator side
39	of the Drag and Drop protocol.
40
41	<p>In particular, it is responsible for managing event notifications to the
42	DragSourceListener and providing the Transferable state to enable the data
43	transfer. </p>
44
45	<p>An instance of this class is created as a result of the method <member>XDragSource::startDrag()</member>
46	being successfully invoked. This instance is responsible
47	for tracking the state of the operation on behalf of the drag source and
48	dispatching state changes to the drag source listener. </p>
49
50	@see com::sun::star::datatransfer::dnd::XDragSourceContext
51	@see com::sun::star::datatransfer::dnd::XDragSourceListener
52*/
53
54published interface XDragSourceContext: com::sun::star::uno::XInterface
55{
56	//-------------------------------------------------------------------------
57	/** Get the identifier of the currently used cursor.
58
59		@returns
60		The currently selected drag cursor.
61	*/
62
63	long getCurrentCursor();
64
65	//-------------------------------------------------------------------------
66	/** This method sets the current drag cursor.
67
68		<p>This method should only be called to set another cursor than the
69		default one for drag action currently selected by the user.</p>
70		<p>Invalid cursor identifiers will be ignored.</p>
71
72		@param cursorId
73		The identifier the drag source returned when registering the cursor.
74	*/
75
76	[oneway] void setCursor( [in] long cursorId );
77
78	//-------------------------------------------------------------------------
79	/** This method sets the current drag image.
80
81		@param dragImage
82		The identifier the drag source returned when registering the image (0 = none).
83		Invalid identifier will be ignored.
84	*/
85
86	[oneway] void setImage( [in] long imageId );
87
88	//-------------------------------------------------------------------------
89	/** This method notifies the context that the
90		<type scope="com::sun::star::datatransfer">DataFlavor</type> types
91		of the transferable object have changed.
92
93		@see com::sun::star::datatransfer::XTransferable
94	*/
95
96	[oneway] void transferablesFlavorsChanged();
97};
98
99//=============================================================================
100
101}; }; }; }; };
102
103#endif
104