offapi/com/sun/star/awt/XSystemChildFactory.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSystemChildFactory.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_awt_XSystemChildFactory_idl__
  32 #define __com_sun_star_awt_XSystemChildFactory_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module awt {
  42
  43 //=============================================================================
  44
  45  published interface XWindowPeer;
  46
  47 /** specifies a factory interface for creating system child windows.
  48  */
  49 published interface XSystemChildFactory : com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** creates a system child window.
  54
  55         @returns
  56         the created window.
  57
  58         @param Parent
  59         a sytem-specific handle to a window.
  60
  61         <p>You must check the machine ID and the process ID.<BR>
  62         WIN32: HWND.<BR>
  63         WIN16: HWND.<BR>
  64
  65         JAVA: global reference to a java.awt.Component
  66         object provided from the JNI-API.<BR>
  67
  68         OS2: HWND.<BR>
  69         MAC: Not supported.<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      XWindowPeer createSystemChild( [in] any Parent, [in] sequence< byte > ProcessId, [in] short SystemType );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif