office-gobmx/offapi/com/sun/star/sheet/XScenarios.idl
Oliver Bolte a459baca2a INTEGRATION: CWS sb18 (1.6.406); FILE MERGED
2004/05/21 15:03:28 sb 1.6.406.1: #i21150# Added published flag.
2004-06-03 22:12:48 +00:00

118 lines
4 KiB
Text

/*************************************************************************
*
* $RCSfile: XScenarios.idl,v $
*
* $Revision: 1.7 $
*
* last change: $Author: obo $ $Date: 2004-06-03 23:11:45 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_sheet_XScenarios_idl__
#define __com_sun_star_sheet_XScenarios_idl__
#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif
//=============================================================================
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 );
};
//=============================================================================
}; }; }; };
#endif