offapi/com/sun/star/datatransfer/dnd/XDropTargetDragContext.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 drop target context 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 drop target. </p>
  28
  29     <p>The drop target context provides the mechanism for a potential receiver
  30     of a drop operation to both provide the end user with the appropriate drag
  31     under feedback and effect the subsequent data transfer, if appropriate. </p>
  32 */
  33
  34 published interface XDropTargetDragContext: com::sun::star::uno::XInterface
  35 {
  36     /** Accept the Drag.
  37
  38         <p>This method should be called from the methods of XDropTargetListener
  39         <ul>
  40             <li>XDropTargetListener::dragEnter()</li>
  41             <li>XDropTargetListener::dragOver()</li>
  42             <li>XDropTargetListener::dragActionChanged()</li>
  43         </ul>
  44         if the implementation wishes to accept the drag operation with the specified
  45         action.</p>
  46
  47         @param dragOperation
  48         The operation accepted by the target.
  49
  50         @see DNDConstants
  51         @see DropTargetDragEvent
  52     */
  53
  54     void acceptDrag( [in] byte dragOperation );
  55
  56     /** Reject the drag as a result of examining the available
  57         com::sun::star::datatransfer::DataFlavor types
  58         received in the com::sun::star::datatransfer::dnd::XDropTargetListener::dragEnter() method.
  59     */
  60
  61     void rejectDrag();
  62 };
  63
  64
  65 }; }; }; }; };
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */