offapi/com/sun/star/sheet/XSpreadsheets.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_XSpreadsheets_idl__
  21 #define __com_sun_star_sheet_XSpreadsheets_idl__
  22
  23 #include <com/sun/star/container/XNameContainer.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** provides methods to access the spreadsheets by name and to insert,
  30     copy, remove and rearrange spreadsheets.
  31
  32     @see com::sun::star::sheet::Spreadsheets
  33  */
  34 published interface XSpreadsheets: com::sun::star::container::XNameContainer
  35 {
  36
  37     /** inserts a new sheet into the collection.
  38
  39         @param aName
  40             the name of the new spreadsheet.
  41         @param nPosition
  42             the index of the new spreadsheet in the collection.
  43      */
  44     void insertNewByName( [in] string aName, [in] short nPosition );
  45
  46
  47     /** moves a sheet within the collection.
  48
  49         @param aName
  50             the name of the spreadsheet to move.
  51         @param nDestination
  52             the new index of the spreadsheet in the collection.
  53      */
  54     void moveByName( [in] string aName, [in] short nDestination );
  55
  56
  57     /** copies a sheet within the collection.
  58
  59         @param aName
  60             the name of the spreadsheet to copy.
  61         @param aCopy
  62             the name of the copy of the spreadsheet.
  63         @param nDestination
  64             the index of the copy in the collection.
  65      */
  66     void copyByName(
  67             [in] string aName,
  68             [in] string aCopy,
  69             [in] short nDestination );
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */