offapi/com/sun/star/ucb/ContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_ContentProvider_idl__
  28 #define __com_sun_star_ucb_ContentProvider_idl__
  29
  30 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  31 #include <com/sun/star/ucb/XContentProvider.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
  35 #include <com/sun/star/ucb/XContentIdentifierFactory.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
  39 #include <com/sun/star/ucb/XParameterizedContentProvider.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_ucb_XContentProviderSupplier_idl__
  43 #include <com/sun/star/ucb/XContentProviderSupplier.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** provides access to a set of <type>Content</type>s.
  52 */
  53 published service ContentProvider
  54 {
  55     //-------------------------------------------------------------------------
  56     /** gives access to all contents provided by this provider.
  57      */
  58     interface com::sun::star::ucb::XContentProvider;
  59
  60     //-------------------------------------------------------------------------
  61     /** creates special <type>XContentIdentifier</type> implementation
  62         objects for the contents provided by this content provider.
  63
  64         <p>This interface can be implemented in case the provider wants to
  65         provide some additional interfaces with its implementation of the
  66         identifier objects.
  67      */
  68     [optional] interface com::sun::star::ucb::XContentIdentifierFactory;
  69
  70     //-------------------------------------------------------------------------
  71     /** allows a <type>ContentProvider</type> to adjust itself to special
  72         needs.
  73
  74         <p>Whenever a ContentProvider that supports this interface is
  75         registered at a <type>XContentProviderManager</type>, the method
  76         <member>XParameterizedContentProvider::registerInstance</member>
  77         should first be called, using the returned <type>XContentProvider</type>
  78         to register at the XContentProviderManager.
  79      */
  80     [optional] interface com::sun::star::ucb::XParameterizedContentProvider;
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif