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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XExternalSheetName_idl__
  21 #define __com_sun_star_sheet_XExternalSheetName_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/container/ElementExistException.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides a method to set an external name at the sheet.
  31
  32     <p>An external reference in a cell formula is implemented using a
  33     hidden sheet which is linked to the sheet in the external document.
  34     The name of the hidden sheet is composed of the URL of the external
  35     document and the external sheet name.</p>
  36
  37     @since OOo 3.0
  38  */
  39 interface XExternalSheetName: com::sun::star::uno::XInterface
  40 {
  41
  42     /** sets an external name at the sheet.
  43
  44         <p>This method allows to compose the sheet name from the URL of the
  45         external document and the name of the external sheet.</p>
  46
  47         @param aUrl
  48             the URL of the external document.
  49
  50         @param aSheetName
  51             the name of the sheet in the external document.
  52
  53         @throws ::com::sun::star::container::ElementExistException
  54             a sheet with that external name already exists in this document
  55      */
  56     void setExternalName( [in] string aUrl, [in] string aSheetName )
  57         raises (com::sun::star::container::ElementExistException);
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */