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_FileContentProvider_idl__
28#define __com_sun_star_ucb_FileContentProvider_idl__
29
30#ifndef __com_sun_star_ucb_XContentProvider_idl__
31#include <com/sun/star/ucb/XContentProvider.idl>
32#endif
33#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
34#include <com/sun/star/ucb/XFileIdentifierConverter.idl>
35#endif
36#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
37#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
38#endif
39#ifndef __com_sun_star_beans_XPropertySet_idl__
40#include <com/sun/star/beans/XPropertySet.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module ucb {
46
47//=============================================================================
48/** The File Content Provider (FCP) implements a <type>ContentProvider</type>
49    for the <Type>UniversalContentBroker</type> (UCB).
50
51	<p>The served contents enable access to the local file system.
52
53	<p>The FCP is able to restrict access to the local file system to a number
54	of directories shown to the client under configurable aliasnames.
55
56	@see com::sun::star::ucb::Content
57*/
58published service FileContentProvider
59{
60	//-------------------------------------------------------------------------
61	/** provides an object representing either a directory or a file in the
62	    local file system.
63
64		@see com::sun::star::ucb::FileContent
65	 */
66
67	interface com::sun::star::ucb::XContentProvider;
68
69	//-------------------------------------------------------------------------
70	/** This interface is implemented according to the specification of
71		service <type>ContentProvider</type>.
72	*/
73
74	interface com::sun::star::ucb::XContentIdentifierFactory;
75
76	//-------------------------------------------------------------------------
77	/** provides access to properties supported by the UCP.
78
79		<p> The supported properties give two kinds	of meta-information	about
80		the environment of the FCP, namely property	<b>HostName</b> containing
81		the name of the computer, and property <b>FileSystemNotation</b>
82		determining which system dependent notation	the file system identifier
83		follow.
84
85	   	<p>
86
87	   	<b>Supported Properties</b>
88	   	<ul>
89	   	<li>
90	   	string HostName ( read-only )
91	   	</li>
92	   	<li>
93	   	long FileSystemNotation ( read-only, the value is one of the
94		<type>FileSystemNotation</type> constants )
95	   	</li>
96	   	</ul>
97
98	   	</p>
99	*/
100
101	interface com::sun::star::beans::XPropertySet;
102
103	//-------------------------------------------------------------------------
104	/** specifies methods to convert between (file) URLs and file paths in
105	    system dependent notation
106	*/
107
108	interface com::sun::star::ucb::XFileIdentifierConverter;
109};
110
111//=============================================================================
112
113}; }; }; };
114
115#endif
116