1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_configuration_backend_xml_LayerParser_idl__
28#define __com_sun_star_configuration_backend_xml_LayerParser_idl__
29
30#ifndef __com_sun_star_configuration_backend_XLayer_idl__
31#include <com/sun/star/configuration/backend/XLayer.idl>
32#endif
33
34#ifndef __com_sun_star_io_XActiveDataSink_idl__
35#include <com/sun/star/io/XActiveDataSink.idl>
36#endif
37
38#ifndef __com_sun_star_lang_XInitialization_idl__
39#include <com/sun/star/lang/XInitialization.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module configuration { module backend {
45module xml {
46
47//=============================================================================
48
49/**
50    represents a configuration data layer that is stored in a stream in
51    OOR Update XML format.
52
53    <p> The configuration layer xml from a given stream is parsed and fed to a
54    <type scope="com::sun::star::configuration::backend">XLayerHandler</type>.
55    </p>
56
57    @see com::sun::star::configuration::backend::xml::SchemaParser
58        Service that represents a configuration schema stored in xml.
59
60    @see com::sun::star::configuration::backend::xml::LayerWriter
61        Service that writes OOR Update XML for data described via
62        <type scope="com::sun::star::configuration::backend">XLayerHandler</type>.
63
64    @since OOo 1.1.2
65*/
66published service LayerParser
67{
68	//-------------------------------------------------------------------------
69
70    /** provides access to the parsed layer data.
71      */
72    interface com::sun::star::configuration::backend::XLayer ;
73
74	//-------------------------------------------------------------------------
75
76    /** provides access to the source xml stream.
77      */
78    interface com::sun::star::io::XActiveDataSink ;
79
80	//-------------------------------------------------------------------------
81
82    /** allows initializing the source stream.
83
84        <p> The source can be passed
85            as a <type scope="com::sun::star::io">XInputStream</type> or
86            as a <type scope="com::sun::star::xml::sax">InputSource</type>.
87        </p>
88      */
89    interface com::sun::star::lang::XInitialization ;
90
91	//-------------------------------------------------------------------------
92} ;
93
94//=============================================================================
95} ;
96} ; } ; } ; } ; } ;
97
98#endif
99