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 #ifndef __com_sun_star_document_XOOXMLDocumentPropertiesImporter_idl__
  20 #define __com_sun_star_document_XOOXMLDocumentPropertiesImporter_idl__
  21
  22 #include <com/sun/star/document/XDocumentProperties.idl>
  23 #include <com/sun/star/embed/XStorage.idl>
  24 #include <com/sun/star/xml/sax/SAXException.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26 #include <com/sun/star/uno/Exception.idl>
  27
  28
  29 module com { module sun { module star { module document {
  30
  31 /** allows to import the document properties from OOXML format
  32  */
  33 interface XOOXMLDocumentPropertiesImporter: com::sun::star::uno::XInterface
  34 {
  35     /** allows to import the document properties from OOXML format
  36
  37         <p>
  38         The implementation should parse the document properties from OOXML
  39         format storage and set them to the target
  40         XDocumentProperties implementation.
  41         </p>
  42
  43         <p>
  44         The storage must represent OOXML format and support
  45         com::sun::star::embed::XRelationshipAccess
  46         interface. Please see
  47         com::sun::star::embed::StorageFactory for details
  48         regarding creation of such a storage.
  49         </p>
  50
  51         @param xSource
  52             the source storage representing OOXML document
  53
  54         @param xDocumentProperties
  55             the target XDocumentProperties interface implementation
  56
  57         @throws ::com::sun::star::lang::IllegalArgumentException
  58             the exception is thrown in case unexpected arguments are provided
  59
  60         @throws ::com::sun::star::xml::sax::SAXException
  61             the exception is thrown in case of parsing problems
  62
  63         @throws ::com::sun::star::uno::Exception
  64             the exception is thrown in case of other problems during the import
  65      */
  66
  67     void importProperties(
  68         [in] com::sun::star::embed::XStorage xSource,
  69         [in] com::sun::star::document::XDocumentProperties xDocumentProperties )
  70             raises( com::sun::star::lang::IllegalArgumentException,
  71                     com::sun::star::xml::sax::SAXException,
  72                     com::sun::star::uno::Exception );
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */