udkapi/com/sun/star/bridge/UrpBridge.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_UrpBridge_idl__
  20 #define __com_sun_star_bridge_UrpBridge_idl__
  21
  22 #include <com/sun/star/lang/XInitialization.idl>
  23 #include <com/sun/star/lang/XComponent.idl>
  24 #include <com/sun/star/bridge/XBridge.idl>
  25
  26
  27  module com {  module sun {  module star {  module bridge {
  28
  29 /** Concrete service of the meta service Bridge for the urp protocol.
  30
  31     <p>This bridge works with the urp protocol.
  32
  33    @see com.sun.star.bridge.Bridge
  34  */
  35 published service UrpBridge
  36 {
  37     /** This interface allows to initialize the bridge service with the necessary
  38         arguments. The sequence&lt;any&gt; must have 4 members.
  39
  40         <ol>
  41             <li> String: The unique name of the bridge or an empty string</li>
  42             <li> String: urp</li>
  43             <li> XConnection: The bidirectional connection, the bridge should work on</li>
  44             <li> XInstanceProvider:
  45                 The instance provider, that shall be called to access the initial object.</li>
  46         </ol>
  47      */
  48     interface com::sun::star::lang::XInitialization;
  49
  50     /** The main interface of the service.
  51      */
  52     interface com::sun::star::bridge::XBridge;
  53
  54     /** allows to terminate the interprocess bridge.
  55      */
  56     interface com::sun::star::lang::XComponent;
  57
  58 };
  59
  60 }; }; }; };
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */