summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/XExternalSheetName.idl
blob: dc9cdf95b5ed29e8a4e261964ae92033c5639156 (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
/* -*- 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_sheet_XExternalSheetName_idl__
#define __com_sun_star_sheet_XExternalSheetName_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/container/ElementExistException.idl>


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


/** provides a method to set an external name at the sheet.

    <p>An external reference in a cell formula is implemented using a
    hidden sheet which is linked to the sheet in the external document.
    The name of the hidden sheet is composed of the URL of the external
    document and the external sheet name.</p>

    @since OOo 3.0
 */
interface XExternalSheetName: com::sun::star::uno::XInterface
{

    /** sets an external name at the sheet.

        <p>This method allows to compose the sheet name from the URL of the
        external document and the name of the external sheet.</p>

        @param aUrl
            the URL of the external document.

        @param aSheetName
            the name of the sheet in the external document.

        @throws ::com::sun::star::container::ElementExistException
            a sheet with that external name already exists in this document
     */
    void setExternalName( [in] string aUrl, [in] string aSheetName )
        raises (com::sun::star::container::ElementExistException);

};


}; }; }; };

#endif

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