offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.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  published interface XDragSourceListener;
  24
  25 /** The drag source context class is responsible for managing the initiator side
  26     of the Drag and Drop protocol.
  27
  28     <p>In particular, it is responsible for managing event notifications to the
  29     DragSourceListener and providing the Transferable state to enable the data
  30     transfer. </p>
  31
  32     <p>An instance of this class is created as a result of the method XDragSource::startDrag()
  33     being successfully invoked. This instance is responsible
  34     for tracking the state of the operation on behalf of the drag source and
  35     dispatching state changes to the drag source listener. </p>
  36
  37     @see com::sun::star::datatransfer::dnd::XDragSourceContext
  38     @see com::sun::star::datatransfer::dnd::XDragSourceListener
  39 */
  40
  41 published interface XDragSourceContext: com::sun::star::uno::XInterface
  42 {
  43     /** Get the identifier of the currently used cursor.
  44
  45         @returns
  46         The currently selected drag cursor.
  47     */
  48
  49     long getCurrentCursor();
  50
  51     /** This method sets the current drag cursor.
  52
  53         <p>This method should only be called to set another cursor than the
  54         default one for drag action currently selected by the user.</p>
  55         <p>Invalid cursor identifiers will be ignored.</p>
  56
  57         @param cursorId
  58         The identifier the drag source returned when registering the cursor.
  59     */
  60
  61     void setCursor( [in] long cursorId );
  62
  63     /** This method sets the current drag image.
  64
  65         @param imageId
  66         The identifier the drag source returned when registering the image (0 = none).
  67         Invalid identifier will be ignored.
  68     */
  69
  70     void setImage( [in] long imageId );
  71
  72     /** This method notifies the context that the
  73         com::sun::star::datatransfer::DataFlavor types
  74         of the transferable object have changed.
  75
  76         @see com::sun::star::datatransfer::XTransferable
  77     */
  78
  79     void transferablesFlavorsChanged();
  80 };
  81
  82
  83 }; }; }; }; };
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */