offapi/com/sun/star/ucb/ContentProviderProxy.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_ucb_ContentProviderProxy_idl__
  20 #define __com_sun_star_ucb_ContentProviderProxy_idl__
  21
  22 #include <com/sun/star/ucb/XContentProviderSupplier.idl>
  23 #include <com/sun/star/ucb/XContentProvider.idl>
  24 #include <com/sun/star/ucb/XParameterizedContentProvider.idl>
  25
  26
  27 module com { module sun { module star { module ucb {
  28
  29 /** is a proxy for a content provider.
  30
  31     <p>Implementing a content provider proxy can be useful if the creation of
  32     the real content provider object shall be deferred for some reason
  33     (i.e. performance) until the first method gets called on it. Instead of
  34     instantiating and registering the real provider at the UCB, a proxy for
  35     the real provider can be created and registered at the UCB.
  36
  37     @see XContentProviderProxyFactory
  38 */
  39 published service ContentProviderProxy
  40 {
  41     /** The implementation of
  42         com::sun::star::uno::XInterface::queryInterface()
  43         must instantiate the real provider and return the return value
  44         of a queryInterface call at the real provider, except for queries
  45         for the interfaces implemented by the proxy itself. So the caller of
  46         the queryInterface method at the proxy will get access to the real
  47         provider in a completely transparent way.
  48      */
  49     interface com::sun::star::uno::XInterface;
  50
  51     /** gives access to the original content provider behind the proxy.
  52
  53         <p>The implementation will instantiate the real content provider only
  54         on demand using its UNO service name. This will load the content
  55         providers implementation code (dynamic library), if not already done.
  56      */
  57     interface com::sun::star::ucb::XContentProviderSupplier;
  58
  59     /** a content provider implementation that wraps the original provider.
  60      */
  61     interface com::sun::star::ucb::XContentProvider;
  62
  63     /** a parameterized content provider implementation that wraps the
  64         original provider.
  65      */
  66     interface com::sun::star::ucb::XParameterizedContentProvider;
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */