/* -*- 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 .
 */


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


/** provides access via name to the scenarios in a collection and inserting
    and removing scenarios.

    @see com::sun::star::sheet::Scenarios
    @see com::sun::star::sheet::Spreadsheet
 */
published interface XScenarios: com::sun::star::container::XNameAccess
{

    /** creates a new scenario and adds it to the collection.

        @param aName
            the name of the scenario (used i.e. for collection access).

        @param aRanges
            the cell ranges contained in the scenario.

        @param aComment
            the user defined comment for the scenario.
     */
    void addNewByName(
            [in] string aName,
            [in] sequence< com::sun::star::table::CellRangeAddress > aRanges,
            [in] string aComment );


    /** removes a scenario from the collection.
     */
    void removeByName( [in] string aName );

};


}; }; }; };

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