include/editeng/borderline.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_EDITENG_BORDERLINE_HXX
  21 #define INCLUDED_EDITENG_BORDERLINE_HXX
  22
  23 #include <com/sun/star/table/BorderLineStyle.hpp>
  24
  25 #include <tools/color.hxx>
  26 #include <tools/long.hxx>
  27 #include <tools/mapunit.hxx>
  28 #include <editeng/editengdllapi.h>
  29 #include <svtools/borderline.hxx>
  30
  31 class IntlWrapper;
  32
  33 // Line width defaults in twips
  34 // Thin matches Excel's default values
  35 // See tdf#48622 for the discussion leading to these defaults.
  36 class SvxBorderLineWidth
  37 {
  38 public:
  39     static const sal_Int16 Hairline = 1; // 0.05pt
  40     static const sal_Int16 VeryThin = 10; // 0.5pt
  41     static const sal_Int16 Thin = 15; // 0.75pt
  42     static const sal_Int16 Medium = 30; // 1.5pt
  43     static const sal_Int16 Thick = 45; // 2.25pt
  44     static const sal_Int16 ExtraThick = 90; // 4.5pt
  45 };
  46
  47 // Abstracts over values from css::table::BorderLineStyle
  48 enum class SvxBorderLineStyle : sal_Int16
  49 {
  50     /** No border line
  51      */
  52     NONE = css::table::BorderLineStyle::NONE,
  53
  54     /** Solid border line.
  55      */
  56     SOLID = css::table::BorderLineStyle::SOLID,
  57
  58     /** Dotted border line.
  59      */
  60     DOTTED = css::table::BorderLineStyle::DOTTED,
  61
  62     /** Dashed border line.
  63      */
  64     DASHED = css::table::BorderLineStyle::DASHED,
  65
  66     /** Double border line. Widths of the lines and the gap are all equal,
  67         and vary equally with the total width.
  68      */
  69     DOUBLE = css::table::BorderLineStyle::DOUBLE,
  70
  71     /** Double border line with a thin line outside and a thick line
  72         inside separated by a small gap.
  73      */
  74     THINTHICK_SMALLGAP = css::table::BorderLineStyle::THINTHICK_SMALLGAP,
  75
  76     /** Double border line with a thin line outside and a thick line
  77         inside separated by a medium gap.
  78      */
  79     THINTHICK_MEDIUMGAP = css::table::BorderLineStyle::THINTHICK_MEDIUMGAP,
  80
  81     /** Double border line with a thin line outside and a thick line
  82         inside separated by a large gap.
  83      */
  84     THINTHICK_LARGEGAP = css::table::BorderLineStyle::THINTHICK_LARGEGAP,
  85
  86     /** Double border line with a thick line outside and a thin line
  87         inside separated by a small gap.
  88      */
  89     THICKTHIN_SMALLGAP = css::table::BorderLineStyle::THICKTHIN_SMALLGAP,
  90
  91     /** Double border line with a thick line outside and a thin line
  92         inside separated by a medium gap.
  93      */
  94     THICKTHIN_MEDIUMGAP = css::table::BorderLineStyle::THICKTHIN_MEDIUMGAP,
  95
  96     /** Double border line with a thick line outside and a thin line
  97         inside separated by a large gap.
  98      */
  99     THICKTHIN_LARGEGAP = css::table::BorderLineStyle::THICKTHIN_LARGEGAP,
 100
 101     /** 3D embossed border line.
 102      */
 103     EMBOSSED = css::table::BorderLineStyle::EMBOSSED,
 104
 105     /** 3D engraved border line.
 106      */
 107     ENGRAVED = css::table::BorderLineStyle::ENGRAVED,
 108
 109     /** Outset border line.
 110      */
 111     OUTSET = css::table::BorderLineStyle::OUTSET,
 112
 113     /** Inset border line.
 114      */
 115     INSET = css::table::BorderLineStyle::INSET,
 116
 117     /** Finely dashed border line.
 118      */
 119     FINE_DASHED = css::table::BorderLineStyle::FINE_DASHED,
 120
 121     /** Double border line consisting of two fixed thin lines separated by a
 122         variable gap.
 123      */
 124     DOUBLE_THIN = css::table::BorderLineStyle::DOUBLE_THIN,
 125
 126     /** Line consisting of a repetition of one dash and one dot. */
 127     DASH_DOT = css::table::BorderLineStyle::DASH_DOT,
 128
 129     /** Line consisting of a repetition of one dash and 2 dots. */
 130     DASH_DOT_DOT = css::table::BorderLineStyle::DASH_DOT_DOT,
 131
 132     /** Maximum valid border line style value.
 133      */
 134     BORDER_LINE_STYLE_MAX = css::table::BorderLineStyle::BORDER_LINE_STYLE_MAX,
 135 };
 136
 137 namespace editeng
 138 {
 139
 140 // convert border style between Word formats and LO
 141 SvxBorderLineStyle EDITENG_DLLPUBLIC ConvertBorderStyleFromWord(int);
 142 /// convert border width in twips between Word formats and LO
 143 double EDITENG_DLLPUBLIC ConvertBorderWidthToWord(SvxBorderLineStyle, double);
 144 double EDITENG_DLLPUBLIC ConvertBorderWidthFromWord(SvxBorderLineStyle,
 145         double, int);
 146
 147 class EDITENG_DLLPUBLIC SvxBorderLine final
 148 {
 149     tools::Long m_nWidth;
 150     tools::Long m_nMult;
 151     tools::Long m_nDiv;
 152     Color (*m_pColorOutFn)(Color);
 153     Color (*m_pColorInFn)(Color);
 154     Color (*m_pColorGapFn)(Color);
 155     BorderWidthImpl m_aWidthImpl;
 156     Color aColor;
 157     SvxBorderLineStyle   m_nStyle;
 158     bool m_bMirrorWidths;
 159     bool m_bUseLeftTop;
 160
 161 public:
 162     SvxBorderLine( const Color *pCol = nullptr,
 163             tools::Long nWidth = 0,
 164             SvxBorderLineStyle nStyle = SvxBorderLineStyle::SOLID,
 165             Color (*pColorOutFn)( Color ) = &darkColor,
 166             Color (*pColorInFn)( Color ) = &darkColor );
 167
 168     const Color&    GetColor() const { return aColor; }
 169     Color           GetColorOut( bool bLeftOrTop = true ) const;
 170     Color           GetColorIn( bool bLeftOrTop = true ) const;
 171     bool            HasGapColor() const { return m_pColorGapFn != nullptr; }
 172     Color           GetColorGap() const;
 173
 174     void SetWidth( tools::Long nWidth );
 175     /** Guess the style and width from the three lines widths values.
 176
 177         When the value of nStyle is SvxBorderLine::DOUBLE, the style set will be guessed
 178         using the three values to match the best possible style among the following:
 179             - SvxBorderLine::DOUBLE
 180             - SvxBorderLine::THINTHICK_SMALLGAP
 181             - SvxBorderLine::THINTHICK_MEDIUMGAP
 182             - SvxBorderLine::THINTHICK_LARGEGAP
 183             - SvxBorderLine::THICKTHIN_SMALLGAP
 184             - SvxBorderLine::THICKTHIN_MEDIUMGAP
 185             - SvxBorderLine::THICKTHIN_LARGEGAP
 186
 187         If no styles matches the width, then the width is set to 0.
 188
 189         There is one known case that could fit several styles: \a nIn = \a nDist = 0.75 pt,
 190         \a nOut = 1.5 pt. This case fits SvxBorderLine::THINTHICK_SMALLGAP and
 191         SvxBorderLine::THINTHICK_MEDIUMGAP with a 1.5 pt width and
 192         SvxBorderLine::THINTHICK_LARGEGAP with a 0.75 pt width. The same case happens
 193         also for thick-thin styles.
 194
 195         \param nStyle the border style used to guess the width.
 196         \param nIn the width of the inner line in 1th pt
 197         \param nOut the width of the outer line in 1th pt
 198         \param nDist the width of the gap between the lines in 1th pt
 199      */
 200     void            GuessLinesWidths( SvxBorderLineStyle nStyle, sal_uInt16 nOut, sal_uInt16 nIn = 0, sal_uInt16 nDist = 0 );
 201
 202     // TODO Hacky method to mirror lines in only a few cases
 203     void            SetMirrorWidths() { m_bMirrorWidths = true; }
 204     tools::Long            GetWidth( ) const { return m_nWidth; }
 205     sal_uInt16      GetOutWidth() const;
 206     sal_uInt16      GetInWidth() const;
 207     sal_uInt16      GetDistance() const;
 208
 209     SvxBorderLineStyle  GetBorderLineStyle() const { return m_nStyle; }
 210
 211     void            SetColor( const Color &rColor ) { aColor = rColor; }
 212     void            SetBorderLineStyle( SvxBorderLineStyle nNew );
 213     void            ScaleMetrics( tools::Long nMult, tools::Long nDiv );
 214
 215     bool            operator==( const SvxBorderLine &rCmp ) const;
 216
 217     OUString        GetValueString( MapUnit eSrcUnit, MapUnit eDestUnit,
 218                                     const IntlWrapper* pIntl,
 219                                     bool bMetricStr = false ) const;
 220
 221     bool            HasPriority( const SvxBorderLine& rOtherLine ) const;
 222
 223     bool isEmpty() const {
 224         return m_aWidthImpl.IsEmpty()
 225             || m_nStyle == SvxBorderLineStyle::NONE
 226             || m_nWidth == 0;
 227     }
 228     bool isDouble() const { return m_aWidthImpl.IsDouble(); }
 229     sal_uInt16 GetScaledWidth() const { return GetOutWidth() + GetInWidth() + GetDistance(); }
 230
 231     static Color darkColor( Color aMain );
 232     static Color lightColor( Color aMain );
 233
 234     static Color threeDLightColor( Color aMain );
 235     static Color threeDMediumColor( Color aMain );
 236     static Color threeDDarkColor( Color aMain );
 237
 238     static BorderWidthImpl getWidthImpl( SvxBorderLineStyle nStyle );
 239 };
 240
 241 EDITENG_DLLPUBLIC bool operator!=( const SvxBorderLine& rLeft, const SvxBorderLine& rRight );
 242
 243 } // namespace editeng
 244
 245 #endif
 246