1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef com_sun_star_chart2_data_LabelOrigin_idl
29#define com_sun_star_chart2_data_LabelOrigin_idl
30
31//=============================================================================
32
33module com {  module sun {  module star {  module chart2 { module data {
34
35//=============================================================================
36
37/** is used to specify how the labels have to be created.
38
39    @see <member>XDataSequence::generateLabel</member>.
40 */
41enum LabelOrigin
42{
43	//-------------------------------------------------------------------------
44
45	/** If a range spans a single row over more than one column, this
46        parameter has the same effect as ROW.  If the range spans a
47        single column over more than one row, this is the same as
48        COLUMN.
49
50        <p>In case of a range spanning more than one column and row,
51        the shorter range of both should be used (e.g. a spreadsheet
52        range A1:B10 should treat columns as short side).</p>
53
54        <p>In case of a rectangular range, or a range that is composed
55        of more than one contiguous sub-regions, the short side cannot
56        be determined, thus
57        <member>XDataSequence::generateLabel</member> will return an
58        empty sequence.</p>
59	 */
60	SHORT_SIDE,
61
62	//-------------------------------------------------------------------------
63
64	/** This is exactly the opposite of SHORT_SIDE.  I.e., if
65        SHORT_SIDE has the same effect as ROW, LONG_SIDE will have the
66        same effect as COLUMN and the other way round.
67
68        @see <member>LabelOrigin::SHORT_SIDE</member>
69	 */
70	LONG_SIDE,
71
72	//-------------------------------------------------------------------------
73
74	/** Uses the column name for label generation.  A spreadsheet
75        range A1:A6 could, e.g., result in "Column A".
76
77        <p>If a range consists of more than one column the result of
78        label generation may be empty.  Of course, it could also
79        succeed with a string like "Columns A to B".
80	 */
81	COLUMN,
82
83	//-------------------------------------------------------------------------
84
85	/** Uses the column name for label generation.  A spreadsheet
86        range A2:D2 could, e.g., result in "Row 2".
87
88        <p>If a range consists of more than one row the result of
89        label generation may be empty.  Of course, it could also
90        succeed with a string like "Rows 1-3".
91	 */
92	ROW
93};
94
95//=============================================================================
96
97}; }; }; }; };
98
99#endif
100
101