summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XSpreadsheets2.idl
blob: 16d44768e21f418a68f370c32576549d544d2234 (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
/* -*- 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/.
 */

#ifndef __com_sun_star_sheet_XSpreadsheets2_idl__
#define __com_sun_star_sheet_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

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