summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XSystemDependentWindowPeer.idl
blob: 1074ab38e48ed6160fdb6ba378a5245091c1302b (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
/*************************************************************************
 *
 * 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_XSystemDependentWindowPeer_idl__ 
#define __com_sun_star_awt_XSystemDependentWindowPeer_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif


//============================================================================= 
 
 module com {  module sun {  module star {  module awt {  
 
//============================================================================= 
 
/** provides access to the system dependent implementation of the window.

    @see com::sun::star::lang::SystemDependent 
    @see WindowAttribute 
    @see WindowAttribute::SYSTEMDEPENDENT
 */
published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    /** returns a system-specific window handle.

        @returns  
        a sytem-specific handle to a window  
        or 0 if the window is not in the same process. 
                 
        <p>You must check the machine ID and the process ID.<BR> 
        WIN32: Returns an HWND if possible, otherwise 0.<BR> 
        WIN16: Returns an HWND if possible, otherwise 0.<BR> 
                 
        JAVA: Returns a global reference to a java.awt.Component 
        object provided from the JNI-API.<BR> 
                 
        OS2: Returns an HWND if possible, otherwise 0.<BR> 

        MAC: Returns a ptr to the NSView implementing the window.<BR> 
                 
        XWINDOW: Returns a structure SystemDependentXWindow
        or void if it is not reachable.<BR></p>
                 
        @param ProcessId 
        the process identifier. Use the sal_getGlobalProcessId 
        function of the RTL library. 
                 
        @param SystemType 
        one constant out of the constant group 
        <type scope="com::sun::star::lang">SystemDependent</type>.
     */
    any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif