summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/configuration/backend/xml/LayerParser.idl
blob: 53a90edcd0a4ede2a8bc2c2415d03c585ce4703f (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
/* -*- 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_configuration_backend_xml_LayerParser_idl__
#define __com_sun_star_configuration_backend_xml_LayerParser_idl__

#include <com/sun/star/configuration/backend/XLayer.idl>
#include <com/sun/star/io/XActiveDataSink.idl>
#include <com/sun/star/lang/XInitialization.idl>


module com { module sun { module star { module configuration { module backend {
module xml {


/**
    represents a configuration data layer that is stored in a stream in
    OOR Update XML format.

    <p> The configuration layer XML from a given stream is parsed and fed to a
    com::sun::star::configuration::backend::XLayerHandler.
    </p>

    @see com::sun::star::configuration::backend::xml::SchemaParser
        Service that represents a configuration schema stored in XML.

    @see com::sun::star::configuration::backend::xml::LayerWriter
        Service that writes OOR Update XML for data described via
        com::sun::star::configuration::backend::XLayerHandler.

    @since OOo 1.1.2
*/
published service LayerParser
{

    /** provides access to the parsed layer data.
      */
    interface com::sun::star::configuration::backend::XLayer ;


    /** provides access to the source XML stream.
      */
    interface com::sun::star::io::XActiveDataSink ;


    /** allows initializing the source stream.

        <p> The source can be passed
            as a com::sun::star::io::XInputStream or
            as a com::sun::star::xml::sax::InputSource.
        </p>
      */
    interface com::sun::star::lang::XInitialization ;

} ;

} ;
} ; } ; } ; } ; } ;

#endif

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