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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XSystemDependentWindowPeer_idl__
  29 #define __com_sun_star_awt_XSystemDependentWindowPeer_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module awt {
  37
  38 //=============================================================================
  39
  40 /** provides access to the system dependent implementation of the window.
  41
  42     @see com::sun::star::lang::SystemDependent
  43     @see WindowAttribute
  44     @see WindowAttribute::SYSTEMDEPENDENT
  45  */
  46 published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** returns a system-specific window handle.
  51
  52         @returns
  53         a system-specific handle to a window
  54         or 0 if the window is not in the same process.
  55
  56         <p>You must check the machine ID and the process ID.<BR>
  57         WIN32: Returns an HWND if possible, otherwise 0.<BR>
  58         WIN16: Returns an HWND if possible, otherwise 0.<BR>
  59
  60         JAVA: Returns a global reference to a java.awt.Component
  61         object provided from the JNI-API.<BR>
  62
  63         MAC: Returns a ptr to the NSView implementing the window.<BR>
  64
  65         XWINDOW: Returns a structure SystemDependentXWindow
  66         or void if it is not reachable.<BR></p>
  67
  68         @param ProcessId
  69         the process identifier. Use the sal_getGlobalProcessId
  70         function of the RTL library.
  71
  72         @param SystemType
  73         one constant out of the constant group
  74         <type scope="com::sun::star::lang">SystemDependent</type>.
  75      */
  76     any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType );
  77
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */