offapi/com/sun/star/configuration/backend/xml/LayerParser.idl

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