offapi/com/sun/star/script/XLibraryContainerExport.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_script_XLibraryContainerExport_idl__
  20 #define __com_sun_star_script_XLibraryContainerExport_idl__
  21
  22 #include <com/sun/star/task/XInteractionHandler.idl>
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25 #include <com/sun/star/container/NoSuchElementException.idl>
  26
  27
  28
  29  module com {  module sun {  module star {  module script {
  30
  31
  32 /**
  33     Extension of XLibraryContainer to provide functionality to
  34     store a library to a location represented by a URL.
  35  */
  36 interface XLibraryContainerExport : com::sun::star::uno::XInterface
  37 {
  38     /**
  39         Exports a library specified by Name to the location
  40         specified by the passed URL string.
  41
  42         An interaction handler can be passed to be used for internal
  43         ucb operations. Exceptions not processed by this handler will
  44         be passed as com::sun::star::uno::Exception. If this parameter
  45         is null this applies to all exceptions thrown by ucb.
  46
  47         @see com::sun::star::task::InteractionHandler
  48
  49         If a library with the this name doesn't exist a
  50         com::sun::star::container::NoSuchElementException is thrown.
  51      */
  52     void exportLibrary( [in] string Name, [in] string URL,
  53         [in] com::sun::star::task::XInteractionHandler Handler )
  54             raises( com::sun::star::uno::Exception,
  55                     com::sun::star::container::NoSuchElementException );
  56 };
  57
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */