summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XSystemChildFactory.idl
blob: d55fa005c4b282608a407578baba822b3ff558c6 (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
/*************************************************************************
 *
 * 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_XSystemChildFactory_idl__
#define __com_sun_star_awt_XSystemChildFactory_idl__

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


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

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

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

 published interface XWindowPeer;

/** specifies a factory interface for creating system child windows.
 */
published interface XSystemChildFactory : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** creates a system child window.

        @returns
        the created window.

        @param Parent
        a sytem-specific handle to a window.

        <p>You must check the machine ID and the process ID.<BR>
        WIN32: HWND.<BR>
        WIN16: HWND.<BR>

        JAVA: global reference to a java.awt.Component
        object provided from the JNI-API.<BR>

        OS2: HWND.<BR>
        MAC: Not supported.<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>.
    */
     XWindowPeer createSystemChild( [in] any Parent, [in] sequence< byte > ProcessId, [in] short SystemType );

};

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

}; }; }; };

#endif