offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.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 XDropTargetDragContext;
  24
  25 /** The DropTargetDragEvent is delivered from the drop target
  26     to the currently registered drop target listener.
  27
  28     <p>It contains information regarding the current state of the operation to enable
  29     the operations initiator to provide the end user with the appropriate drag
  30     over feedback.</p>
  31
  32     @see com::sun::star::datatransfer::dnd::XDropTargetListener
  33 */
  34
  35 published struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTargetEvent
  36 {
  37     /** The drop target context of the current drag operation.
  38
  39         @see com::sun::star::datatransfer::dnd::XDropTargetDragContext
  40      */
  41
  42     XDropTargetDragContext Context;
  43
  44     /** This value represents the currently selected drop action.
  45
  46         @see com::sun::star::datatransfer::dnd::DNDConstants
  47      */
  48
  49     byte DropAction;
  50
  51     /** The cursor's current x location within the window's coordinates.
  52      */
  53
  54     long LocationX;
  55
  56     /** The cursor's current y location within the window's coordinates.
  57      */
  58
  59     long LocationY;
  60
  61     /** This value represents the action or actions supported by the source.
  62         This may be a combination of arbitrary source actions except ACTION_DEFAULT.
  63         <p>To combine different actions use a logical OR.</p>
  64
  65         @see com::sun::star::datatransfer::dnd::DNDConstants
  66      */
  67
  68     byte SourceActions;
  69 };
  70
  71
  72 }; }; }; }; };
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */