offapi/com/sun/star/datatransfer/dnd/DropTargetDropEvent.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: DropTargetDropEvent.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_DropTargetDropEvent_idl__
  32 #define __com_sun_star_datatransfer_dnd_DropTargetDropEvent_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_dnd_DropTargetEvent_idl__
  35 #include <com/sun/star/datatransfer/dnd/DropTargetEvent.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_datatransfer_XTransferable_idl__
  39 #include <com/sun/star/datatransfer/XTransferable.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module datatransfer { module dnd {
  45
  46  published interface XDropTargetDropContext;
  47
  48 //=============================================================================
  49 /** The <type>DropTargetDropEvent</type> is delivered from the drop target to
  50     its currently registered drop target listener.
  51
  52     <p>It contains sufficient information for the originator of the operation to
  53     provide appropriate feedback to the end user when the operation completes.</p>
  54 */
  55
  56 published struct DropTargetDropEvent: com::sun::star::datatransfer::dnd::DropTargetEvent
  57 {
  58     //-------------------------------------------------------------------------
  59     /** The drop target context of the current drag operation.
  60
  61         @see com::sun::star::datatransfer::dnd::XDropTargetDropContext
  62      */
  63
  64     XDropTargetDropContext Context;
  65
  66     //-------------------------------------------------------------------------
  67     /** This value represents the action or actions selected by the user at
  68         the time of the drop.
  69
  70         <p>If more than one action is specified, the <type>XDropTargetListener</type>
  71          should raise a dialog to ask the user which action to use.</p>
  72
  73          @see com::sun::star::datatransfer::dnd::DNDConstants
  74      */
  75
  76     byte DropAction;
  77
  78     //-------------------------------------------------------------------------
  79     /** The cursor's current x location within the windows' coordinates.
  80      */
  81
  82     long LocationX;
  83
  84     //-------------------------------------------------------------------------
  85     /** The cursor's current y location within the windows' coordinates.
  86      */
  87
  88     long LocationY;
  89
  90     //-------------------------------------------------------------------------
  91     /** This value represents the action or actions supported by the source.
  92      */
  93
  94     byte SourceActions;
  95
  96     //-------------------------------------------------------------------------
  97     /** The transferable object associated with the drop.
  98
  99         @see com::sun::star::datatransfer::XTransferable
 100      */
 101
 102     com::sun::star::datatransfer::XTransferable Transferable;
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; }; };
 108
 109 #endif