offapi/com/sun/star/sheet/XExternalSheetName.idl

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