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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef __com_sun_star_ucb_FileContent_idl__
#define __com_sun_star_ucb_FileContent_idl__
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/ucb/XContent.idl>
#include <com/sun/star/ucb/XCommandProcessor.idl>
#include <com/sun/star/ucb/XCommandProcessor2.idl>
#include <com/sun/star/ucb/XContentCreator.idl>
#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
#include <com/sun/star/beans/XPropertyContainer.idl>
#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
#include <com/sun/star/container/XChild.idl>
module com { module sun { module star { module ucb {
/** A File Content represents either a directory or a file in the local file
system.
<p>Whether a content represents a folder or a file can be determined by
inspecting its property <b>IsFolder</b> or <b>IsDocument</b>.
@see com::sun::star::ucb::FileContentProvider
*/
published service FileContent
{
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::lang::XComponent;
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XContent;
/** This interface is implemented according to the specification of
service Content.
<p>An object representing a directory in the file system is able
to create a new object, which in turn can become the representation
of a physical file/directory being contained in the initial directory.
The precise way is the following:
<p>
<ol>
<li>
Let the parent folder create a new content by calling
XContentCreator::createNewContent() on it. The content
type to use for new directories is
"application/vnd.sun.staroffice.fsys-folder". To create a new file
use the type "application/vnd.sun.staroffice.fsys-file".
As return value you get a new file content object.
</li>
<li>
Set a title at the new object by letting it execute
the command "setPropertyValues", which sets at least the property
"Title" to a non-empty value ).
</li>
<li>
Let the new object ( not the parent! ) execute the command "insert".
This will create the corresponding physical file or directory.
For files, you need to supply the implementation of
a com::sun::star::io::XInputStream with the
command's parameters, that provides access to the stream data.
</li>
</ol>
</p>
*/
interface com::sun::star::ucb::XContentCreator;
/** This interface is implemented according to the specification of
service Content.
<p>
<b>Supported Commands</b>
<ul>
<li>
getCommandInfo
</li>
<li>
getPropertySetInfo
</li>
<li>
getPropertyValues
</li>
<li>
setPropertyValues
</li>
<li>
insert ( makes a newly created document persistent )
</li>
<li>
delete
</li>
<li>
open
</li>
<li>
transfer
</li>
</ul>
<b>Supported Properties</b>
<ul>
<li>
string ContentType ( read-only, either
"application/vnd.sun.staroffice.fsys-folder" or
"application/vnd.sun.staroffice.fsys-file" )
</li>
<li>
boolean IsDocument ( read-only, always `TRUE` for files, always
`FALSE` for directories )
</li>
<li>
boolean IsFolder ( read-only ), always `FALSE` for files, always
`TRUE` for directories )
</li>
<li>
com::sun::star::util::DateTime DateModified ( read-only )
</li>
<li>
boolean IsReadOnly ( read-only attribute )
</li>
<li>
hyper Size ( file size )
</li>
<li>
string Title ( file name )
</li>
<li>
boolean IsVolume ( read-only )
</li>
<li>
boolean IsRemoveable ( read-only )
</li>
<li>
boolean IsRemote ( read-only )
</li>
<li>
boolean IsCompactDisc ( read-only )
</li>
<li>
boolean IsFloppy ( read-only )
</li>
<li>
boolean IsHidden ( read-only )
</li>
</ul>
</p>
*/
interface com::sun::star::ucb::XCommandProcessor;
/** is an enhanced version of XCommandProcessor that has an
additional method for releasing command identifiers obtained via
XCommandProcessor::createCommandIdentifier() to avoid
resource leaks. For a detailed description of the problem refer to
XCommandProcessor2::releaseCommandIdentifier().
<p>Where many existing Content implementations do not
(yet), every new implementation should support this interface.
*/
[optional] interface com::sun::star::ucb::XCommandProcessor2;
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertiesChangeNotifier;
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertyContainer;
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::ucb::XCommandInfoChangeNotifier;
/** This interface is implemented according to the specification of
service Content.
*/
interface com::sun::star::container::XChild;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
