summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XDataTransferProviderAccess.idl
blob: c0cc57a3ffe10fc515646a94b7f8322c27663564 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_awt_XDataTransferProviderAccess_idl__
#define __com_sun_star_awt_XDataTransferProviderAccess_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com { module sun { module star { module datatransfer { 
module dnd {
     published interface XDragGestureRecognizer;
     published interface XDragSource;
     published interface XDropTarget;
};
module clipboard {
     published interface XClipboard;
}; 
}; }; }; };

//=============================================================================

module com { module sun { module star { module awt {

 published interface XWindow;

//=============================================================================

/** This interface extends the XToolkit interface with clipboard and 
    drag-and-drop support.
*/
published interface XDataTransferProviderAccess: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the drag gesture recognizer of the specified window.
    
        @returns the drag gesture recognizer.

        @param window
        a window created by the same toolkit instance.
    */
    com::sun::star::datatransfer::dnd::XDragGestureRecognizer getDragGestureRecognizer( [in] XWindow window );

    //-------------------------------------------------------------------------

    /** returns the drag source of the specified window.

        @returns the drag source.
    
        @param window
        a window created by the same toolkit instance.
    */
    com::sun::star::datatransfer::dnd::XDragSource getDragSource( [in] XWindow window );
    
    //-------------------------------------------------------------------------

    /** returns the drop target of the specified window.

        @returns the drop target.
        
        @param window
        a window created by the same toolkit instance.
    */
    com::sun::star::datatransfer::dnd::XDropTarget getDropTarget( [in] XWindow window );

    //-------------------------------------------------------------------------

    /** returns the specified clipboard.

        @returns the specified clipboard (if available).
        
        @param clipboardName
        the name of the clipboard to return.
        If an empty string is passed in, the default clipboard is returned.
    */
    com::sun::star::datatransfer::clipboard::XClipboard getClipboard( [in] string clipboardName );
};

//=============================================================================

}; }; }; };

#endif