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