xref: /AOO41X/main/offapi/com/sun/star/sheet/XLabelRange.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_XLabelRange_idl__
25#define __com_sun_star_sheet_XLabelRange_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_table_CellRangeAddress_idl__
32#include <com/sun/star/table/CellRangeAddress.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access to the settings of a label range in a spreadsheet
42    document.
43
44    <p>These can be column or row labels, depending on where they are used.</p>
45
46    @see com::sun::star::sheet::LabelRange
47 */
48published interface XLabelRange: com::sun::star::uno::XInterface
49{
50    //-------------------------------------------------------------------------
51
52    /** returns the cell range address that contains the labels.
53     */
54    com::sun::star::table::CellRangeAddress getLabelArea();
55
56    //-------------------------------------------------------------------------
57
58    /** sets the cell range address that contains the labels.
59     */
60    void setLabelArea(
61            [in] com::sun::star::table::CellRangeAddress aLabelArea );
62
63    //-------------------------------------------------------------------------
64
65    /** returns the cell range address for which the labels are valid.
66     */
67    com::sun::star::table::CellRangeAddress getDataArea();
68
69    //-------------------------------------------------------------------------
70
71    /** sets the cell range address for which the labels are valid.
72     */
73    void setDataArea(
74            [in] com::sun::star::table::CellRangeAddress aDataArea );
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84