summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/script/XLibraryContainerExport.idl
blob: 2e68eefb1b40641269afdb8cba4b8134e7c02538 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_script_XLibraryContainerExport_idl__
#define __com_sun_star_script_XLibraryContainerExport_idl__

#include <com/sun/star/task/XInteractionHandler.idl>
#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/container/NoSuchElementException.idl>



 module com {  module sun {  module star {  module script {


/**
    Extension of XLibraryContainer to provide functionality to
    store a library to a location represented by a URL.
 */
interface XLibraryContainerExport : com::sun::star::uno::XInterface
{
    /**
        Exports a library specified by Name to the location
        specified by the passed URL string.

        An interaction handler can be passed to be used for internal
        ucb operations. Exceptions not processed by this handler will
        be passed as com::sun::star::uno::Exception. If this parameter
        is null this applies to all exceptions thrown by ucb.

        @see com::sun::star::task::InteractionHandler

        If a library with the this name doesn't exist a
        com::sun::star::container::NoSuchElementException is thrown.
     */
    void exportLibrary( [in] string Name, [in] string URL,
        [in] com::sun::star::task::XInteractionHandler Handler )
            raises( com::sun::star::uno::Exception,
                    com::sun::star::container::NoSuchElementException );
};



}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */