summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/TableBorder.idl
blob: 0dbed11c76e87fe57ea085c61258764848366d5c (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_table_TableBorder_idl__
#define __com_sun_star_table_TableBorder_idl__

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

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

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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */