blob: 42575ff2025a162805272c6b4a635f5b2032666a (
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
|
/* -*- 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_embed_FileSystemStorageFactory_idl__
#define __com_sun_star_embed_FileSystemStorageFactory_idl__
#include <com/sun/star/lang/XSingleServiceFactory.idl>
module com { module sun { module star { module embed {
/** The <type>FileSystemStorageFactory</type> is a service that allows to
create a <type>FileSystemStorage</type> based on URL. The URL must point
to a folder.
<p>
In case
<method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method>
call is used the result storage will be open in read-write mode based
on an arbitrary file system folder.
</p>
<p>
In case
<method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method>
call is used a sequence of the following parameters can be used:
</p>
<dl>
<dt>parameter 1</dt>
<dd>
specifies source of the object, it must be a string
containing URL.
</dd>
<dt>parameter 2</dt>
<dd>
specifies mode the storage should be open in, can take
values from <type>ElementModes</type> constant set.
</dd>
<dt>parameter 3</dt>
<dd>
allows to provide
<type scope="com::sun::star::document">MediaDescryptor</type>
to the storage so some parts can be used for
initialization, it can be for example
<type scope="com::sun::star::task">XInteractionHandler</type>
implementation.
</dd>
</dl>
<p>
The parameters are optional, that means that sequence can be empty or
contain only first parameter, or first and second one. In case
no parameters are provided the call works the same way as
<member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>.
In case only first parameter is provided, the storage is opened in
readonly mode.
</p>
<p>
The opened storages can support read access in addition to
specified one.
</p>
*/
published service FileSystemStorageFactory
: ::com::sun::star::lang::XSingleServiceFactory;
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
