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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  20 #define _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  21
  22 #include <com/sun/star/container/XNameContainer.idl>
  23
  24 module com { module sun { module star { module xml {
  25
  26 /** A component that supports this service preserves XML attributes,
  27     unknown by its parser, that belong to the XML element representing
  28     it (the component).
  29
  30     @since OOo 2.0.4
  31 */
  32 published service UserDefinedAttributesSupplier
  33 {
  34     /** This container holds the AttributeData elements
  35         that represent uninterpreted XML attributes.
  36
  37         <p>The idea behind this property is that a parser can stow
  38         away all attributes that it cannot handle by itself on reading
  39         an XML file.  When the file is stored again, the unknown
  40         attributes can be written back without loss.</p>
  41
  42         <p>The
  43         com::sun::star::container::XNameContainer
  44         supports the service AttributeContainer.</p>
  45
  46      */
  47     [property] ::com::sun::star::container::XNameContainer  UserDefinedAttributes;
  48 };
  49
  50 }; }; }; };
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */