offapi/com/sun/star/datatransfer/dnd/XDropTargetDropContext.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 /** This interface is implemented by any drop target context object.
  24
  25     <p>A DropTargetContext is created whenever the logical cursor associated
  26     with a Drag and Drop operation moves within the visible geometry of a
  27     window associated with a DropTarget. </p>
  28
  29     <p>The drop target context provides the mechanism for a potential receiver
  30     of a drop operation to provide the end user with the appropriate drag
  31     under feedback and to effect the subsequent data transfer, if appropriate. </p>
  32 */
  33
  34 published interface XDropTargetDropContext : com::sun::star::uno::XInterface
  35 {
  36     /** Accept the Drop.
  37
  38         <p>This method should be called from the
  39         com::sun::star::datatransfer::dnd::XDropTargetListener::drop()
  40         method if the implementation wishes to accept the drop operation with the specified action.</p>
  41
  42         @param dragOperation
  43         The operation accepted by the target.
  44
  45         @see DNDConstants
  46         @see DropTargetDragEvent
  47     */
  48
  49     void acceptDrop( [in] byte dragOperation );
  50
  51     /** Reject the drop as a result of examining the available
  52         com::sun::star::datatransfer::DataFlavor types
  53         received in the XDropTargetListener::dragEnter() method.
  54     */
  55
  56     void rejectDrop();
  57
  58     /** Signals that the drop is completed and if it was successful or not.
  59
  60         @param success
  61         A value of `TRUE` means the drop completed successfully
  62         <p>A value of `FALSE` means the drop completed unsuccessfully.</p>
  63     */
  64
  65     void dropComplete( [in] boolean success );
  66 };
  67
  68
  69 }; }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */