1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_FileContentProvider_idl__
24#define __com_sun_star_ucb_FileContentProvider_idl__
25
26#ifndef __com_sun_star_ucb_XContentProvider_idl__
27#include <com/sun/star/ucb/XContentProvider.idl>
28#endif
29#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
30#include <com/sun/star/ucb/XFileIdentifierConverter.idl>
31#endif
32#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
33#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
34#endif
35#ifndef __com_sun_star_beans_XPropertySet_idl__
36#include <com/sun/star/beans/XPropertySet.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module ucb {
42
43//=============================================================================
44/** The File Content Provider (FCP) implements a <type>ContentProvider</type>
45    for the <Type>UniversalContentBroker</type> (UCB).
46
47	<p>The served contents enable access to the local file system.
48
49	<p>The FCP is able to restrict access to the local file system to a number
50	of directories shown to the client under configurable aliasnames.
51
52	@see com::sun::star::ucb::Content
53*/
54published service FileContentProvider
55{
56	//-------------------------------------------------------------------------
57	/** provides an object representing either a directory or a file in the
58	    local file system.
59
60		@see com::sun::star::ucb::FileContent
61	 */
62
63	interface com::sun::star::ucb::XContentProvider;
64
65	//-------------------------------------------------------------------------
66	/** This interface is implemented according to the specification of
67		service <type>ContentProvider</type>.
68	*/
69
70	interface com::sun::star::ucb::XContentIdentifierFactory;
71
72	//-------------------------------------------------------------------------
73	/** provides access to properties supported by the UCP.
74
75		<p> The supported properties give two kinds	of meta-information	about
76		the environment of the FCP, namely property	<b>HostName</b> containing
77		the name of the computer, and property <b>FileSystemNotation</b>
78		determining which system dependent notation	the file system identifier
79		follow.
80
81	   	<p>
82
83	   	<b>Supported Properties</b>
84	   	<ul>
85	   	<li>
86	   	string HostName ( read-only )
87	   	</li>
88	   	<li>
89	   	long FileSystemNotation ( read-only, the value is one of the
90		<type>FileSystemNotation</type> constants )
91	   	</li>
92	   	</ul>
93
94	   	</p>
95	*/
96
97	interface com::sun::star::beans::XPropertySet;
98
99	//-------------------------------------------------------------------------
100	/** specifies methods to convert between (file) URLs and file paths in
101	    system dependent notation
102	*/
103
104	interface com::sun::star::ucb::XFileIdentifierConverter;
105};
106
107//=============================================================================
108
109}; }; }; };
110
111#endif
112