1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_XSystemDependentWindowPeer_idl__
28#define __com_sun_star_awt_XSystemDependentWindowPeer_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module awt {
38
39//=============================================================================
40
41/** provides access to the system dependent implementation of the window.
42
43    @see com::sun::star::lang::SystemDependent
44	@see WindowAttribute
45	@see WindowAttribute::SYSTEMDEPENDENT
46 */
47published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50
51	/** returns a system-specific window handle.
52
53        @returns
54		a sytem-specific handle to a window
55		or 0 if the window is not in the same process.
56
57		<p>You must check the machine ID and the process ID.<BR>
58		WIN32: Returns an HWND if possible, otherwise 0.<BR>
59		WIN16: Returns an HWND if possible, otherwise 0.<BR>
60
61		JAVA: Returns a global reference to a java.awt.Component
62		object provided from the JNI-API.<BR>
63
64		OS2: Returns an HWND if possible, otherwise 0.<BR>
65
66		MAC: Returns a ptr to the NSView implementing the window.<BR>
67
68		XWINDOW: Returns a structure SystemDependentXWindow
69        or void if it is not reachable.<BR></p>
70
71		@param ProcessId
72		the process identifier. Use the sal_getGlobalProcessId
73		function of the RTL library.
74
75		@param SystemType
76		one constant out of the constant group
77		<type scope="com::sun::star::lang">SystemDependent</type>.
78	 */
79	any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType );
80
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88