udkapi/com/sun/star/bridge/XBridgeSupplier2.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 bridge {
  23
  24
  25 /** defines the interface for creating bridges to other object models.
  26
  27     <p>
  28     The created bridges are transparent to the user. That is, if one maps
  29     an interface into the target model, then the resulting target interface
  30     is a bridge implementation, that is not being noticed by an user. During
  31     a call on that interface, the bridge is invoked to convert the arguments
  32     and carry out a call according to the rules of the source model.
  33     Return values are automatically mapped to the types of the target model.
  34     </p>
  35     <p>
  36     Simple types are mapped to simple target types. That is, there is no additional
  37     bridging code involved when those types are being used.
  38     </p>
  39
  40     <p>Sometimes a bridge cannot be created, depending on whether a program uses
  41     the XBridgeSupplier2 interface remotely. Assuming one wants to bridge an
  42     OLE Automation object to UNO by calling createBridge on a proxy, then the UNO remote
  43     bridge would not recognise that the Any argument contains an IDispatch interface.
  44     Therefore it cannot marshal it as COM requires it and the bridgeing would fail.
  45     To prevent this, implementations of this interface should be aware of this scenario and
  46     if necessary take the appropriate steps. The process ID argument to the createBridge
  47     function represents the calling process and may be used by the implementation to determine
  48     if it is being accessed remotely.
  49     </p>
  50     <p>All objects, whether they are part of the UNO object model or not,
  51     are carried in an `any`.  The representation of this object
  52     is heavily model-dependent and has to be specified in the following list: </p>
  53
  54     <dl>
  55         <dt>UNO: </dt>
  56         <dd>The any carries normal UNO types, which can be any base type,
  57         struct, sequence, enum or interface.  </dd>
  58
  59         <dt>OLE:    </dt>
  60         <dd>The any carries an `unsigned long` (on 32-bit systems)
  61         or an `unsigned hyper` (on 64-bit systems), which is
  62         interpreted as a variant pointer. The any does not control the
  63         lifetime of the represented variant. That implies that the caller
  64         has the responsibility of freeing the OLE resources represented
  65         by the any value.  </dd>
  66
  67         <dt>JAVA:   </dt>
  68         <dd>not specified yet.  </dd>
  69     </dl>
  70
  71     </p>
  72     <p>Any implementation can supply its own bridges to other object
  73     models by implementing this interface and returning the bridge
  74     when the method XBridgeSupplier2::createBridge()
  75     is called with itself as the first parameter.  </p>
  76
  77     @see com::sun::star::bridge::OleBridgeSupplier2
  78  */
  79 published interface XBridgeSupplier2: com::sun::star::uno::XInterface
  80 {
  81     /** creates a bridge to provide an object of one object model with another.
  82      */
  83     any createBridge( [in] any aModelDepObject,
  84              [in] sequence< byte > aProcessId,
  85              [in] short nSourceModelType,
  86              [in] short nDestModelType )
  87             raises( com::sun::star::lang::IllegalArgumentException );
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */