summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/document/XMLOasisBasicExporter.idl
blob: 0ce30a82f4754821cccc7f73e69fcb235e0197f5 (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
/*************************************************************************
 *
 * 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: XMLOasisBasicExporter.idl,v $
 * $Revision: 1.4 $
 *
 * 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_XMLOasisBasicExporter_idl__
#define __com_sun_star_document_XMLOasisBasicExporter_idl__

#ifndef __com_sun_star_document_XExporter_idl__
#include <com/sun/star/document/XExporter.idl>
#endif

#ifndef __com_sun_star_document_XFilter_idl__
#include <com/sun/star/document/XFilter.idl>
#endif

#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif


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

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

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

/** Filter for exporting Basic macros to the OASIS Open Office file format.

    <p>First the <method>XExporter::setSourceDocument</method> method must be
    called in order to provide the export component with the source document
    from which the data should be exported. After that, the export is started
    by calling the <method>XFilter::filter</method> method.</p>

    @since OOo 2.0.0
 */
published service XMLOasisBasicExporter
{
    //-------------------------------------------------------------------------

    /** sets the source document for this filter.
     */
    interface com::sun::star::document::XExporter;

    //-------------------------------------------------------------------------

    /** filters the document.
     */
    interface com::sun::star::document::XFilter;

    //-------------------------------------------------------------------------

    /** initializes the component.
     */
    [optional] interface com::sun::star::lang::XInitialization;

};

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

}; }; }; };

#endif