offapi/com/sun/star/datatransfer/dnd/XDragSourceContext.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: XDragSourceContext.idl,v $
  10  * $Revision: 1.9 $
  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_XDragSourceContext_idl__
  32 #define __com_sun_star_datatransfer_dnd_XDragSourceContext_idl__
  33
  34 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer { module dnd {
  41
  42  published interface XDragSourceListener;
  43
  44 //=============================================================================
  45 /** The drag source context class is responsible for managing the initiator side
  46     of the Drag and Drop protocol.
  47
  48     <p>In particular, it is responsible for managing event notifications to the
  49     DragSourceListener and providing the Transferable state to enable the data
  50     transfer. </p>
  51
  52     <p>An instance of this class is created as a result of the method <member>XDragSource::startDrag()</member>
  53     being successfully invoked. This instance is responsible
  54     for tracking the state of the operation on behalf of the drag source and
  55     dispatching state changes to the drag source listener. </p>
  56
  57     @see com::sun::star::datatransfer::dnd::XDragSourceContext
  58     @see com::sun::star::datatransfer::dnd::XDragSourceListener
  59 */
  60
  61 published interface XDragSourceContext: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64     /** Get the identifier of the currently used cursor.
  65
  66         @returns
  67         The currently selected drag cursor.
  68     */
  69
  70     long getCurrentCursor();
  71
  72     //-------------------------------------------------------------------------
  73     /** This method sets the current drag cursor.
  74
  75         <p>This method should only be called to set another cursor than the
  76         default one for drag action currently selected by the user.</p>
  77         <p>Invalid cursor identifiers will be ignored.</p>
  78
  79         @param cursorId
  80         The identifier the drag source returned when registering the cursor.
  81     */
  82
  83     [oneway] void setCursor( [in] long cursorId );
  84
  85     //-------------------------------------------------------------------------
  86     /** This method sets the current drag image.
  87
  88         @param dragImage
  89         The identifier the drag source returned when registering the image (0 = none).
  90         Invalid identifier will be ignored.
  91     */
  92
  93     [oneway] void setImage( [in] long imageId );
  94
  95     //-------------------------------------------------------------------------
  96     /** This method notifies the context that the
  97         <type scope="com::sun::star::datatransfer">DataFlavor</type> types
  98         of the transferable object have changed.
  99
 100         @see com::sun::star::datatransfer::XTransferable
 101     */
 102
 103     [oneway] void transferablesFlavorsChanged();
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; }; };
 109
 110 #endif