offapi/com/sun/star/xml/UserDefinedAttributesSupplier.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: UserDefinedAttributesSupplier.idl,v $
  10  * $Revision: 1.3 $
  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_xml_UserDefinedAttributesSupplier_idl_
  31 #define _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  32
  33 #ifndef __com_sun_star_container_XNameContainer_idl__
  34 #include <com/sun/star/container/XNameContainer.idl>
  35 #endif
  36
  37 module com { module sun { module star { module xml {
  38
  39 /** A component that supports this service preserves XML attributes,
  40     unknown by its parser, that belong to the XML element representing
  41     it (the component).
  42
  43     @since OOo 2.0.4
  44 */
  45 published service UserDefinedAttributesSupplier
  46 {
  47     /** This container holds the <type>AttributeData</type> elements
  48         that represent uninterpreted XML attributes.
  49
  50         <p>The idea behind this property is that a parser can stow
  51         away all attributes that it cannot handle by itself on reading
  52         an XML file.  When the file is stored again, the unknown
  53         attributes can be written back without loss.</p>
  54
  55         <p>The
  56         <type scope="com::sun::star::container">XNameContainer</type>
  57         supports the service <type>AttributeContainer</type>.</p>
  58
  59      */
  60     [property] ::com::sun::star::container::XNameContainer  UserDefinedAttributes;
  61 };
  62
  63 }; }; }; };
  64
  65 #endif