diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XExternalSheetName.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XExternalSheetName.idl | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XExternalSheetName.idl b/offapi/com/sun/star/sheet/XExternalSheetName.idl new file mode 100644 index 000000000000..dd0cc73c67ec --- /dev/null +++ b/offapi/com/sun/star/sheet/XExternalSheetName.idl @@ -0,0 +1,82 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_XExternalSheetName_idl__ +#define __com_sun_star_sheet_XExternalSheetName_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_container_ElementExistException_idl__ +#include <com/sun/star/container/ElementExistException.idl> +#endif + +//============================================================================= + +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 + |