offapi/com/sun/star/datatransfer/dnd/DropTargetDragEvent.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: DropTargetDragEvent.idl,v $
  10  * $Revision: 1.8 $
  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_DropTargetDragEvent_idl__
  32 #define __com_sun_star_datatransfer_dnd_DropTargetDragEvent_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_dnd_DropTargetEvent_idl__
  35 #include <com/sun/star/datatransfer/dnd/DropTargetEvent.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer { module dnd {
  41
  42  published interface XDropTargetDragContext;
  43
  44 //=============================================================================
  45 /** The <type>DropTargetDragEvent</type> is delivered from the drop target
  46     to the currently registered drop target listener.
  47
  48     <p>It contains information regarding the current state of the operation to enable
  49     the operations initiator to provide the end user with the appropriate drag
  50     over feedback.</p>
  51
  52     @see com::sun::star::datatransfer::dnd::XDropTargetListener
  53 */
  54
  55 published struct DropTargetDragEvent: com::sun::star::datatransfer::dnd::DropTargetEvent
  56 {
  57     //-------------------------------------------------------------------------
  58     /** The drop target context of the current drag operation.
  59
  60         @see com::sun::star::datatransfer::dnd::XDropTargetDragContext
  61      */
  62
  63     XDropTargetDragContext Context;
  64
  65     //-------------------------------------------------------------------------
  66     /** This value represents the currently selected drop action.
  67
  68         @see com::sun::star::datatransfer::dnd::DNDConstants
  69      */
  70
  71     byte DropAction;
  72
  73     //-------------------------------------------------------------------------
  74     /** The cursor's current x location within the window's coordinates.
  75      */
  76
  77     long LocationX;
  78
  79     //-------------------------------------------------------------------------
  80     /** The cursor's current y location within the window's coordinates.
  81      */
  82
  83     long LocationY;
  84
  85     //-------------------------------------------------------------------------
  86     /** This value represents the action or actions supported by the source.
  87         This may be a combination of arbitrary source actions except ACTION_DEFAULT.
  88         <p>To combine different actions use a logical OR.</p>
  89
  90         @see com::sun::star::datatransfer::dnd::DNDConstants
  91      */
  92
  93     byte SourceActions;
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; }; };
  99
 100 #endif