udkapi/com/sun/star/bridge/XBridgeSupplier.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 #ifndef __com_sun_star_bridge_XBridgeSupplier_idl__
  20 #define __com_sun_star_bridge_XBridgeSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/uno/Uik.idl>
  25
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module bridge {
  31
  32
  33
  34 /** defines the interface for creating bridges to other object models.
  35
  36     <p>Because bridges sometimes can not be generated in an address space,
  37     the implementation needs to check the address space of the caller by
  38     comparing the machine and process ID against its own. These IDs are
  39     provided by the UNO runtime.  </p>
  40
  41     <p>All objects, whether they are part of the UNO object model or not,
  42     are carried in an `any`.  The representation of this object
  43     is heavily model-dependent and has to be specified in the following list: </p>
  44
  45     <dl>
  46         <dt>UNO: </dt>
  47         <dd>The any carries normal UNO types, which can be any base type,
  48         struct, sequence, enum, or interface.  </dd>
  49
  50         <dt>OLE:    </dt>
  51         <dd>The any carries an `unsigned long` (on 32-bit systems)
  52         or an `unsigned hyper` (on 64-bit systems), which is
  53         interpreted as a variant pointer. The any does not control the
  54         lifetime of the represented variant. That implies that the caller
  55         has the responsibility of freeing the OLE resources represented
  56         by the any value.  </dd>
  57
  58         <dt>JAVA:   </dt>
  59         <dd>not yet specified.  </dd>
  60
  61         <dt>CORBA: </dt>
  62         <dd>not yet specified.  </dd>
  63     </dl>
  64
  65     <p>Any implementation can supply its own bridges to other object
  66     models by implementing this interface and returning the bridge
  67     when the method is called with itself as the first parameter. </p>
  68
  69     @see com::sun::star::bridge::OleBridgeSupplier
  70     @deprecated
  71  */
  72 published interface XBridgeSupplier: com::sun::star::uno::XInterface
  73 {
  74
  75     /** creates a bridge to provide an object of one object model with another.
  76      */
  77     any createBridge( [in] any modelDepObject,
  78              [in] com::sun::star::uno::Uik MachineId,
  79              [in] long ProcessId,
  80              [in] short sourceModelType,
  81              [in] short destModelType )
  82             raises( com::sun::star::lang::IllegalArgumentException );
  83
  84 };
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */