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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_datatransfer_dnd_DragGestureEvent_idl__
  21 #define __com_sun_star_datatransfer_dnd_DragGestureEvent_idl__
  22
  23 #include <com/sun/star/lang/EventObject.idl>
  24
  25
  26 module com { module sun { module star { module datatransfer { module dnd {
  27
  28  published interface XDragSource;
  29
  30 /** A DragGestureEvent is passed to the method XDragGestureListener::dragGestureRecognized()
  31      when a particular XDragGestureRecognizer detects that a platform
  32      dependent drag initiating gesture has occurred on the component that it is
  33      tracking.
  34 */
  35
  36 published struct DragGestureEvent: com::sun::star::lang::EventObject
  37 {
  38     /** The action selected by the user.
  39         <p>Different constants may be combined using a logical OR.</p>
  40         It's further possible to combine the ACTION_DEFAULT with one of the other
  41         actions defined in com::sun::star::datatransfer::dnd::DNDConstants.
  42         This means the user did not press any key during the Drag and Drop operation
  43         and the action that was combined with ACTION_DEFAULT is the system default action.</p>
  44
  45         @see com::sun::star::datatransfer::dnd::DNDConstants
  46      */
  47
  48     byte DragAction;
  49
  50     /** The x coordinate where the drag originated in component coordinates.
  51      */
  52
  53     long DragOriginX;
  54
  55     /** The y coordinate where the drag originated in component coordinates.
  56      */
  57
  58     long DragOriginY;
  59
  60     /** The DragSource associated with this drag action.
  61      */
  62
  63     XDragSource DragSource;
  64
  65     /** The last event comprising the gesture.
  66
  67     <p>The initial trigger event will presumably be a com::sun::star::awt::MouseEvent event.
  68     If it is not, the implementation should either react accordingly or
  69     presume that the left mouse button was clicked. </p>
  70     */
  71
  72     any Event;
  73 };
  74
  75
  76 }; }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */