offapi/com/sun/star/sheet/XSpreadsheets2.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
  10 #ifndef __com_sun_star_sheet_XSpreadsheets2_idl__
  11 #define __com_sun_star_sheet_XSpreadsheets2_idl__
  12
  13 #include <com/sun/star/sheet/XSpreadsheets.idl>
  14 #include <com/sun/star/sheet/XSpreadsheetDocument.idl>
  15 #include <com/sun/star/lang/IllegalArgumentException.idl>
  16 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  17
  18
  19 module com {  module sun {  module star {  module sheet {
  20
  21
  22 /** extends XSpreadsheets interface to import external sheets.
  23
  24     @see com::sun::star::sheet::Spreadsheets
  25  */
  26 interface XSpreadsheets2: com::sun::star::sheet::XSpreadsheets
  27 {
  28     /** copies a sheet from a source document.
  29
  30         @param srcDoc
  31             a valid XSpreadsheetDocument reference to source doc
  32
  33         @param srcName
  34             the source sheet name. Throw IllegalArgumentException if not valid
  35
  36         @param nDestPosition
  37             the destination sheet position. Throw IndexOutOfBoundsException if not valid
  38
  39         @returns the position of the imported sheet
  40
  41         @throws ::com::sun::star::lang::IllegalArgumentException
  42         @throws com::sun::star::lang::IndexOutOfBoundsException
  43
  44         @since LibreOffice 3.5
  45      */
  46     long importSheet(
  47             [in] com::sun::star::sheet::XSpreadsheetDocument srcDoc,
  48             [in] string srcName,
  49             [in] long  nDestPosition)
  50             raises (com::sun::star::lang::IllegalArgumentException,
  51                     com::sun::star::lang::IndexOutOfBoundsException);
  52 };
  53
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */