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