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