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