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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module awt {
  23
  24
  25 /** provides access to the system dependent implementation of the window.
  26
  27     @see com::sun::star::lang::SystemDependent
  28     @see WindowAttribute
  29     @see WindowAttribute::SYSTEMDEPENDENT
  30  */
  31 published interface XSystemDependentWindowPeer: com::sun::star::uno::XInterface
  32 {
  33
  34     /** returns a system-specific window handle.
  35
  36         @returns
  37         a system-specific handle to a window
  38         or 0 if the window is not in the same process.
  39
  40         <p>You must check the machine ID and the process ID.<BR>
  41         WIN32: Returns an HWND if possible, otherwise 0.<BR>
  42         WIN16: Returns an HWND if possible, otherwise 0.<BR>
  43
  44         JAVA: Returns a global reference to a java.awt.Component
  45         object provided from the JNI-API.<BR>
  46
  47         MAC: Returns a ptr to the NSView implementing the window.<BR>
  48
  49         XWINDOW: Returns a structure SystemDependentXWindow
  50         or void if it is not reachable.<BR></p>
  51
  52         @param ProcessId
  53         the process identifier. Use the sal_getGlobalProcessId
  54         function of the RTL library.
  55
  56         @param SystemType
  57         one constant out of the constant group
  58         com::sun::star::lang::SystemDependent.
  59      */
  60     any getWindowHandle( [in] sequence< byte > ProcessId, [in] short SystemType );
  61
  62 };
  63
  64
  65 }; }; }; };
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */