offapi/com/sun/star/embed/XPackageStructureCreator.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 embed {
  22
  23 /** allows to convert filesystem folder tree into a package.
  24  */
  25 published interface XPackageStructureCreator: com::sun::star::uno::XInterface
  26 {
  27     /** converts filesystem folder tree into a package.
  28
  29         @param sFolderURL
  30             the URL of folder that must be converted,
  31             the URL must be in format accepted by UCB
  32
  33         @param xTargetStream
  34             the result package will be written into this stream
  35
  36         @throws ::com::sun::star::io::IOException
  37             in case any problem on reading/writing appears
  38      */
  39     void convertToPackage(
  40             [in] string sFolderURL,
  41             [in] ::com::sun::star::io::XOutputStream xTargetStream )
  42         raises( ::com::sun::star::io::IOException );
  43 };
  44
  45
  46 }; }; }; };
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */