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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSpreadsheets.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XSpreadsheets_idl__
  32 #define __com_sun_star_sheet_XSpreadsheets_idl__
  33
  34 #ifndef __com_sun_star_container_XNameContainer_idl__
  35 #include <com/sun/star/container/XNameContainer.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module sheet {
  41
  42 //=============================================================================
  43
  44 /** provides methods to access the spreadsheets by name and to insert,
  45     copy, remove and rearrange spreadsheets.
  46
  47     @see com::sun::star::sheet::Spreadsheets
  48  */
  49 published interface XSpreadsheets: com::sun::star::container::XNameContainer
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /** inserts a new sheet into the collection.
  54
  55         @param aName
  56             the name of the new spreadsheet.
  57         @param nPosition
  58             the index of the new spreadsheet in the collection.
  59      */
  60     void insertNewByName( [in] string aName, [in] short nPosition );
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** moves a sheet within the collection.
  65
  66         @param aName
  67             the name of the spreadsheet to move.
  68         @param nDestination
  69             the new index of the spreadsheet in the collection.
  70      */
  71     void moveByName( [in] string aName, [in] short nDestination );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** copies a sheet within the collection.
  76
  77         @param aName
  78             the name of the spreadsheet to copy.
  79         @param aCopy
  80             the name of the copy of the spreadsheet.
  81         @param nDestination
  82             the index of the copy in the collection.
  83      */
  84     void copyByName(
  85             [in] string aName,
  86             [in] string aCopy,
  87             [in] short nDestination );
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 #endif
  96