offapi/com/sun/star/ucb/XRemoteContentProviderActivator.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
  20 #ifndef __com_sun_star_ucb_XRemoteContentProviderActivator_idl__
  21 #define __com_sun_star_ucb_XRemoteContentProviderActivator_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 module com { module sun { module star { module ucb {
  26
  27  published interface XContentProviderManager;
  28
  29 /** This interface should be implemented together with
  30     XRemoteContentProviderAcceptor and allows for a lazy
  31     implementation of
  32     XRemoteContentProviderAcceptor::addRemoteContentProvider().
  33
  34     The way this works might change, therefore this interface is marked as
  35     deprecated.
  36
  37     @deprecated
  38  */
  39 published interface XRemoteContentProviderActivator: com::sun::star::uno::XInterface
  40 {
  41     /** Activate (i.e., register at the broker) the remote content providers
  42         that until now have only been remembered by
  43         XRemoteContentProviderAcceptor::addRemoteContentProvider(),
  44         but not registered.
  45
  46         <p>This allows for
  47         XRemoteContentProviderAcceptor::addRemoteContentProvider()
  48         to be implemented in a lazy fashion (remember the remote content
  49         providers, but do not register them right away), which can increase
  50         performance in certain situations.  But it is not required that an
  51         implementation of XRemoteContentProviderAcceptor uses this
  52         lazy strategy (and thus also implements this interface).
  53
  54         @return
  55         the broker at which the remote content providers have been registered.
  56      */
  57     XContentProviderManager activateRemoteContentProviders();
  58 };
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */