merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / sheet / XExternalSheetName.idl
blobe90595b0917288810ad30abb41bde9e2fb51aba1
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XExternalSheetName.idl,v $
10 * $Revision: 1.4 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
31 #ifndef __com_sun_star_sheet_XExternalSheetName_idl__
32 #define __com_sun_star_sheet_XExternalSheetName_idl__
34 #ifndef __com_sun_star_uno_XInterface_idl__
35 #include <com/sun/star/uno/XInterface.idl>
36 #endif
38 #ifndef __com_sun_star_container_ElementExistException_idl__
39 #include <com/sun/star/container/ElementExistException.idl>
40 #endif
42 //=============================================================================
44 module com { module sun { module star { module sheet {
46 //=============================================================================
48 /** provides a method to set an external name at the sheet.
50 <p>An external reference in a cell formula is implemented using a
51 hidden sheet which is linked to the sheet in the external document.
52 The name of the hidden sheet is composed of the URL of the external
53 document and the external sheet name.</p>
55 @since OOo 3.0
57 interface XExternalSheetName: com::sun::star::uno::XInterface
59 //-------------------------------------------------------------------------
61 /** sets an external name at the sheet.
63 <p>This method allows to compose the sheet name from the URL of the
64 external document and the name of the external sheet.</p>
66 @param aUrl
67 the URL of the external document.
69 @param aSheetName
70 the name of the sheet in the external document.
72 @throws ::com::sun::star::container::ElementExistException
73 a sheet with that external name already exists in this document
75 void setExternalName( [in] string aUrl, [in] string aSheetName )
76 raises (com::sun::star::container::ElementExistException);
80 //=============================================================================
82 }; }; }; };
84 #endif