xref: /trunk/main/offapi/com/sun/star/table/TableRow.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_table_TableRow_idl__
29#define __com_sun_star_table_TableRow_idl__
30
31#ifndef __com_sun_star_table_XCellRange_idl__
32#include <com/sun/star/table/XCellRange.idl>
33#endif
34
35#ifndef __com_sun_star_beans_XPropertySet_idl__
36#include <com/sun/star/beans/XPropertySet.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module table {
42
43//=============================================================================
44
45/** represents a special cell range containing all cells of a single
46    specific row in a table or spreadsheet.
47 */
48published service TableRow
49{
50    //-------------------------------------------------------------------------
51
52    /** provides access to the cells of this row.
53
54        @see com::sun::star::table::CellRange
55     */
56    interface com::sun::star::table::XCellRange;
57
58    //-------------------------------------------------------------------------
59
60//!published service PropertySet
61    /** provides access to the cell properties of all cells of this row.
62     */
63    interface com::sun::star::beans::XPropertySet;
64
65    //=========================================================================
66
67    /** contains the height of the row (in 1/100 mm).
68
69        <p>When hidden, it returns the height which the row would have,
70        if it were visible. </p>
71     */
72    [property] long Height;
73
74    //-------------------------------------------------------------------------
75
76    /** is <TRUE/>, if the row always keeps its optimal height.
77     */
78    [property] boolean OptimalHeight;
79
80    //-------------------------------------------------------------------------
81
82    /** is <TRUE/>, if the row is visible.
83     */
84    [property] boolean IsVisible;
85
86    //-------------------------------------------------------------------------
87
88    /** is <TRUE/>, if there is a manual vertical page break attached
89        to the row.
90     */
91    [property] boolean IsStartOfNewPage;
92
93};
94
95//=============================================================================
96
97}; }; }; };
98
99#endif
100
101