summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document/XStandaloneDocumentInfo.idl
blob: da5ae47406e80da991c4d46b3e4268cb2b420907 (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
/* -*- 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_XStandaloneDocumentInfo_idl__
#define __com_sun_star_document_XStandaloneDocumentInfo_idl__

#include <com/sun/star/document/XDocumentInfo.idl>
#include <com/sun/star/io/IOException.idl>


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 specifying 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

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