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