summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XSpreadsheets2.idl
blob: b8686cf0ce25a1ff3b0459b1f1cbe0fb3797c0fc (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
65
66
67
68
69
70
71
72
73
74
75
/*
 * Version: MPL 1.1 / GPLv3+ / LGPLv3+
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 *
 * Author(s): Laurent Godard <lgodard.libre@laposte.net>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
 * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
 * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
 * instead of those above.
 */

#ifndef __com_sun_star_table_XSpreadsheets2_idl__
#define __com_sun_star_table_XSpreadsheets2_idl__

#include <com/sun/star/sheet/XSpreadsheets.idl>
#include <com/sun/star/sheet/XSpreadsheetDocument.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** extends XSpreadsheets interface to import external sheets.

    @see com::sun::star::sheet::Spreadsheets
 */
interface XSpreadsheets2: com::sun::star::sheet::XSpreadsheets
{
    /** copies a sheet from a source document.

        @param srcDoc
            a valid XSpreadsheetDocument reference to source doc

        @param srcName
            the source sheet name. Throw IllegalArgumentException if not valid

        @param nDestPosition
            the destination sheet position. Throw IndexOutOfBoundsException if not valid

        @returns the position of the imported sheet

        @throws ::com::sun::star::lang::IllegalArgumentException
        @throws com::sun::star::lang::IndexOutOfBoundsException

        @since LibreOffice 3.5
     */
    long importSheet(
            [in] com::sun::star::sheet::XSpreadsheetDocument srcDoc,
            [in] string srcName,
            [in] long  nDestPosition)
            raises (com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::lang::IndexOutOfBoundsException);
};

//=============================================================================

}; }; }; };

#endif