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