udkapi/com/sun/star/bridge/XBridgeSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XBridgeSupplier.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_bridge_XBridgeSupplier_idl__
  31 #define __com_sun_star_bridge_XBridgeSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_Uik_idl__
  38 #include <com/sun/star/uno/Uik.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module bridge {
  49
  50 //=============================================================================
  51
  52
  53 /** defines the interface for creating bridges to other object models.
  54
  55     <p>Because bridges sometimes can not be generated in an address space,
  56     the implementation needs to check the address space of the caller by
  57     comparing the machine and process ID against its own. These IDs are
  58     provided by the UNO runtime.  </p>
  59
  60     <p>All objects, whether they are part of the UNO object model or not,
  61     are carried in an <atom>any</atom>.  The representation of this object
  62     is heavily model-dependent and has to be specified in the following list: </p>
  63
  64     <dl>
  65         <dt>UNO: </dt>
  66         <dd>The any carries normal UNO types, which can be any base type,
  67         struct, sequence, enum, or interface.  </dd>
  68
  69         <dt>OLE:        </dt>
  70         <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems)
  71         or an <atom>unsigned hyper</atom> (on 64-bit systems), which is
  72         interpreted as a variant pointer. The any does not control the
  73         lifetime of the represented variant. That implies that the caller
  74         has the responsibility of freeing the OLE resources represented
  75         by the any value.  </dd>
  76
  77         <dt>JAVA:       </dt>
  78         <dd>not yet specified.  </dd>
  79
  80         <dt>CORBA: </dt>
  81         <dd>not yet specified.  </dd>
  82     </dl>
  83
  84     <p>Any implementation can supply its own bridges to other object
  85     models by implementing this interface and returning the bridge
  86     when the method is called with itself as the first parameter. </p>
  87
  88     @see com::sun::star::bridge::OleBridgeSupplier
  89     @deprecated
  90  */
  91 published interface XBridgeSupplier: com::sun::star::uno::XInterface
  92 {
  93
  94     /** creates a bridge to provide an object of one object model with another.
  95      */
  96     any createBridge( [in] any modelDepObject,
  97              [in] com::sun::star::uno::Uik MachineId,
  98              [in] long ProcessId,
  99              [in] short sourceModelType,
 100              [in] short destModelType )
 101             raises( com::sun::star::lang::IllegalArgumentException );
 102
 103 };
 104
 105 }; }; }; };
 106
 107 /*=============================================================================
 108
 109 =============================================================================*/
 110 #endif