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 <svl/poolitem.hxx>
  27 #include <editeng/editengdllapi.h>
  28 #include <svtools/ctrlbox.hxx>
  29
  30 // Line defaults in twips (former Writer defaults):
  31
  32 #define DEF_LINE_WIDTH_0        1
  33 #define DEF_LINE_WIDTH_1        20
  34 #define DEF_LINE_WIDTH_2        50
  35 #define DEF_LINE_WIDTH_3        80
  36 #define DEF_LINE_WIDTH_4        100
  37 #define DEF_LINE_WIDTH_5        10
  38
  39
  40 // Abstracts over values from css::table::BorderLineStyle
  41 enum class SvxBorderLineStyle : sal_Int16
  42 {
  43     /** No border line
  44      */
  45     NONE = css::table::BorderLineStyle::NONE,
  46
  47     /** Solid border line.
  48      */
  49     SOLID = css::table::BorderLineStyle::SOLID,
  50
  51     /** Dotted border line.
  52      */
  53     DOTTED = css::table::BorderLineStyle::DOTTED,
  54
  55     /** Dashed border line.
  56      */
  57     DASHED = css::table::BorderLineStyle::DASHED,
  58
  59     /** Double border line. Widths of the lines and the gap are all equal,
  60         and vary equally with the total width.
  61      */
  62     DOUBLE = css::table::BorderLineStyle::DOUBLE,
  63
  64     /** Double border line with a thin line outside and a thick line
  65         inside separated by a small gap.
  66      */
  67     THINTHICK_SMALLGAP = css::table::BorderLineStyle::THINTHICK_SMALLGAP,
  68
  69     /** Double border line with a thin line outside and a thick line
  70         inside separated by a medium gap.
  71      */
  72     THINTHICK_MEDIUMGAP = css::table::BorderLineStyle::THINTHICK_MEDIUMGAP,
  73
  74     /** Double border line with a thin line outside and a thick line
  75         inside separated by a large gap.
  76      */
  77     THINTHICK_LARGEGAP = css::table::BorderLineStyle::THINTHICK_LARGEGAP,
  78
  79     /** Double border line with a thick line outside and a thin line
  80         inside separated by a small gap.
  81      */
  82     THICKTHIN_SMALLGAP = css::table::BorderLineStyle::THICKTHIN_SMALLGAP,
  83
  84     /** Double border line with a thick line outside and a thin line
  85         inside separated by a medium gap.
  86      */
  87     THICKTHIN_MEDIUMGAP = css::table::BorderLineStyle::THICKTHIN_MEDIUMGAP,
  88
  89     /** Double border line with a thick line outside and a thin line
  90         inside separated by a large gap.
  91      */
  92     THICKTHIN_LARGEGAP = css::table::BorderLineStyle::THICKTHIN_LARGEGAP,
  93
  94     /** 3D embossed border line.
  95      */
  96     EMBOSSED = css::table::BorderLineStyle::EMBOSSED,
  97
  98     /** 3D engraved border line.
  99      */
 100     ENGRAVED = css::table::BorderLineStyle::ENGRAVED,
 101
 102     /** Outset border line.
 103      */
 104     OUTSET = css::table::BorderLineStyle::OUTSET,
 105
 106     /** Inset border line.
 107      */
 108     INSET = css::table::BorderLineStyle::INSET,
 109
 110     /** Finely dashed border line.
 111      */
 112     FINE_DASHED = css::table::BorderLineStyle::FINE_DASHED,
 113
 114     /** Double border line consisting of two fixed thin lines separated by a
 115         variable gap.
 116      */
 117     DOUBLE_THIN = css::table::BorderLineStyle::DOUBLE_THIN,
 118
 119     /** Line consisting of a repetition of one dash and one dot. */
 120     DASH_DOT = css::table::BorderLineStyle::DASH_DOT,
 121
 122     /** Line consisting of a repetition of one dash and 2 dots. */
 123     DASH_DOT_DOT = css::table::BorderLineStyle::DASH_DOT_DOT,
 124
 125     /** Maximum valid border line style value.
 126      */
 127     BORDER_LINE_STYLE_MAX = css::table::BorderLineStyle::BORDER_LINE_STYLE_MAX,
 128 };
 129
 130 namespace editeng
 131 {
 132
 133 // convert border style between Word formats and LO
 134 SvxBorderLineStyle EDITENG_DLLPUBLIC ConvertBorderStyleFromWord(int);
 135 /// convert border width in twips between Word formats and LO
 136 double EDITENG_DLLPUBLIC ConvertBorderWidthToWord(SvxBorderLineStyle, double);
 137 double EDITENG_DLLPUBLIC ConvertBorderWidthFromWord(SvxBorderLineStyle,
 138         double, int);
 139
 140 class EDITENG_DLLPUBLIC SvxBorderLine
 141 {
 142 protected:
 143     Color  aColor;
 144
 145     long m_nWidth;
 146     bool m_bMirrorWidths;
 147     BorderWidthImpl m_aWidthImpl;
 148     long m_nMult;
 149     long m_nDiv;
 150
 151     SvxBorderLineStyle   m_nStyle;
 152
 153     bool             m_bUseLeftTop;
 154     Color            (*m_pColorOutFn)( Color );
 155     Color            (*m_pColorInFn)( Color );
 156     Color            (*m_pColorGapFn)( Color );
 157
 158 public:
 159     SvxBorderLine( const Color *pCol = nullptr,
 160             long nWidth = 0,
 161             SvxBorderLineStyle nStyle = SvxBorderLineStyle::SOLID,
 162             Color (*pColorOutFn)( Color ) = &darkColor,
 163             Color (*pColorInFn)( Color ) = &darkColor );
 164     SvxBorderLine( const SvxBorderLine& r );
 165
 166     SvxBorderLine& operator=( const SvxBorderLine& r );
 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( 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     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( long nMult, 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