1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XExternalSheetName_idl__
25#define __com_sun_star_sheet_XExternalSheetName_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_container_ElementExistException_idl__
32#include <com/sun/star/container/ElementExistException.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides a method to set an external name at the sheet.
42
43    <p>An external reference in a cell formula is implemented using a
44    hidden sheet which is linked to the sheet in the external document.
45    The name of the hidden sheet is composed of the URL of the external
46    document and the external sheet name.</p>
47
48    @since OpenOffice 3.0
49 */
50interface XExternalSheetName: com::sun::star::uno::XInterface
51{
52    //-------------------------------------------------------------------------
53
54    /** sets an external name at the sheet.
55
56        <p>This method allows to compose the sheet name from the URL of the
57        external document and the name of the external sheet.</p>
58
59        @param aUrl
60            the URL of the external document.
61
62        @param aSheetName
63            the name of the sheet in the external document.
64
65        @throws ::com::sun::star::container::ElementExistException
66            a sheet with that external name already exists in this document
67	 */
68    void setExternalName( [in] string aUrl, [in] string aSheetName )
69        raises (com::sun::star::container::ElementExistException);
70
71};
72
73//=============================================================================
74
75}; }; }; };
76
77#endif
78
79