Version 5.2.6.1, tag libreoffice-5.2.6.1
[LibreOffice.git] / offapi / com / sun / star / awt / XSystemDependentWindowPeer.idl
blobcfb48b67e90343d53446d072f83139035f069912
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
19 #ifndef __com_sun_star_awt_XSystemDependentWindowPeer_idl__
20 #define __com_sun_star_awt_XSystemDependentWindowPeer_idl__
22 #include <com/sun/star/uno/XInterface.idl>
26 module com { module sun { module star { module awt {
29 /** provides access to the system dependent implementation of the window.
31 @see com::sun::star::lang::SystemDependent
32 @see WindowAttribute
33 @see WindowAttribute::SYSTEMDEPENDENT
35 published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
38 /** returns a system-specific window handle.
40 @returns
41 a system-specific handle to a window
42 or 0 if the window is not in the same process.
44 <p>You must check the machine ID and the process ID.<BR>
45 WIN32: Returns an HWND if possible, otherwise 0.<BR>
46 WIN16: Returns an HWND if possible, otherwise 0.<BR>
48 JAVA: Returns a global reference to a java.awt.Component
49 object provided from the JNI-API.<BR>
51 MAC: Returns a ptr to the NSView implementing the window.<BR>
53 XWINDOW: Returns a structure SystemDependentXWindow
54 or void if it is not reachable.<BR></p>
56 @param ProcessId
57 the process identifier. Use the sal_getGlobalProcessId
58 function of the RTL library.
60 @param SystemType
61 one constant out of the constant group
62 com::sun::star::lang::SystemDependent.
64 any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType );
69 }; }; }; };
71 #endif
73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */