offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.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
  21
  22 module com { module sun { module star { module ucb {
  23
  24  published interface XRemoteContentProviderDoneListener;
  25
  26 /** Accept remote content providers that want to make themselves known to the
  27     local process.
  28
  29     @version 1.0
  30 */
  31 published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterface
  32 {
  33     /** Add a remote content provider.
  34
  35         @param Identifier  An arbitrary identifier uniquely identifying the
  36         remote content provider.
  37
  38         @param Factory  A factory through which the remote content provider's
  39         UniversalContentBroker service can be instantiated.
  40
  41         @param Templates  A sequence of URL templates the remote content
  42         provider is willing to handle.
  43
  44         @param DoneListener  If not null, the implementation of this interface
  45         can---through this callback---tell the calling side that the
  46         implementation no longer needs the remote content provider.  (And the
  47         calling side should call
  48         XRemoteContentProviderAcceptor::removeRemoteContentProvider()
  49         then.)
  50
  51         To enable connection control, it is recommended that this argument
  52         also implements the interface
  53         XRemoteContentProviderConnectionControl.
  54
  55         @return  true if the remote content provider has successfully been
  56         added.
  57     */
  58     boolean
  59     addRemoteContentProvider([in] string Identifier,
  60                              [in] com::sun::star::lang::XMultiServiceFactory
  61                                      Factory,
  62                              [in] sequence< string > Templates,
  63                              [in] XRemoteContentProviderDoneListener
  64                                       DoneListener);
  65
  66     /** Remove a remote content provider.
  67
  68         @param Identifier  An arbitrary identifier uniquely identifying the
  69         remote content provider.
  70
  71         @return  true if the remote content provider has successfully been
  72         removed.
  73     */
  74     boolean
  75     removeRemoteContentProvider([in] string Identifier);
  76 };
  77
  78
  79 }; }; }; };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */