1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_TableColumnSeparator_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_TableColumnSeparator_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir
27cdf0e10cSrcweir//=============================================================================
28cdf0e10cSrcweir
29cdf0e10cSrcweir module com {  module sun {  module star {  module text {
30cdf0e10cSrcweir
31cdf0e10cSrcweir//=============================================================================
32cdf0e10cSrcweir
33cdf0e10cSrcweir/** The width of the cells of a text table is defined by the position
34cdf0e10cSrcweir	of the separator between neighboring cells.
35cdf0e10cSrcweir
36cdf0e10cSrcweir	<p>If cells of the table are merged, this separator is not removed, but
37cdf0e10cSrcweir	it is hidden.
38cdf0e10cSrcweir	</p>
39cdf0e10cSrcweir
40cdf0e10cSrcweir    <p>A text table or a text table row provides the separators in a
41cdf0e10cSrcweir	sequence of <type>TableColumnSeparator</type>s. If the table only
42cdf0e10cSrcweir	consists of one column, then this sequence is empty.
43cdf0e10cSrcweir
44cdf0e10cSrcweir	</p>
45cdf0e10cSrcweir	<p>The real width of a table depends on the environment (page style and
46cdf0e10cSrcweir	number of text columns at the table's position, alignment, and left and
47cdf0e10cSrcweir	right margins).  For that reason, the table column separator does not
48cdf0e10cSrcweir	contain metric values for the column widths. The values are relative
49cdf0e10cSrcweir	to the value of the property <member>TextTable::TableColumnRelativeSum</member>.
50cdf0e10cSrcweir
51cdf0e10cSrcweir	</p>
52cdf0e10cSrcweir	<p>A table provides this property only if all rows have the same structure.
53cdf0e10cSrcweir    If the table does not provide the property, then it cannot be set using.
54cdf0e10cSrcweir	</p>
55cdf0e10cSrcweir
56cdf0e10cSrcweir    <p>The state of <member>TableColumnSeparator::IsVisible</member> and the
57cdf0e10cSrcweir    count of the sequence must be the same in as it was in.
58cdf0e10cSrcweir    Hidden separators cannot be moved and they cannot be overtaken by visible
59cdf0e10cSrcweir    separators.</p>
60cdf0e10cSrcweir
61cdf0e10cSrcweir    @see com::sun::star::text::TextTable
62cdf0e10cSrcweir */
63cdf0e10cSrcweirpublished struct TableColumnSeparator
64cdf0e10cSrcweir{
65cdf0e10cSrcweir	/** contains the position of the separator.
66cdf0e10cSrcweir	 */
67cdf0e10cSrcweir	short Position;
68cdf0e10cSrcweir
69cdf0e10cSrcweir	//-------------------------------------------------------------------------
70cdf0e10cSrcweir
71cdf0e10cSrcweir	/** determines if the separator is visible.
72cdf0e10cSrcweir	 */
73cdf0e10cSrcweir	boolean IsVisible;
74cdf0e10cSrcweir
75cdf0e10cSrcweir};
76cdf0e10cSrcweir
77cdf0e10cSrcweir//=============================================================================
78cdf0e10cSrcweir
79cdf0e10cSrcweir}; }; }; };
80cdf0e10cSrcweir
81cdf0e10cSrcweir
82cdf0e10cSrcweir#endif
83