udkapi/com/sun/star/bridge/XBridge.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_XBRIDGE_IDL_
  20 #define _COM_SUN_STAR_BRIDGE_XBRIDGE_IDL_
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 module com {  module sun {  module star {  module bridge {
  25
  26 /** main interface for an interprocess bridge.
  27  */
  28 published interface XBridge: com::sun::star::uno::XInterface
  29 {
  30     /** tries to get an interface from the remote that is known by this name.
  31
  32         <p>In general, this method is called once to get the initial object from the
  33         remote, but it is allowed to call the method multiple times. </p>
  34
  35         @param sInstanceName The name of the object, that shall be retrieved from the
  36                              remote process. The call is delegated to
  37                              com.sun.star.bridge.XInstanceProvider.getInstance() in the
  38                              remote process.
  39         @see com.sun.star.bridge.XInstanceProvider
  40      */
  41     com::sun::star::uno::XInterface getInstance( [in] string sInstanceName );
  42
  43
  44     /** name that the bridge got when it was created.
  45      */
  46     string getName();
  47
  48
  49     /** a unique descriptive string: protocol + ":" + XConnection.getDescription()
  50      */
  51     string getDescription();
  52 };
  53
  54 };};};};
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */