xref: /aoo41x/main/offapi/com/sun/star/ucb/FileContentProvider.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_FileContentProvider_idl__
#define __com_sun_star_ucb_FileContentProvider_idl__

#ifndef __com_sun_star_ucb_XContentProvider_idl__
#include <com/sun/star/ucb/XContentProvider.idl>
#endif
#ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
#include <com/sun/star/ucb/XFileIdentifierConverter.idl>
#endif
#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** The File Content Provider (FCP) implements a <type>ContentProvider</type>
    for the <Type>UniversalContentBroker</type> (UCB).

	<p>The served contents enable access to the local file system.

	<p>The FCP is able to restrict access to the local file system to a number
	of directories shown to the client under configurable aliasnames.

	@see com::sun::star::ucb::Content
*/
published service FileContentProvider
{
	//-------------------------------------------------------------------------
	/** provides an object representing either a directory or a file in the
	    local file system.

		@see com::sun::star::ucb::FileContent
	 */

	interface com::sun::star::ucb::XContentProvider;

	//-------------------------------------------------------------------------
	/** This interface is implemented according to the specification of
		service <type>ContentProvider</type>.
	*/

	interface com::sun::star::ucb::XContentIdentifierFactory;

	//-------------------------------------------------------------------------
	/** provides access to properties supported by the UCP.

		<p> The supported properties give two kinds	of meta-information	about
		the environment of the FCP, namely property	<b>HostName</b> containing
		the name of the computer, and property <b>FileSystemNotation</b>
		determining which system dependent notation	the file system identifier
		follow.

	   	<p>

	   	<b>Supported Properties</b>
	   	<ul>
	   	<li>
	   	string HostName ( read-only )
	   	</li>
	   	<li>
	   	long FileSystemNotation ( read-only, the value is one of the
		<type>FileSystemNotation</type> constants )
	   	</li>
	   	</ul>

	   	</p>
	*/

	interface com::sun::star::beans::XPropertySet;

	//-------------------------------------------------------------------------
	/** specifies methods to convert between (file) URLs and file paths in
	    system dependent notation
	*/

	interface com::sun::star::ucb::XFileIdentifierConverter;
};

//=============================================================================

}; }; }; };

#endif