summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/TableBorder.idl
blob: 8688e6c8a3f08d916db698e1217b640a3c222626 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_table_TableBorder_idl__
#define __com_sun_star_table_TableBorder_idl__

#ifndef __com_sun_star_table_BorderLine_idl__
#include <com/sun/star/table/BorderLine.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module table {

//=============================================================================

/** contains the style settings of the border lines of all cells in a cell
    range.

    <p>In a queried structure, the flags in
    <member>TableBorder::Is...LineValid</member> indicate that not all
    lines of the boxes have the same values.</p>

    <p>In a structure which is used for setting, these flags determine
    if the corresponding line should be set or if the old value should
    be kept.</p>
 */
published struct TableBorder
{
    //-------------------------------------------------------------------------

    /** determines the line style at the top edge.
     */
    com::sun::star::table::BorderLine TopLine;

    //-------------------------------------------------------------------------

    /** specifies whether the value of <member>TableBorder::TopLine</member>
        is used.
     */
    boolean IsTopLineValid;

    //-------------------------------------------------------------------------

    /** determines the line style at the bottom edge.
     */
    com::sun::star::table::BorderLine BottomLine;

    //-------------------------------------------------------------------------

    /** specifies whether the value of
        <member>TableBorder::BottomLine</member> is used.
     */
    boolean IsBottomLineValid;

    //-------------------------------------------------------------------------

    /** determines the line style at the left edge.
     */
    com::sun::star::table::BorderLine LeftLine;

    //-------------------------------------------------------------------------

    /** specifies whether the value of <member>TableBorder::LeftLine</member>
        is used.
     */
    boolean IsLeftLineValid;

    //-------------------------------------------------------------------------

    /** determines the line style at the right edge.
     */
    com::sun::star::table::BorderLine RightLine;

    //-------------------------------------------------------------------------

    /** specifies whether the value of <member>TableBorder::RightLine</member>
        is used.
     */
    boolean IsRightLineValid;

    //-------------------------------------------------------------------------

    /** determines the line style of horizontal lines for the inner part
        of a cell range.
     */
    com::sun::star::table::BorderLine HorizontalLine;

    //-------------------------------------------------------------------------

    /** specifies whether the value of
        <member>TableBorder::HorizontalLine</member> is used.
     */
    boolean IsHorizontalLineValid;

    //-------------------------------------------------------------------------

    /** determines the line style of vertical lines for the inner part
        of a cell range.
     */
    com::sun::star::table::BorderLine VerticalLine;

    //-------------------------------------------------------------------------

    /** specifies whether the value of
        <member>TableBorder::VerticalLine</member> is used.
     */
    boolean IsVerticalLineValid;

    //-------------------------------------------------------------------------

    /** contains the distance between the lines and other contents.
     */
    short Distance;

    //-------------------------------------------------------------------------

    /** specifies whether the value of <member>TableBorder::Distance</member>
        is used.
     */
    boolean IsDistanceValid;

};

//=============================================================================

}; }; }; };

#endif