xref: /AOO41X/main/offapi/com/sun/star/embed/BaseStorage.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_embed_BaseStorage_idl__
25#define __com_sun_star_embed_BaseStorage_idl__
26
27#ifndef __com_sun_star_embed_XStorage_idl__
28#include <com/sun/star/embed/XStorage.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XPropertySet_idl__
32#include <com/sun/star/beans/XPropertySet.idl>
33#endif
34
35
36//============================================================================
37
38 module com {  module sun {  module star {  module embed {
39
40//============================================================================
41/** This is a service that allows to get access to a storage hierarchy.
42 */
43published service BaseStorage
44{
45    // -----------------------------------------------------------------------
46    /** This is a general interface representing storage functionality.
47        It allows to copy storages, get access to child elements and to
48        control lifetime.
49     */
50    interface ::com::sun::star::embed::XStorage;
51
52    // -----------------------------------------------------------------------
53    /** allows to get access to storage properties.
54     */
55    interface ::com::sun::star::beans::XPropertySet;
56
57    // -----------------------------------------------------------------------
58    /** allows to get the mode the storage is opened in.
59
60        <p>
61        Can be a combination of values from <type>ElementModes</type>.
62        </p>
63     */
64    [property, readonly] long OpenMode;
65
66    // -----------------------------------------------------------------------
67    /** allows to retrieve URL the storage is based on.
68     */
69    [property, optional, readonly] string URL;
70
71};
72
73//============================================================================
74
75}; }; }; };
76
77#endif
78
79