#78373#

Idl-files describing service com.sun.star.FileContentProvider

1 files changed, 141 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ucb/FileContentProvider.idl b/offapi/com/sun/star/ucb/FileContentProvider.idl
new file mode 100644
index 000000000..9649798ad
--- /dev/null
+++ b/offapi/com/sun/star/ucb/FileContentProvider.idl
@@ -0,0 +1,141 @@
+/*************************************************************************
+ *
+ *  $RCSfile: FileContentProvider.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: abi $ $Date: 2001-04-27 09:27:32 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#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 Content Provider
+    for the Universal Content Broker (UCB). The served contents enable
+    access to the local file system.
+    In addition, it implements a XPropertySet giving two kinds of meta-information
+    about the environment of the FCP, namely property HostName containing the
+    name of the computer, and property <type>FileSystemNotation</type> determining which
+    system dependent notation the file system identifier follow.
+    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::UniversalContentBroker
+    @see com::sun::star::ucb::ContentProvider
+    @see com::sun::star::ucb::Content
+*/
+service FileContentProvider
+{
+    //-------------------------------------------------------------------------
+    /** provides an object representing either a directory or a file in the local
+        file system. See <type>FileContent</type>.
+     */
+
+    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;
+
+    //-------------------------------------------------------------------------
+    /**	   
+       <p>
+       <b>Supported Properties</b>
+       <ul>
+       <li>
+       string HostName ( read-only )
+       </li>
+       <li>
+       long FileSystemNotation ( read-only, for allowed values <type>FileSystemNotation</type> )
+       </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