xref: /trunk/main/offapi/com/sun/star/ucb/ContentProvider.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86) !
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_ContentProvider_idl__
24cdf0e10cSrcweir#define __com_sun_star_ucb_ContentProvider_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentProvider_idl__
27cdf0e10cSrcweir#include <com/sun/star/ucb/XContentProvider.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
31cdf0e10cSrcweir#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
35cdf0e10cSrcweir#include <com/sun/star/ucb/XParameterizedContentProvider.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentProviderSupplier_idl__
39cdf0e10cSrcweir#include <com/sun/star/ucb/XContentProviderSupplier.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir//=============================================================================
43cdf0e10cSrcweir
44cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
45cdf0e10cSrcweir
46cdf0e10cSrcweir//=============================================================================
47cdf0e10cSrcweir/** provides access to a set of <type>Content</type>s.
48cdf0e10cSrcweir*/
49cdf0e10cSrcweirpublished service ContentProvider
50cdf0e10cSrcweir{
51cdf0e10cSrcweir    //-------------------------------------------------------------------------
52cdf0e10cSrcweir    /** gives access to all contents provided by this provider.
53cdf0e10cSrcweir     */
54cdf0e10cSrcweir    interface com::sun::star::ucb::XContentProvider;
55cdf0e10cSrcweir
56cdf0e10cSrcweir    //-------------------------------------------------------------------------
57cdf0e10cSrcweir    /** creates special <type>XContentIdentifier</type> implementation
58cdf0e10cSrcweir        objects for the contents provided by this content provider.
59cdf0e10cSrcweir
60cdf0e10cSrcweir        <p>This interface can be implemented in case the provider wants to
61cdf0e10cSrcweir        provide some additional interfaces with its implementation of the
62cdf0e10cSrcweir        identifier objects.
63cdf0e10cSrcweir     */
64cdf0e10cSrcweir    [optional] interface com::sun::star::ucb::XContentIdentifierFactory;
65cdf0e10cSrcweir
66cdf0e10cSrcweir    //-------------------------------------------------------------------------
67cdf0e10cSrcweir    /** allows a <type>ContentProvider</type> to adjust itself to special
68cdf0e10cSrcweir        needs.
69cdf0e10cSrcweir
70cdf0e10cSrcweir        <p>Whenever a ContentProvider that supports this interface is
71cdf0e10cSrcweir        registered at a <type>XContentProviderManager</type>, the method
72cdf0e10cSrcweir        <member>XParameterizedContentProvider::registerInstance</member>
73cdf0e10cSrcweir        should first be called, using the returned <type>XContentProvider</type>
74cdf0e10cSrcweir        to register at the XContentProviderManager.
75cdf0e10cSrcweir     */
76cdf0e10cSrcweir    [optional] interface com::sun::star::ucb::XParameterizedContentProvider;
77cdf0e10cSrcweir
78cdf0e10cSrcweir};
79cdf0e10cSrcweir
80cdf0e10cSrcweir//=============================================================================
81cdf0e10cSrcweir
82cdf0e10cSrcweir}; }; }; };
83cdf0e10cSrcweir
84cdf0e10cSrcweir#endif
85