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_chart2_data_LabelOrigin_idl
25#define com_sun_star_chart2_data_LabelOrigin_idl
26
27//=============================================================================
28
29module com {  module sun {  module star {  module chart2 { module data {
30
31//=============================================================================
32
33/** is used to specify how the labels have to be created.
34
35    @see <member>XDataSequence::generateLabel</member>.
36 */
37enum LabelOrigin
38{
39	//-------------------------------------------------------------------------
40
41	/** If a range spans a single row over more than one column, this
42        parameter has the same effect as ROW.  If the range spans a
43        single column over more than one row, this is the same as
44        COLUMN.
45
46        <p>In case of a range spanning more than one column and row,
47        the shorter range of both should be used (e.g. a spreadsheet
48        range A1:B10 should treat columns as short side).</p>
49
50        <p>In case of a rectangular range, or a range that is composed
51        of more than one contiguous sub-regions, the short side cannot
52        be determined, thus
53        <member>XDataSequence::generateLabel</member> will return an
54        empty sequence.</p>
55	 */
56	SHORT_SIDE,
57
58	//-------------------------------------------------------------------------
59
60	/** This is exactly the opposite of SHORT_SIDE.  I.e., if
61        SHORT_SIDE has the same effect as ROW, LONG_SIDE will have the
62        same effect as COLUMN and the other way round.
63
64        @see <member>LabelOrigin::SHORT_SIDE</member>
65	 */
66	LONG_SIDE,
67
68	//-------------------------------------------------------------------------
69
70	/** Uses the column name for label generation.  A spreadsheet
71        range A1:A6 could, e.g., result in "Column A".
72
73        <p>If a range consists of more than one column the result of
74        label generation may be empty.  Of course, it could also
75        succeed with a string like "Columns A to B".
76	 */
77	COLUMN,
78
79	//-------------------------------------------------------------------------
80
81	/** Uses the column name for label generation.  A spreadsheet
82        range A2:D2 could, e.g., result in "Row 2".
83
84        <p>If a range consists of more than one row the result of
85        label generation may be empty.  Of course, it could also
86        succeed with a string like "Rows 1-3".
87	 */
88	ROW
89};
90
91//=============================================================================
92
93}; }; }; }; };
94
95#endif
96
97