include/editeng/boxitem.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_BOXITEM_HXX
  21 #define INCLUDED_EDITENG_BOXITEM_HXX
  22
  23 #include <svl/poolitem.hxx>
  24 #include <editeng/editengdllapi.h>
  25 #include <com/sun/star/table/BorderLine2.hpp>
  26 #include <o3tl/typed_flags_set.hxx>
  27 #include <docmodel/color/ComplexColor.hxx>
  28 #include <memory>
  29 #include <array>
  30
  31
  32 namespace editeng { class SvxBorderLine; }
  33
  34 // class SvxBoxItem ------------------------------------------------------
  35
  36 /*  [Description]
  37
  38     This item describes a border attribute
  39     (all four edges and the inward distance)
  40 */
  41 enum class SvxBoxItemLine
  42 {
  43     TOP, BOTTOM, LEFT, RIGHT, LAST = RIGHT
  44 };
  45
  46 /**
  47 This version causes SvxBoxItem to store the 4 cell spacing distances separately
  48 when serializing to stream.
  49 */
  50 constexpr sal_uInt16 BOX_4DISTS_VERSION = 1;
  51 /**
  52 This version causes SvxBoxItem to store the styles for its border lines when
  53 serializing to stream.
  54 */
  55 constexpr sal_uInt16 BOX_BORDER_STYLE_VERSION = 2;
  56
  57 class EDITENG_DLLPUBLIC SvxBoxItem final : public SfxPoolItem
  58 {
  59     std::unique_ptr<editeng::SvxBorderLine> mpTopBorderLine;
  60     std::unique_ptr<editeng::SvxBorderLine> mpBottomBorderLine;
  61     std::unique_ptr<editeng::SvxBorderLine> mpLeftBorderLine;
  62     std::unique_ptr<editeng::SvxBorderLine> mpRightBorderLine;
  63
  64     sal_Int16 mnTopDistance = 0;
  65     sal_Int16 mnBottomDistance = 0;
  66     sal_Int16 mnLeftDistance = 0;
  67     sal_Int16 mnRightDistance = 0;
  68
  69     // Store complex colors until lines are created...
  70     std::array<model::ComplexColor, 4> maTempComplexColors;
  71
  72     bool mbRemoveAdjCellBorder = false;
  73
  74     void tryMigrateComplexColor(SvxBoxItemLine eLine);
  75
  76 public:
  77     static SfxPoolItem* CreateDefault();
  78
  79     explicit SvxBoxItem( const sal_uInt16 nId );
  80     SvxBoxItem( const SvxBoxItem &rCpy );
  81     virtual ~SvxBoxItem() override;
  82
  83     // "pure virtual Methods" from SfxPoolItem
  84     virtual bool            operator==( const SfxPoolItem& ) const override;
  85     virtual bool            supportsHashCode() const override { return true; }
  86     virtual size_t          hashCode() const override;
  87     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  88     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  89
  90     virtual bool GetPresentation( SfxItemPresentation ePres,
  91                                     MapUnit eCoreMetric,
  92                                     MapUnit ePresMetric,
  93                                     OUString &rText, const IntlWrapper& ) const override;
  94
  95     virtual SvxBoxItem*      Clone( SfxItemPool *pPool = nullptr ) const override;
  96
  97     virtual void             ScaleMetrics( tools::Long nMult, tools::Long nDiv ) override;
  98     virtual bool             HasMetrics() const override;
  99
 100     const editeng::SvxBorderLine* GetTop() const
 101     {
 102         return mpTopBorderLine.get();
 103     }
 104     const editeng::SvxBorderLine* GetBottom() const
 105     {
 106         return mpBottomBorderLine.get();
 107     }
 108     const editeng::SvxBorderLine* GetLeft() const
 109     {
 110         return mpLeftBorderLine.get();
 111     }
 112     const editeng::SvxBorderLine* GetRight() const
 113     {
 114         return mpRightBorderLine.get();
 115     }
 116
 117     editeng::SvxBorderLine* GetTop()
 118     {
 119         ASSERT_CHANGE_REFCOUNTED_ITEM;
 120         return mpTopBorderLine.get();
 121     }
 122     editeng::SvxBorderLine* GetBottom()
 123     {
 124         ASSERT_CHANGE_REFCOUNTED_ITEM;
 125         return mpBottomBorderLine.get();
 126     }
 127     editeng::SvxBorderLine* GetLeft()
 128     {
 129         ASSERT_CHANGE_REFCOUNTED_ITEM;
 130         return mpLeftBorderLine.get();
 131     }
 132     editeng::SvxBorderLine* GetRight()
 133     {
 134         ASSERT_CHANGE_REFCOUNTED_ITEM;
 135         return mpRightBorderLine.get();
 136     }
 137
 138     const   editeng::SvxBorderLine* GetLine( SvxBoxItemLine nLine ) const;
 139
 140     //The Pointers are being copied!
 141     void    SetLine( const editeng::SvxBorderLine* pNew, SvxBoxItemLine nLine );
 142
 143     sal_Int16  GetDistance( SvxBoxItemLine nLine, bool bAllowNegative = false ) const;
 144     sal_uInt16  GetSmallestDistance() const;
 145
 146     bool IsRemoveAdjacentCellBorder() const { return mbRemoveAdjCellBorder; }
 147
 148     void    SetDistance( sal_Int16 nNew, SvxBoxItemLine nLine );
 149     void SetAllDistances(sal_Int16 nNew)
 150     {
 151         ASSERT_CHANGE_REFCOUNTED_ITEM;
 152         mnTopDistance = mnBottomDistance = mnLeftDistance = mnRightDistance = nNew;
 153     }
 154
 155     void SetRemoveAdjacentCellBorder( bool bSet ) { ASSERT_CHANGE_REFCOUNTED_ITEM; mbRemoveAdjCellBorder = bSet; }
 156
 157     // Line width plus Space plus inward distance
 158     // bEvenIfNoLine = TRUE -> Also return distance, when no Line is set
 159     sal_uInt16  CalcLineWidth( SvxBoxItemLine nLine ) const;
 160     sal_Int16  CalcLineSpace( SvxBoxItemLine nLine, bool bEvenIfNoLine = false, bool bAllowNegative = false ) const;
 161     bool HasBorder( bool bTreatPaddingAsBorder ) const;
 162     static css::table::BorderLine2 SvxLineToLine( const editeng::SvxBorderLine* pLine, bool bConvert );
 163     static bool LineToSvxLine(const css::table::BorderLine& rLine, editeng::SvxBorderLine& rSvxLine, bool bConvert);
 164     static bool LineToSvxLine(const css::table::BorderLine2& rLine, editeng::SvxBorderLine& rSvxLine, bool bConvert);
 165
 166     virtual boost::property_tree::ptree dumpAsJSON() const override;
 167     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 168 };
 169
 170 // class SvxBoxInfoItem --------------------------------------------------
 171
 172 /*  [Description]
 173
 174     Another item for the border. This item has only limited functionality.
 175     On one hand, the general Dialog is told by the item which options it
 176     should offer. On the other hand, this attribute  may be used to
 177     transported the borderline for the inner horizontal and vertical lines.
 178 */
 179
 180 enum class SvxBoxInfoItemLine
 181 {
 182     HORI, VERT, LAST = VERT
 183 };
 184
 185 enum class SvxBoxInfoItemValidFlags
 186 {
 187     NONE          = 0x00,
 188     TOP           = 0x01,
 189     BOTTOM        = 0x02,
 190     LEFT          = 0x04,
 191     RIGHT         = 0x08,
 192     HORI          = 0x10,
 193     VERT          = 0x20,
 194     DISTANCE      = 0x40,
 195     DISABLE       = 0x80,
 196     ALL           = 0xff
 197 };
 198 namespace o3tl
 199 {
 200     template<> struct typed_flags<SvxBoxInfoItemValidFlags> : is_typed_flags<SvxBoxInfoItemValidFlags, 0xff> {};
 201 }
 202
 203 class EDITENG_DLLPUBLIC SvxBoxInfoItem final : public SfxPoolItem
 204 {
 205     std::unique_ptr<editeng::SvxBorderLine> mpHorizontalLine; //inner horizontal Line
 206     std::unique_ptr<editeng::SvxBorderLine> mpVerticalLine; //inner vertical Line
 207
 208     bool mbEnableHorizontalLine = false; /// true = Enable inner horizontal line.
 209     bool mbEnableVerticalLine = false; /// true = Enable inner vertical line.
 210
 211     /*
 212      Currently only for StarWriter: distance inward from SvxBoxItem. If the
 213      distance is requested, then the field for the distance from the dialog be
 214      activated. nDefDist is regarded as a default value. If any line is
 215      turned on or will be turned on it must this distance be set to default.
 216      bMinDist indicates whether the user can go below this value or not.
 217      With NDIST is the current distance from the app transported back and
 218      forth to the dialogue.
 219     */
 220
 221     bool mbDistance :1;  // TRUE, Unlock Distance.
 222     bool mbMinimumDistance :1;  // TRUE, Going below minimum Distance is prohibited
 223
 224     SvxBoxInfoItemValidFlags mnValidFlags;
 225     sal_uInt16 mnDefaultMinimumDistance = 0; // The default or minimum distance.
 226
 227 public:
 228     static SfxPoolItem* CreateDefault();
 229
 230     explicit SvxBoxInfoItem( const sal_uInt16 nId );
 231     SvxBoxInfoItem( const SvxBoxInfoItem &rCpy );
 232     virtual ~SvxBoxInfoItem() override;
 233
 234     // "pure virtual Methods" from SfxPoolItem
 235     virtual bool            operator==( const SfxPoolItem& ) const override;
 236     virtual bool            GetPresentation( SfxItemPresentation ePres,
 237                                     MapUnit eCoreMetric,
 238                                     MapUnit ePresMetric,
 239                                     OUString &rText, const IntlWrapper& ) const override;
 240     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 241     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
 242
 243     virtual SvxBoxInfoItem* Clone( SfxItemPool *pPool = nullptr ) const override;
 244     virtual void            ScaleMetrics( tools::Long nMult, tools::Long nDiv ) override;
 245     virtual bool            HasMetrics() const override;
 246
 247     const editeng::SvxBorderLine*   GetHori() const { return mpHorizontalLine.get(); }
 248     const editeng::SvxBorderLine*   GetVert() const { return mpVerticalLine.get(); }
 249
 250     //The Pointers are being copied!
 251     void                    SetLine( const editeng::SvxBorderLine* pNew, SvxBoxInfoItemLine nLine );
 252
 253     bool IsTable() const { return mbEnableHorizontalLine && mbEnableVerticalLine; }
 254     void SetTable(bool bNew) { mbEnableHorizontalLine = mbEnableVerticalLine = bNew; }
 255
 256     bool IsHorEnabled() const { return mbEnableHorizontalLine; }
 257     void EnableHor( bool bEnable ) { mbEnableHorizontalLine = bEnable; }
 258     bool IsVerEnabled() const { return mbEnableVerticalLine; }
 259     void EnableVer( bool bEnable ) { mbEnableVerticalLine = bEnable; }
 260
 261     bool IsDist() const { return mbDistance; }
 262     void SetDist(bool bNew)
 263     {
 264         mbDistance = bNew;
 265     }
 266     bool IsMinDist() const { return mbMinimumDistance; }
 267     void SetMinDist(bool bNew) { mbMinimumDistance = bNew; }
 268     sal_uInt16 GetDefDist() const { return mnDefaultMinimumDistance; }
 269     void SetDefDist(sal_uInt16 nNew) { mnDefaultMinimumDistance = nNew; }
 270
 271     bool IsValid( SvxBoxInfoItemValidFlags nValid ) const
 272     {
 273         return bool(mnValidFlags & nValid);
 274     }
 275     void SetValid(SvxBoxInfoItemValidFlags nValid, bool bValid = true)
 276     {
 277         if (bValid)
 278             mnValidFlags |= nValid;
 279         else
 280             mnValidFlags &= ~nValid;
 281     }
 282     void ResetFlags();
 283
 284     virtual boost::property_tree::ptree dumpAsJSON() const override;
 285 };
 286
 287 namespace editeng
 288 {
 289
 290 void EDITENG_DLLPUBLIC BorderDistanceFromWord(bool bFromEdge, sal_Int32& nMargin,
 291     sal_Int32& nBorderDistance, sal_Int32 nBorderWidth);
 292
 293 struct EDITENG_DLLPUBLIC WordPageMargins final
 294 {
 295     sal_uInt16 nLeft = 0;
 296     sal_uInt16 nRight = 0;
 297     sal_uInt16 nTop = 0;
 298     sal_uInt16 nBottom = 0;
 299 };
 300
 301 struct EDITENG_DLLPUBLIC WordBorderDistances final
 302 {
 303     bool bFromEdge = false;
 304     sal_uInt16 nLeft = 0;
 305     sal_uInt16 nRight = 0;
 306     sal_uInt16 nTop = 0;
 307     sal_uInt16 nBottom = 0;
 308 };
 309
 310 // Heuristics to decide if we need to use "from edge" offset of borders. All sizes in twips
 311 void EDITENG_DLLPUBLIC BorderDistancesToWord(const SvxBoxItem& rBox, const WordPageMargins& rMargins,
 312     WordBorderDistances& rDistances);
 313
 314 }
 315
 316 #endif
 317
 318 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */