offapi/com/sun/star/awt/XDataTransferProviderAccess.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: XDataTransferProviderAccess.idl,v $
  10  * $Revision: 1.7 $
  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_awt_XDataTransferProviderAccess_idl__
  32 #define __com_sun_star_awt_XDataTransferProviderAccess_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer {
  41 module dnd {
  42      published interface XDragGestureRecognizer;
  43      published interface XDragSource;
  44      published interface XDropTarget;
  45 };
  46 module clipboard {
  47      published interface XClipboard;
  48 };
  49 }; }; }; };
  50
  51 //=============================================================================
  52
  53 module com { module sun { module star { module awt {
  54
  55  published interface XWindow;
  56
  57 //=============================================================================
  58
  59 /** This interface extends the XToolkit interface with clipboard and
  60     drag-and-drop support.
  61 */
  62 published interface XDataTransferProviderAccess: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** returns the drag gesture recognizer of the specified window.
  67
  68         @returns the drag gesture recognizer.
  69
  70         @param window
  71         a window created by the same toolkit instance.
  72     */
  73     com::sun::star::datatransfer::dnd::XDragGestureRecognizer getDragGestureRecognizer( [in] XWindow window );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** returns the drag source of the specified window.
  78
  79         @returns the drag source.
  80
  81         @param window
  82         a window created by the same toolkit instance.
  83     */
  84     com::sun::star::datatransfer::dnd::XDragSource getDragSource( [in] XWindow window );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** returns the drop target of the specified window.
  89
  90         @returns the drop target.
  91
  92         @param window
  93         a window created by the same toolkit instance.
  94     */
  95     com::sun::star::datatransfer::dnd::XDropTarget getDropTarget( [in] XWindow window );
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** returns the specified clipboard.
 100
 101         @returns the specified clipboard (if available).
 102
 103         @param clipboardName
 104         the name of the clipboard to return.
 105         If an empty string is passed in, the default clipboard is returned.
 106     */
 107     com::sun::star::datatransfer::clipboard::XClipboard getClipboard( [in] string clipboardName );
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114 #endif