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

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