summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
blob: ce5551d6583a08a3a0ea33daa96757dab3e7b0ca (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XStandaloneDocumentInfo.idl,v $
 * $Revision: 1.10 $
 *
 * 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_document_XStandaloneDocumentInfo_idl__
#define __com_sun_star_document_XStandaloneDocumentInfo_idl__

#ifndef __com_sun_star_document_XDocumentInfo_idl__
#include <com/sun/star/document/XDocumentInfo.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

//=============================================================================

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

//=============================================================================
/** makes it possible to load document information from
    a resource specified by a URL and to store it into a resource also
    specified by a URL

    <p>
    Only the document information part of the resource is transferred.
    Instead of <type>DocumentInfo</type> not the whole document will be opened.
    Note: Without specifying the source or target of this info (the document)
    nothing can work and will be handled as void (for reading) or ignored (for writing).
    After specigiying the source/target by using this interface,
    the interface <type>XDocumentInfo</type> (which must be implemented on same
    object then this one!) provides access to the info properties.
    </p>

    @deprecated     Use <type>XDocumentProperties</type> instead.

    @see DocumentInfo
    @see StandaloneDocumentInfo
    @see XDocumentInfo
 */
published interface XStandaloneDocumentInfo: XDocumentInfo
{
    //-------------------------------------------------------------------------
    /** loads the document information from a file referred by an URL

        <p>
        After an unsuccessful call the contents of the document
        information are undefined (void).
        This method only works for storage file formats.
        </p>

        @param URL
            specifies the source of information

        @throws com::sun::star::io::IOException
            if storage couldn't be found or opened
     */
    void loadFromURL( [in] string URL )
        raises( com::sun::star::io::IOException );

    //-------------------------------------------------------------------------
    /** stores the document information into a file referred by a URL

        <p>
        Only the document information part of the document is overwritten.
        This method only works for storage file formats.
        </p>

        @param URL
            specifies the target for saving

        @throws com::sun::star::io::IOException
            if storage couldn't be found or opened
     */
    void storeIntoURL( [in] string URL )
        raises( com::sun::star::io::IOException );
};

//=============================================================================

}; }; }; };

#endif