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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/* -*- 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 INCLUDED_EDITENG_BORDERLINE_HXX
#define INCLUDED_EDITENG_BORDERLINE_HXX
#include <com/sun/star/table/BorderLineStyle.hpp>
#include <tools/color.hxx>
#include <tools/long.hxx>
#include <tools/mapunit.hxx>
#include <editeng/editengdllapi.h>
#include <svtools/borderline.hxx>
class IntlWrapper;
// Line width defaults in twips
// Thin matches Excel's default values
// See tdf#48622 for the discussion leading to these defaults.
class SvxBorderLineWidth
{
public:
static const sal_Int16 Hairline = 1; // 0.05pt
static const sal_Int16 VeryThin = 10; // 0.5pt
static const sal_Int16 Thin = 15; // 0.75pt
static const sal_Int16 Medium = 30; // 1.5pt
static const sal_Int16 Thick = 45; // 2.25pt
static const sal_Int16 ExtraThick = 90; // 4.5pt
};
// Abstracts over values from css::table::BorderLineStyle
enum class SvxBorderLineStyle : sal_Int16
{
/** No border line
*/
NONE = css::table::BorderLineStyle::NONE,
/** Solid border line.
*/
SOLID = css::table::BorderLineStyle::SOLID,
/** Dotted border line.
*/
DOTTED = css::table::BorderLineStyle::DOTTED,
/** Dashed border line.
*/
DASHED = css::table::BorderLineStyle::DASHED,
/** Double border line. Widths of the lines and the gap are all equal,
and vary equally with the total width.
*/
DOUBLE = css::table::BorderLineStyle::DOUBLE,
/** Double border line with a thin line outside and a thick line
inside separated by a small gap.
*/
THINTHICK_SMALLGAP = css::table::BorderLineStyle::THINTHICK_SMALLGAP,
/** Double border line with a thin line outside and a thick line
inside separated by a medium gap.
*/
THINTHICK_MEDIUMGAP = css::table::BorderLineStyle::THINTHICK_MEDIUMGAP,
/** Double border line with a thin line outside and a thick line
inside separated by a large gap.
*/
THINTHICK_LARGEGAP = css::table::BorderLineStyle::THINTHICK_LARGEGAP,
/** Double border line with a thick line outside and a thin line
inside separated by a small gap.
*/
THICKTHIN_SMALLGAP = css::table::BorderLineStyle::THICKTHIN_SMALLGAP,
/** Double border line with a thick line outside and a thin line
inside separated by a medium gap.
*/
THICKTHIN_MEDIUMGAP = css::table::BorderLineStyle::THICKTHIN_MEDIUMGAP,
/** Double border line with a thick line outside and a thin line
inside separated by a large gap.
*/
THICKTHIN_LARGEGAP = css::table::BorderLineStyle::THICKTHIN_LARGEGAP,
/** 3D embossed border line.
*/
EMBOSSED = css::table::BorderLineStyle::EMBOSSED,
/** 3D engraved border line.
*/
ENGRAVED = css::table::BorderLineStyle::ENGRAVED,
/** Outset border line.
*/
OUTSET = css::table::BorderLineStyle::OUTSET,
/** Inset border line.
*/
INSET = css::table::BorderLineStyle::INSET,
/** Finely dashed border line.
*/
FINE_DASHED = css::table::BorderLineStyle::FINE_DASHED,
/** Double border line consisting of two fixed thin lines separated by a
variable gap.
*/
DOUBLE_THIN = css::table::BorderLineStyle::DOUBLE_THIN,
/** Line consisting of a repetition of one dash and one dot. */
DASH_DOT = css::table::BorderLineStyle::DASH_DOT,
/** Line consisting of a repetition of one dash and 2 dots. */
DASH_DOT_DOT = css::table::BorderLineStyle::DASH_DOT_DOT,
/** Maximum valid border line style value.
*/
BORDER_LINE_STYLE_MAX = css::table::BorderLineStyle::BORDER_LINE_STYLE_MAX,
};
namespace editeng
{
// convert border style between Word formats and LO
SvxBorderLineStyle EDITENG_DLLPUBLIC ConvertBorderStyleFromWord(int);
/// convert border width in twips between Word formats and LO
double EDITENG_DLLPUBLIC ConvertBorderWidthToWord(SvxBorderLineStyle, double);
double EDITENG_DLLPUBLIC ConvertBorderWidthFromWord(SvxBorderLineStyle,
double, int);
class EDITENG_DLLPUBLIC SvxBorderLine final
{
tools::Long m_nWidth;
tools::Long m_nMult;
tools::Long m_nDiv;
Color (*m_pColorOutFn)(Color);
Color (*m_pColorInFn)(Color);
Color (*m_pColorGapFn)(Color);
BorderWidthImpl m_aWidthImpl;
Color aColor;
SvxBorderLineStyle m_nStyle;
bool m_bMirrorWidths;
bool m_bUseLeftTop;
public:
SvxBorderLine( const Color *pCol = nullptr,
tools::Long nWidth = 0,
SvxBorderLineStyle nStyle = SvxBorderLineStyle::SOLID,
Color (*pColorOutFn)( Color ) = &darkColor,
Color (*pColorInFn)( Color ) = &darkColor );
const Color& GetColor() const { return aColor; }
Color GetColorOut( bool bLeftOrTop = true ) const;
Color GetColorIn( bool bLeftOrTop = true ) const;
bool HasGapColor() const { return m_pColorGapFn != nullptr; }
Color GetColorGap() const;
void SetWidth( tools::Long nWidth );
/** Guess the style and width from the three lines widths values.
When the value of nStyle is SvxBorderLine::DOUBLE, the style set will be guessed
using the three values to match the best possible style among the following:
- SvxBorderLine::DOUBLE
- SvxBorderLine::THINTHICK_SMALLGAP
- SvxBorderLine::THINTHICK_MEDIUMGAP
- SvxBorderLine::THINTHICK_LARGEGAP
- SvxBorderLine::THICKTHIN_SMALLGAP
- SvxBorderLine::THICKTHIN_MEDIUMGAP
- SvxBorderLine::THICKTHIN_LARGEGAP
If no styles matches the width, then the width is set to 0.
There is one known case that could fit several styles: \a nIn = \a nDist = 0.75 pt,
\a nOut = 1.5 pt. This case fits SvxBorderLine::THINTHICK_SMALLGAP and
SvxBorderLine::THINTHICK_MEDIUMGAP with a 1.5 pt width and
SvxBorderLine::THINTHICK_LARGEGAP with a 0.75 pt width. The same case happens
also for thick-thin styles.
\param nStyle the border style used to guess the width.
\param nIn the width of the inner line in 1th pt
\param nOut the width of the outer line in 1th pt
\param nDist the width of the gap between the lines in 1th pt
*/
void GuessLinesWidths( SvxBorderLineStyle nStyle, sal_uInt16 nOut, sal_uInt16 nIn = 0, sal_uInt16 nDist = 0 );
// TODO Hacky method to mirror lines in only a few cases
void SetMirrorWidths() { m_bMirrorWidths = true; }
tools::Long GetWidth( ) const { return m_nWidth; }
sal_uInt16 GetOutWidth() const;
sal_uInt16 GetInWidth() const;
sal_uInt16 GetDistance() const;
SvxBorderLineStyle GetBorderLineStyle() const { return m_nStyle; }
void SetColor( const Color &rColor ) { aColor = rColor; }
void SetBorderLineStyle( SvxBorderLineStyle nNew );
void ScaleMetrics( tools::Long nMult, tools::Long nDiv );
bool operator==( const SvxBorderLine &rCmp ) const;
OUString GetValueString( MapUnit eSrcUnit, MapUnit eDestUnit,
const IntlWrapper* pIntl,
bool bMetricStr = false ) const;
bool HasPriority( const SvxBorderLine& rOtherLine ) const;
bool isEmpty() const {
return m_aWidthImpl.IsEmpty()
|| m_nStyle == SvxBorderLineStyle::NONE
|| m_nWidth == 0;
}
bool isDouble() const { return m_aWidthImpl.IsDouble(); }
sal_uInt16 GetScaledWidth() const { return GetOutWidth() + GetInWidth() + GetDistance(); }
static Color darkColor( Color aMain );
static Color lightColor( Color aMain );
static Color threeDLightColor( Color aMain );
static Color threeDMediumColor( Color aMain );
static Color threeDDarkColor( Color aMain );
static BorderWidthImpl getWidthImpl( SvxBorderLineStyle nStyle );
};
EDITENG_DLLPUBLIC bool operator!=( const SvxBorderLine& rLeft, const SvxBorderLine& rRight );
} // namespace editeng
#endif
|
