/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_sheet_XSpreadsheets_idl__
#define __com_sun_star_sheet_XSpreadsheets_idl__

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


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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */