summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XScenario.idl
blob: 47c2b66d7c1c12c210dc0683fa355ed005ce8213 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XScenario.idl,v $
 * $Revision: 1.10 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sheet_XScenario_idl__
#define __com_sun_star_sheet_XScenario_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.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 to the settings of a scenario sheet.

    @see com::sun::star::sheet::Spreadsheet
 */
published interface XScenario: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns <TRUE/> if the current object is a scenario.
     */
    boolean getIsScenario();

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

    /** returns the comment for the scenario.
     */
    string getScenarioComment();

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

    /** sets a new comment for the scenario.
     */
    void setScenarioComment( [in] string aScenarioComment );

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

    /** adds more ranges to the scenario.
     */
    void addRanges(
            [in] sequence< com::sun::star::table::CellRangeAddress > aRanges );

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

    /** applies the scenario.

        <p>The contents of the scenario ranges are copied into the first
        non-scenario sheet which is in front of the sheet containing
        the scenario by itself.</p>
     */
    void apply();

};

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

}; }; }; };

#endif