offapi/com/sun/star/datatransfer/dnd/DragGestureEvent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DragGestureEvent.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_datatransfer_dnd_DragGestureEvent_idl__
  32 #define __com_sun_star_datatransfer_dnd_DragGestureEvent_idl__
  33
  34 #ifndef __com_sun_star_lang_EventObject_idl__
  35 #include <com/sun/star/lang/EventObject.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer { module dnd {
  41
  42  published interface XDragSource;
  43
  44 //=============================================================================
  45 /** A DragGestureEvent is passed to the method <member>XDragGestureListener::dragGestureRecognized()</member>
  46      when a particular <type>XDragGestureRecognizer</type> detects that a platform
  47      dependent drag initiating gesture has occurred on the component that it is
  48      tracking.
  49 */
  50
  51 published struct DragGestureEvent: com::sun::star::lang::EventObject
  52 {
  53     //-------------------------------------------------------------------------
  54     /** The action selected by the user.
  55         <p>Different constants may be combined using a logical OR.</p>
  56         It's further possible to combine the ACTION_DEFAULT with one of the other
  57         actions defined in <type scope="com::sun::star::datatransfer::dnd">DNDConstants</type>.
  58         This means the user did not press any key during the Drag and Drop operation
  59         and the action that was combined with ACTION_DEFAULT is the system default action.</p>
  60
  61         @see com::sun::star::datatransfer::dnd::DNDConstants
  62      */
  63
  64     byte DragAction;
  65
  66     //-------------------------------------------------------------------------
  67     /** The x coordinate where the drag originated in component coordinates.
  68      */
  69
  70     long DragOriginX;
  71
  72     //-------------------------------------------------------------------------
  73     /** The y coordinate where the drag originated in component coordinates.
  74      */
  75
  76     long DragOriginY;
  77
  78     //-------------------------------------------------------------------------
  79     /** The DragSource associated with this drag action.
  80      */
  81
  82     XDragSource DragSource;
  83
  84     //-------------------------------------------------------------------------
  85     /** The last event comprising the gesture.
  86
  87     <p>The initial trigger event will presumably be a <type scope="com::sun::star::awt">MouseEvent</type> event.
  88     If it is not, the implementation should either react accordingly or
  89     presume that the left mouse button was clicked.     </p>
  90     */
  91
  92     any Event;
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; }; };
  98
  99 #endif