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