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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  29 #define _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  30
  31 #include <com/sun/star/container/XNameContainer.idl>
  32
  33 module com { module sun { module star { module xml {
  34
  35 /** A component that supports this service preserves XML attributes,
  36     unknown by its parser, that belong to the XML element representing
  37     it (the component).
  38
  39     @since OOo 2.0.4
  40 */
  41 published service UserDefinedAttributesSupplier
  42 {
  43     /** This container holds the <type>AttributeData</type> elements
  44         that represent uninterpreted XML attributes.
  45
  46         <p>The idea behind this property is that a parser can stow
  47         away all attributes that it cannot handle by itself on reading
  48         an XML file.  When the file is stored again, the unknown
  49         attributes can be written back without loss.</p>
  50
  51         <p>The
  52         <type scope="com::sun::star::container">XNameContainer</type>
  53         supports the service <type>AttributeContainer</type>.</p>
  54
  55      */
  56     [property] ::com::sun::star::container::XNameContainer  UserDefinedAttributes;
  57 };
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */