offapi/com/sun/star/ucb/RemoteAccessContentProvider.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_RemoteAccessContentProvider_idl__
  20 #define __com_sun_star_ucb_RemoteAccessContentProvider_idl__
  21
  22 #include <com/sun/star/ucb/ContentProvider.idl>
  23 #include <com/sun/star/ucb/XParameterizedContentProvider.idl>
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** A RemoteAccessContentProvider is a
  29     ContentProvider that provides access to contents available at
  30     other (remote) UCBs.
  31 */
  32 published service RemoteAccessContentProvider
  33 {
  34     /** A RemoteAccessContentProvider is a specialized
  35         ContentProvider.
  36      */
  37     service com::sun::star::ucb::ContentProvider;
  38
  39     /** allows configuration of the RemoteAccessContentProvider,
  40         to specify that certain XContentIdentifiers map to
  41         XContents from a certain remote UCB.  The Arguments
  42         string in the
  43         XParameterizedContentProvider::registerInstance()
  44         call must contain the UNO URL of the remote UCB.
  45
  46         The XContentProviders obtained through this interface
  47         implement the service ContentProvider and, if
  48         appropriate, also the interface XFileIdentifierConverter.
  49      */
  50     interface com::sun::star::ucb::XParameterizedContentProvider;
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */