summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/bridge/XBridge.idl
blob: 41fc2d4344c56607ebe789262a7fcf591bbe4d39 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef _COM_SUN_STAR_BRIDGE_XBRIDGE_IDL_
#define _COM_SUN_STAR_BRIDGE_XBRIDGE_IDL_

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

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

/** main interface for an interprocess bridge.
 */
published interface XBridge: com::sun::star::uno::XInterface
{
    /** tries to get an interface from the remote that is known by this name.

        <p>In general, this method is called once to get the initial object from the
        remote, but it is allowed to call the method multiple times. </p>

        @param sInstanceName The name of the object, that shall be retrieved from the
                             remote process. The call is delegated to
                             com.sun.star.bridge.XInstanceProvider.getInstance() in the
                             remote process.
        @see com::sun::star::bridge::XInstanceProvider
     */
    com::sun::star::uno::XInterface getInstance( [in] string sInstanceName );


    /** name that the bridge got when it was created.
     */
    string getName();


    /** a unique descriptive string: protocol + ":" + XConnection.getDescription()
     */
    string getDescription();
};

};};};};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */