xref: /AOO41X/main/offapi/com/sun/star/table/TableColumn.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_TableColumn_idl__
25#define __com_sun_star_table_TableColumn_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#ifndef __com_sun_star_container_XNamed_idl__
36#include <com/sun/star/container/XNamed.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 column in a table or spreadsheet.
47 */
48published service TableColumn
49{
50    //-------------------------------------------------------------------------
51
52    /** provides access to the cells of this column.
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 column.
62     */
63    interface com::sun::star::beans::XPropertySet;
64
65    //-------------------------------------------------------------------------
66
67    /** provides methods to access the name of the column.
68
69        <p>In spreadsheets, the name of a column cannot be changed.<p/>
70     */
71    interface com::sun::star::container::XNamed;
72
73    //=========================================================================
74
75    /** contains the width of the column (in 1/100th mm).
76
77        <p>When hidden, it returns the width which the column would have,
78        if it were visible. </p>
79     */
80    [property] long Width;
81
82    //-------------------------------------------------------------------------
83
84    /** is <TRUE/>, if the column always keeps its optimal width.
85     */
86    [property] boolean OptimalWidth;
87
88    //-------------------------------------------------------------------------
89
90    /** is <TRUE/>, if the column is visible.
91     */
92    [property] boolean IsVisible;
93
94    //-------------------------------------------------------------------------
95
96    /** is <TRUE/>, if there is a manual horizontal page break attached
97        to the column.
98     */
99    [property] boolean IsStartOfNewPage;
100
101};
102
103//=============================================================================
104
105}; }; }; };
106
107#endif
108
109