xref: /AOO41X/main/offapi/com/sun/star/table/TableBorder.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_TableBorder_idl__
25#define __com_sun_star_table_TableBorder_idl__
26
27#ifndef __com_sun_star_table_BorderLine_idl__
28#include <com/sun/star/table/BorderLine.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module table {
34
35//=============================================================================
36
37/** contains the style settings of the border lines of all cells in a cell
38    range.
39
40    <p>In a queried structure, the flags in
41    <member>TableBorder::Is...LineValid</member> indicate that not all
42    lines of the boxes have the same values.</p>
43
44    <p>In a structure which is used for setting, these flags determine
45    if the corresponding line should be set or if the old value should
46    be kept.</p>
47 */
48published struct TableBorder
49{
50    //-------------------------------------------------------------------------
51
52    /** determines the line style at the top edge.
53     */
54    com::sun::star::table::BorderLine TopLine;
55
56    //-------------------------------------------------------------------------
57
58    /** specifies whether the value of <member>TableBorder::TopLine</member>
59        is used.
60     */
61    boolean IsTopLineValid;
62
63    //-------------------------------------------------------------------------
64
65    /** determines the line style at the bottom edge.
66     */
67    com::sun::star::table::BorderLine BottomLine;
68
69    //-------------------------------------------------------------------------
70
71    /** specifies whether the value of
72        <member>TableBorder::BottomLine</member> is used.
73     */
74    boolean IsBottomLineValid;
75
76    //-------------------------------------------------------------------------
77
78    /** determines the line style at the left edge.
79     */
80    com::sun::star::table::BorderLine LeftLine;
81
82    //-------------------------------------------------------------------------
83
84    /** specifies whether the value of <member>TableBorder::LeftLine</member>
85        is used.
86     */
87    boolean IsLeftLineValid;
88
89    //-------------------------------------------------------------------------
90
91    /** determines the line style at the right edge.
92     */
93    com::sun::star::table::BorderLine RightLine;
94
95    //-------------------------------------------------------------------------
96
97    /** specifies whether the value of <member>TableBorder::RightLine</member>
98        is used.
99     */
100    boolean IsRightLineValid;
101
102    //-------------------------------------------------------------------------
103
104    /** determines the line style of horizontal lines for the inner part
105        of a cell range.
106     */
107    com::sun::star::table::BorderLine HorizontalLine;
108
109    //-------------------------------------------------------------------------
110
111    /** specifies whether the value of
112        <member>TableBorder::HorizontalLine</member> is used.
113     */
114    boolean IsHorizontalLineValid;
115
116    //-------------------------------------------------------------------------
117
118    /** determines the line style of vertical lines for the inner part
119        of a cell range.
120     */
121    com::sun::star::table::BorderLine VerticalLine;
122
123    //-------------------------------------------------------------------------
124
125    /** specifies whether the value of
126        <member>TableBorder::VerticalLine</member> is used.
127     */
128    boolean IsVerticalLineValid;
129
130    //-------------------------------------------------------------------------
131
132    /** contains the distance between the lines and other contents.
133     */
134    short Distance;
135
136    //-------------------------------------------------------------------------
137
138    /** specifies whether the value of <member>TableBorder::Distance</member>
139        is used.
140     */
141    boolean IsDistanceValid;
142
143};
144
145//=============================================================================
146
147}; }; }; };
148
149#endif
150
151