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