1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XSystemDependentWindowPeer_idl__
24#define __com_sun_star_awt_XSystemDependentWindowPeer_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module awt {
34
35//=============================================================================
36
37/** provides access to the system dependent implementation of the window.
38
39    @see com::sun::star::lang::SystemDependent
40	@see WindowAttribute
41	@see WindowAttribute::SYSTEMDEPENDENT
42 */
43published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46
47	/** returns a system-specific window handle.
48
49        @returns
50		a sytem-specific handle to a window
51		or 0 if the window is not in the same process.
52
53		<p>You must check the machine ID and the process ID.<BR>
54		WIN32: Returns an HWND if possible, otherwise 0.<BR>
55		WIN16: Returns an HWND if possible, otherwise 0.<BR>
56
57		JAVA: Returns a global reference to a java.awt.Component
58		object provided from the JNI-API.<BR>
59
60		OS2: Returns an HWND if possible, otherwise 0.<BR>
61
62		MAC: Returns a ptr to the NSView implementing the window.<BR>
63
64		XWINDOW: Returns a structure SystemDependentXWindow
65        or void if it is not reachable.<BR></p>
66
67		@param ProcessId
68		the process identifier. Use the sal_getGlobalProcessId
69		function of the RTL library.
70
71		@param SystemType
72		one constant out of the constant group
73		<type scope="com::sun::star::lang">SystemDependent</type>.
74	 */
75	any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType );
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84