offapi/com/sun/star/awt/XSystemDependentWindowPeer.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: XSystemDependentWindowPeer.idl,v $
  10  * $Revision: 1.13 $
  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 #ifndef __com_sun_star_awt_XSystemDependentWindowPeer_idl__
  31 #define __com_sun_star_awt_XSystemDependentWindowPeer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** provides access to the system dependent implementation of the window.
  45
  46     @see com::sun::star::lang::SystemDependent
  47     @see WindowAttribute
  48     @see WindowAttribute::SYSTEMDEPENDENT
  49  */
  50 published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns a system-specific window handle.
  55
  56         @returns
  57         a sytem-specific handle to a window
  58         or 0 if the window is not in the same process.
  59
  60         <p>You must check the machine ID and the process ID.<BR>
  61         WIN32: Returns an HWND if possible, otherwise 0.<BR>
  62         WIN16: Returns an HWND if possible, otherwise 0.<BR>
  63
  64         JAVA: Returns a global reference to a java.awt.Component
  65         object provided from the JNI-API.<BR>
  66
  67         OS2: Returns an HWND if possible, otherwise 0.<BR>
  68
  69         MAC: Returns a ptr to the NSView implementing the window.<BR>
  70
  71         XWINDOW: Returns a structure SystemDependentXWindow
  72         or void if it is not reachable.<BR></p>
  73
  74         @param ProcessId
  75         the process identifier. Use the sal_getGlobalProcessId
  76         function of the RTL library.
  77
  78         @param SystemType
  79         one constant out of the constant group
  80         <type scope="com::sun::star::lang">SystemDependent</type>.
  81      */
  82     any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType );
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif