summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XNamedRange.idl
blob: 07ff2391f6a8e913753455059c2b3e2e26df439c (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
97
98
99
100
101
102
103
104
105
106
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_XNamedRange_idl__
#define __com_sun_star_sheet_XNamedRange_idl__

#include <com/sun/star/container/XNamed.idl>
#include <com/sun/star/table/CellAddress.idl>

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

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

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

/** provides access to the settings of a named range in a spreadsheet
    document.

    @see com::sun::star::sheet::NamedRange
 */
published interface XNamedRange: com::sun::star::container::XNamed
{
    //-------------------------------------------------------------------------

    /** returns the content of the named range.

        <p>The content can be a reference to a cell or cell range
        or any formula expression.</p>
     */
    string getContent();

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

    /** sets the content of the named range.

        <p>The content can be a reference to a cell or cell range
        or any formula expression.</p>
     */
    void setContent( [in] string aContent );

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

    /** returns the position in the document which is used as a
        base for relative references in the content.
     */
    com::sun::star::table::CellAddress getReferencePosition();

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

    /** sets the position in the document which is used as a
        base for relative references in the content.
     */
    void setReferencePosition(
            [in] com::sun::star::table::CellAddress aReferencePosition );

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

    /** returns the type of the named range.

        <p>This is a combination of flags as defined in
        <type>NamedRangeFlag</type>.</p>
     */
    long getType();

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

    /** sets the type of the named range.

        @param nType
            a combination of flags that specify the type of a named range,
            as defined in <type>NamedRangeFlag</type>.
     */
    void setType( [in] long nType );

};

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

}; }; }; };

#endif