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

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef __com_sun_star_sheet_XSpreadsheets_idl__
#define __com_sun_star_sheet_XSpreadsheets_idl__

#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides methods to access the spreadsheets by name and to insert,
	copy, remove and rearrange spreadsheets.

	@see com::sun::star::sheet::Spreadsheets
 */
published interface XSpreadsheets: com::sun::star::container::XNameContainer
{
	//-------------------------------------------------------------------------

	/** inserts a new sheet into the collection.

		@param aName
			the name of the new spreadsheet.
		@param nPosition
			the index of the new spreadsheet in the collection.
	 */
	void insertNewByName( [in] string aName, [in] short nPosition );

	//-------------------------------------------------------------------------

	/** moves a sheet within the collection.

		@param aName
			the name of the spreadsheet to move.
		@param nDestination
			the new index of the spreadsheet in the collection.
	 */
	void moveByName( [in] string aName, [in] short nDestination );

	//-------------------------------------------------------------------------

	/** copies a sheet within the collection.

		@param aName
			the name of the spreadsheet to copy.
		@param aCopy
			the name of the copy of the spreadsheet.
		@param nDestination
			the index of the copy in the collection.
	 */
	void copyByName(
			[in] string aName,
			[in] string aCopy,
			[in] short nDestination );

};

//=============================================================================

}; }; }; };

#endif