offapi/com/sun/star/ucb/ContentProvider.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_ContentProvider_idl__
  20 #define __com_sun_star_ucb_ContentProvider_idl__
  21
  22 #include <com/sun/star/ucb/XContentProvider.idl>
  23 #include <com/sun/star/ucb/XContentIdentifierFactory.idl>
  24 #include <com/sun/star/ucb/XParameterizedContentProvider.idl>
  25 #include <com/sun/star/ucb/XContentProviderSupplier.idl>
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** provides access to a set of Contents.
  31 */
  32 published service ContentProvider
  33 {
  34     /** gives access to all contents provided by this provider.
  35      */
  36     interface com::sun::star::ucb::XContentProvider;
  37
  38     /** creates special XContentIdentifier implementation
  39         objects for the contents provided by this content provider.
  40
  41         <p>This interface can be implemented in case the provider wants to
  42         provide some additional interfaces with its implementation of the
  43         identifier objects.
  44      */
  45     [optional] interface com::sun::star::ucb::XContentIdentifierFactory;
  46
  47     /** allows a ContentProvider to adjust itself to special
  48         needs.
  49
  50         <p>Whenever a ContentProvider that supports this interface is
  51         registered at a XContentProviderManager, the method
  52         XParameterizedContentProvider::registerInstance()
  53         should first be called, using the returned XContentProvider
  54         to register at the XContentProviderManager.
  55      */
  56     [optional] interface com::sun::star::ucb::XParameterizedContentProvider;
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */