offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.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: XDropTargetDropContext.idl,v $
  10  * $Revision: 1.10 $
  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_XDropTargetDropContext_idl__
  32 #define __com_sun_star_datatransfer_dnd_XDropTargetDropContext_idl__
  33
  34 #ifndef __com_sun_star_datatransfer_dnd_InvalidDNDOperationException_idl__
  35 #include <com/sun/star/datatransfer/dnd/InvalidDNDOperationException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module datatransfer { module dnd {
  45
  46 //=============================================================================
  47 /** This interface is implemented by any drop target context object.
  48
  49     <p>A DropTargetContext is created whenever the logical cursor associated
  50     with a Drag and Drop operation moves within the visible geometry of a
  51     window associated with a DropTarget. </p>
  52
  53     <p>The drop target context provides the mechanism for a potential receiver
  54     of a drop operation to provide the end user with the appropriate drag
  55     under feedback and to effect the subsequent data transfer, if appropriate. </p>
  56 */
  57
  58 published interface XDropTargetDropContext : com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61     /** Accept the Drop.
  62
  63         <p>This method should be called from the
  64         <member scope="com::sun::star::datatransfer::dnd">XDropTargetListener::drop()</member>
  65         method if the implementation wishes to accept the drop operation with the specified action.</p>
  66
  67         @param dragOperation
  68         The operation accepted by the target.
  69
  70         @see DNDConstants
  71         @see DropTargetDragEvent
  72     */
  73
  74     [oneway] void acceptDrop( [in] byte dragOperation );
  75
  76     //-------------------------------------------------------------------------
  77     /** Reject the drop as a result of examining the available
  78         <type scope="com::sun::star::datatransfer">DataFlavor</type> types
  79         received in the <member>XDropTargetListener::dragEnter()</member> method.
  80     */
  81
  82     [oneway] void rejectDrop();
  83
  84     //-------------------------------------------------------------------------
  85     /** Signals that the drop is completed and if it was successful or not.
  86
  87         @param success
  88         A value of <TRUE/> means the drop completed successfully
  89         <p>A value of <FALSE/> means the drop completed unsuccessfully.</p>
  90     */
  91
  92     [oneway] void dropComplete( [in] boolean success );
  93 };
  94
  95 //=============================================================================
  96
  97 }; }; }; }; };
  98
  99 #endif