xref: /AOO41X/main/offapi/com/sun/star/datatransfer/dnd/XDragSourceListener.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_XDragSourceListener_idl__
25#define __com_sun_star_datatransfer_dnd_XDragSourceListener_idl__
26
27#ifndef __com_sun_star_datatransfer_dnd_DragSourceDragEvent_idl__
28#include <com/sun/star/datatransfer/dnd/DragSourceDragEvent.idl>
29#endif
30
31#ifndef __com_sun_star_datatransfer_dnd_DragSourceDropEvent_idl__
32#include <com/sun/star/datatransfer/dnd/DragSourceDropEvent.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 must be implemented by any drag gesture recognizer
45    implementation that a drag source supports.
46
47    @see com::sun::star::datatransfer::dnd::XDragGestureRecognizer
48    @see com::sun::star::datatransfer::dnd::XDragSource
49*/
50
51published interface XDragSourceListener: com::sun::star::lang::XEventListener
52{
53    //-------------------------------------------------------------------------
54    /** This method is invoked to signify that the Drag and Drop operation is
55        complete.
56
57        @param dsde
58        The <type>DragSourceDropEvent</type>
59    */
60
61    [oneway] void dragDropEnd( [in] DragSourceDropEvent dsde );
62
63    //-------------------------------------------------------------------------
64    /** Called as the hotspot enters a platform dependent drop site.
65
66        <p><strong>NOTE:</strong> currently this notification can not be ensured by all
67        implementations. Do not rely on it ! </p>
68
69        @param dsde
70        The <type>DragSourceDragEvent</type>.
71    */
72
73    [oneway] void dragEnter( [in] DragSourceDragEvent dsde );
74
75    //-------------------------------------------------------------------------
76    /** Called as the hotspot exits a platform dependent drop site.
77
78        <p><strong>NOTE:</strong> Currently this notification can not be ensured by all
79        implementations. Do not rely on it ! </p>
80
81        @param dse
82        The <type>DragSourceEvent</type>.
83    */
84
85    [oneway] void dragExit( [in] DragSourceEvent dse );
86
87    //-------------------------------------------------------------------------
88    /** Called as the hotspot moves over a platform dependent drop site.
89
90        @param dsde
91        The <type>DragSourceEvent</type>
92    */
93
94    [oneway] void dragOver( [in] DragSourceDragEvent dsde );
95
96    //-------------------------------------------------------------------------
97    /** Called when the user has modified the drop gesture.
98
99        @param dsde
100        The <type>DragSourceEvent</type>.
101    */
102
103    [oneway] void dropActionChanged( [in] DragSourceDragEvent dsde );
104};
105
106//=============================================================================
107
108}; }; }; }; };
109
110#endif
111