xref: /trunk/main/offapi/com/sun/star/configuration/backend/xml/LayerParser.idl (revision 0d3a54ff)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_configuration_backend_xml_LayerParser_idl__
#define __com_sun_star_configuration_backend_xml_LayerParser_idl__

#ifndef __com_sun_star_configuration_backend_XLayer_idl__
#include <com/sun/star/configuration/backend/XLayer.idl>
#endif

#ifndef __com_sun_star_io_XActiveDataSink_idl__
#include <com/sun/star/io/XActiveDataSink.idl>
#endif

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

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

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
    <type scope="com::sun::star::configuration::backend">XLayerHandler</type>.
    </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
        <type scope="com::sun::star::configuration::backend">XLayerHandler</type>.

    @since OpenOffice 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 <type scope="com::sun::star::io">XInputStream</type> or
            as a <type scope="com::sun::star::xml::sax">InputSource</type>.
        </p>
      */
    interface com::sun::star::lang::XInitialization ;

	//-------------------------------------------------------------------------
} ;

//=============================================================================
} ;
} ; } ; } ; } ; } ;

#endif