summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/document/XDocumentSubStorageSupplier.idl
blob: 044bd98f348dcd4d2a9c664a01818f20189cf56f (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
/* -*- 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_document_XDocumentSubStorageSupplier_idl__
#define __com_sun_star_document_XDocumentSubStorageSupplier_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/embed/XStorage.idl>



module com {   module sun {   module star {   module document {

/** through this interface documents can provide access to their substorages

    <p>
    A temporary interface to get access to documents substorages.
    </p>
 */
interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface
{
    /** provides the access to a substorage with specified name

        @param StorageName
            the name of requested substorage

        @param nMode
            a mode the storage should be opened in can take value from ::com::sun::star::embed::ElementModes

        @returns
            XStorage implementation that refers to specified substorage
     */
    com::sun::star::embed::XStorage getDocumentSubStorage(
                                        [in] string StorageName,
                                        [in] long nMode );

    /** provides the list of substorages

        @returns
            sequence of substorages names
     */
    sequence< string > getDocumentSubStoragesNames()
        raises( ::com::sun::star::io::IOException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */