udkapi/com/sun/star/bridge/oleautomation/BridgeSupplier.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_oleautomation_BridgeSupplier_idl__
  20 #define __com_sun_star_bridge_oleautomation_BridgeSupplier_idl__
  21
  22 #include <com/sun/star/bridge/XBridgeSupplier2.idl>
  23
  24
  25
  26 module com { module sun { module star { module bridge { module oleautomation {
  27
  28 /** maps UNO types to oleautomation types and vice versa.
  29     <p>
  30     The function
  31     com::sun::star::bridge::XBridgeSupplier2::createBridge()
  32     maps a value of a UNO or Automation type to the desired target type. If a UNO
  33     interface was mapped  to <code>IDispatch</code>, then all objects
  34     (interfaces, structs) and other types which are obtained from that Automation
  35     object are automatically mapped to the corresponding Automation types. Hence,
  36     if one provides an initial object which forms the root of all other objects,
  37     such as a service manager, then only that object needs to be explicitly
  38     mapped by a call to
  39     com::sun::star::bridge::XBridgeSupplier2::createBridge().
  40     The same holds true if an automation  object is mapped to an UNO interface.
  41     </p>
  42     <p>
  43     For Automation objects to be mapped they have to implement
  44     <code>IDispatch</code> interface. Other COM interfaces, except for
  45     <code>IUnknown</code>, are not supported. UNO interfaces and structs are
  46     mapped to <code>IDispatch</code>.
  47     </p>
  48     <p>
  49     The service implements the
  50     com::sun::star::bridge::XBridgeSupplier2 interface and
  51     handles the model types
  52     com::sun::star::bridge::ModelDependent::UNO and
  53     com::sun::star::bridge::ModelDependent::OLE.
  54     The service does not specify any requirements for registering OLE objects and
  55     class factories.
  56     </p>
  57 */
  58 service BridgeSupplier
  59 {
  60     interface com::sun::star::bridge::XBridgeSupplier2;
  61
  62 };
  63
  64
  65 }; }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */