summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/FileContentProvider.idl
blob: f1545106bac5023208be3b933f77402d25980a3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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