summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/bridge/XBridgeSupplier.idl
blob: dfe5749f0bd61d8de2cced88783e1d09f9bb5916 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*************************************************************************
 *
 *  $RCSfile: XBridgeSupplier.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: jl $ $Date: 2002-01-22 09:35:54 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_bridge_XBridgeSupplier_idl__
#define __com_sun_star_bridge_XBridgeSupplier_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_uno_Uik_idl__
#include <com/sun/star/uno/Uik.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module bridge {

//=============================================================================


/** defines the interface for creating bridges to other object models.

    <p>Because bridges sometimes can not be generated in an address space,
    the implementation needs to check the address space of the caller by
    comparing the machine and process ID against its own. These IDs are
    provided by the UNO runtime.  </p>

    <p>All objects, whether they are part of the UNO object model or not,
    are carried in an <atom>any</atom>.  The representation of this object
    is heavily model-dependent and has to be specified in the following list: </p>

    <dl>
        <dt>UNO: </dt>
        <dd>The any carries normal UNO types, which can be any base type,
        struct, sequence, enum, or interface.  </dd>

        <dt>OLE:    </dt>
        <dd>The any carries an <atom>unsigned long</atom> (on 32-bit systems)
        or an <atom>unsigned hyper</atom> (on 64-bit systems), which is
        interpreted as a variant pointer. The any does not control the
        lifetime of the represented variant. That implies that the caller
        has the responsibility of freeing the OLE resources represented
        by the any value.  </dd>

        <dt>JAVA:   </dt>
        <dd>not yet specified.  </dd>

        <dt>CORBA: </dt>
        <dd>not yet specified.  </dd>
    </dl>

    <p>Any implementation can supply its own bridges to other object
    models by implementing this interface and returning the bridge
    when the method is called with itself as the first parameter. </p>

    @see com::sun::star::bridge::OleBridgeSupplier
    @deprecated
 */
interface XBridgeSupplier: com::sun::star::uno::XInterface
{

    /** creates a bridge to provide an object of one object model with another.
     */
    any createBridge( [in] any modelDepObject,
             [in] com::sun::star::uno::Uik MachineId,
             [in] long ProcessId,
             [in] short sourceModelType,
             [in] short destModelType )
            raises( com::sun::star::lang::IllegalArgumentException );

};

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.6  2001/03/16 15:10:33  jsc
    remove interfaceheader with uik and remove [const] in method definitions

    Revision 1.5  2000/12/11 16:09:40  mi
    documentation syntax fixed and some minor semantic documentation fixes

    Revision 1.4  2000/11/08 12:28:26  mi
    moved from api

    Revision 1.2  2000/10/09 14:24:54  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)

    Revision 1.1.1.1  2000/09/18 23:34:57  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:14  mi
    documentation merged from XML

    Revision 1.3  2000/02/21 10:55:47  mi
    proofreading in layouted version

    Revision 1.2  1999/11/25 16:03:31  mi
    welforming HTML for XML

    Revision 1.1.1.1  1999/11/11 09:48:40  jsc
    new


=============================================================================*/
#endif