offapi/com/sun/star/ucb/FileContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FileContentProvider.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_FileContentProvider_idl__
  31 #define __com_sun_star_ucb_FileContentProvider_idl__
  32
  33 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  34 #include <com/sun/star/ucb/XContentProvider.idl>
  35 #endif
  36 #ifndef __com_sun_star_ucb_XFileIdentifierConverter_idl__
  37 #include <com/sun/star/ucb/XFileIdentifierConverter.idl>
  38 #endif
  39 #ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
  40 #include <com/sun/star/ucb/XContentIdentifierFactory.idl>
  41 #endif
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com { module sun { module star { module ucb {
  49
  50 //=============================================================================
  51 /** The File Content Provider (FCP) implements a <type>ContentProvider</type>
  52     for the <Type>UniversalContentBroker</type> (UCB).
  53
  54     <p>The served contents enable access to the local file system.
  55
  56     <p>The FCP is able to restrict access to the local file system to a number
  57     of directories shown to the client under configurable aliasnames.
  58
  59     @see com::sun::star::ucb::Content
  60 */
  61 published service FileContentProvider
  62 {
  63     //-------------------------------------------------------------------------
  64     /** provides an object representing either a directory or a file in the
  65         local file system.
  66
  67         @see com::sun::star::ucb::FileContent
  68      */
  69
  70     interface com::sun::star::ucb::XContentProvider;
  71
  72     //-------------------------------------------------------------------------
  73     /** This interface is implemented according to the specification of
  74         service <type>ContentProvider</type>.
  75     */
  76
  77     interface com::sun::star::ucb::XContentIdentifierFactory;
  78
  79     //-------------------------------------------------------------------------
  80     /** provides access to properties supported by the UCP.
  81
  82         <p> The supported properties give two kinds     of meta-information     about
  83         the environment of the FCP, namely property     <b>HostName</b> containing
  84         the name of the computer, and property <b>FileSystemNotation</b>
  85         determining which system dependent notation     the file system identifier
  86         follow.
  87
  88            <p>
  89
  90            <b>Supported Properties</b>
  91            <ul>
  92            <li>
  93            string HostName ( read-only )
  94            </li>
  95            <li>
  96            long FileSystemNotation ( read-only, the value is one of the
  97         <type>FileSystemNotation</type> constants )
  98            </li>
  99            </ul>
 100
 101            </p>
 102     */
 103
 104     interface com::sun::star::beans::XPropertySet;
 105
 106     //-------------------------------------------------------------------------
 107     /** specifies methods to convert between (file) URLs and file paths in
 108         system dependent notation
 109     */
 110
 111     interface com::sun::star::ucb::XFileIdentifierConverter;
 112 };
 113
 114 //=============================================================================
 115
 116 }; }; }; };
 117
 118 #endif