xref: /AOO41X/main/offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.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_DragGestureEvent_idl__
25#define __com_sun_star_datatransfer_dnd_DragGestureEvent_idl__
26
27#ifndef __com_sun_star_lang_EventObject_idl__
28#include <com/sun/star/lang/EventObject.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module datatransfer { module dnd {
34
35 published interface XDragSource;
36
37//=============================================================================
38/** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member>
39    when a particular <type>XDragGestureRecognizer</type> detects that a platform
40    dependent drag initiating gesture has occurred on the component that it is
41    tracking.
42*/
43
44published struct DragGestureEvent: com::sun::star::lang::EventObject
45{
46    //-------------------------------------------------------------------------
47    /** The action selected by the user.
48        <p>Different constants may be combined using a logical OR.</p>
49        It's further possible to combine the ACTION_DEFAULT with one of the other
50        actions defined in <type scope="com::sun::star::datatransfer::dnd">DNDConstants</type>.
51        This means the user did not press any key during the Drag and Drop operation
52        and the action that was combined with ACTION_DEFAULT is the system default action.</p>
53
54        @see com::sun::star::datatransfer::dnd::DNDConstants
55     */
56
57    byte DragAction;
58
59    //-------------------------------------------------------------------------
60    /** The x coordinate where the drag originated in component coordinates.
61     */
62
63    long DragOriginX;
64
65    //-------------------------------------------------------------------------
66    /** The y coordinate where the drag originated in component coordinates.
67     */
68
69    long DragOriginY;
70
71    //-------------------------------------------------------------------------
72    /** The DragSource associated with this drag action.
73     */
74
75    XDragSource DragSource;
76
77    //-------------------------------------------------------------------------
78    /** The last event comprising the gesture.
79
80    <p>The initial trigger event will presumably be a <type scope="com::sun::star::awt">MouseEvent</type> event.
81    If it is not, the implementation should either react accordingly or
82    presume that the left mouse button was clicked. </p>
83    */
84
85    any Event;
86};
87
88//=============================================================================
89
90}; }; }; }; };
91
92#endif
93