offapi/com/sun/star/xml/TextUserDefinedAttributesSupplier.idl

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