offapi/com/sun/star/document/XOOXMLDocumentPropertiesImporter.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
  20
  21 module com { module sun { module star { module document {
  22
  23 /** allows to import the document properties from OOXML format
  24  */
  25 interface XOOXMLDocumentPropertiesImporter: com::sun::star::uno::XInterface
  26 {
  27     /** allows to import the document properties from OOXML format
  28
  29         <p>
  30         The implementation should parse the document properties from OOXML
  31         format storage and set them to the target
  32         XDocumentProperties implementation.
  33         </p>
  34
  35         <p>
  36         The storage must represent OOXML format and support
  37         com::sun::star::embed::XRelationshipAccess
  38         interface. Please see
  39         com::sun::star::embed::StorageFactory for details
  40         regarding creation of such a storage.
  41         </p>
  42
  43         @param xSource
  44             the source storage representing OOXML document
  45
  46         @param xDocumentProperties
  47             the target XDocumentProperties interface implementation
  48
  49         @throws ::com::sun::star::lang::IllegalArgumentException
  50             the exception is thrown in case unexpected arguments are provided
  51
  52         @throws ::com::sun::star::xml::sax::SAXException
  53             the exception is thrown in case of parsing problems
  54
  55         @throws ::com::sun::star::uno::Exception
  56             the exception is thrown in case of other problems during the import
  57      */
  58
  59     void importProperties(
  60         [in] com::sun::star::embed::XStorage xSource,
  61         [in] com::sun::star::document::XDocumentProperties xDocumentProperties )
  62             raises( com::sun::star::lang::IllegalArgumentException,
  63                     com::sun::star::xml::sax::SAXException,
  64                     com::sun::star::uno::Exception );
  65
  66     /** find and get core properties stream
  67
  68         (usually it is docProps\core.xml)
  69         @since LibreOffice 7.3
  70      */
  71
  72     com::sun::star::io::XInputStream getCorePropertiesStream([in] com::sun::star::embed::XStorage xSource);
  73
  74     /** find and get extended properties stream
  75
  76         (usually it is docProps/app.xml)
  77         @since LibreOffice 7.3
  78      */
  79
  80     com::sun::star::io::XInputStream getExtendedPropertiesStream([in] com::sun::star::embed::XStorage xSource);
  81
  82     /** find and get custom properties streams
  83
  84         (usually it is customXml\*.xml)
  85         @since LibreOffice 7.3
  86      */
  87
  88     sequence< com::sun::star::io::XInputStream > getCustomPropertiesStreams([in] com::sun::star::embed::XStorage xSource);
  89 };
  90
  91
  92 }; }; }; };
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */