sw/inc/fmtcol.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 #ifndef INCLUDED_SW_INC_FMTCOL_HXX
  20 #define INCLUDED_SW_INC_FMTCOL_HXX
  21
  22 #include "swdllapi.h"
  23 #include "format.hxx"
  24 #include "hintids.hxx"
  25 #include "paratr.hxx"
  26 #include <rtl/ustring.hxx>
  27 #include <tools/solar.h>
  28
  29 #include <vector>
  30 #include <memory>
  31
  32 class SwAttrPool;
  33 namespace sw{ class DocumentStylePoolManager; }
  34
  35 /// SwFormatColl is just an SwFormat subclass that defaults to m_bAutoFormat=false, expressing that
  36 /// this set of formatting is a style, not direct formatting.
  37 class SAL_DLLPUBLIC_RTTI SwFormatColl: public SwFormat
  38 {
  39 protected:
  40     SwFormatColl( SwAttrPool& rPool, const char* pFormatName,
  41                 const WhichRangesContainer& pWhichRanges, SwFormatColl* pDerFrom,
  42                 sal_uInt16 nFormatWhich )
  43           : SwFormat( rPool, pFormatName, pWhichRanges, pDerFrom, nFormatWhich )
  44     { SetAuto(false); }
  45
  46     SwFormatColl( SwAttrPool& rPool, const OUString &rFormatName,
  47                 const WhichRangesContainer& pWhichRanges, SwFormatColl* pDerFrom,
  48                 sal_uInt16 nFormatWhich )
  49           : SwFormat( rPool, rFormatName, pWhichRanges, pDerFrom, nFormatWhich )
  50     { SetAuto(false); }
  51
  52 private:
  53     SwFormatColl(const SwFormatColl & ) = delete;
  54     const SwFormatColl &operator=(const SwFormatColl &) = delete;
  55 };
  56
  57 /// Represents the style of a paragraph.
  58 class SW_DLLPUBLIC SwTextFormatColl
  59     : public SwFormatColl
  60     , public sw::FormatDropDefiner
  61 {
  62     friend class SwDoc;
  63     friend class ::sw::DocumentStylePoolManager;
  64
  65     SwTextFormatColl(const SwTextFormatColl & rRef) = delete;
  66
  67     bool mbStayAssignedToListLevelOfOutlineStyle;
  68
  69     bool mbAssignedToOutlineStyle;
  70
  71     bool m_bInSwFntCache;
  72
  73     SwTextFormatColl *mpNextTextFormatColl;
  74
  75     SwCharFormat* mpLinkedCharFormat = nullptr;
  76
  77 protected:
  78     SwTextFormatColl( SwAttrPool& rPool, const char* pFormatCollName,
  79                     SwTextFormatColl* pDerFrom = nullptr,
  80                     sal_uInt16 nFormatWh = RES_TXTFMTCOLL )
  81         : SwFormatColl(rPool, pFormatCollName, aTextFormatCollSetRange, pDerFrom, nFormatWh)
  82         , mbStayAssignedToListLevelOfOutlineStyle(false)
  83         , mbAssignedToOutlineStyle(false)
  84         , m_bInSwFntCache(false)
  85     {
  86         mpNextTextFormatColl = this;
  87     }
  88
  89     SwTextFormatColl( SwAttrPool& rPool, const OUString &rFormatCollName,
  90                     SwTextFormatColl* pDerFrom,
  91                     sal_uInt16 nFormatWh = RES_TXTFMTCOLL )
  92         : SwFormatColl(rPool, rFormatCollName, aTextFormatCollSetRange, pDerFrom, nFormatWh)
  93         , mbStayAssignedToListLevelOfOutlineStyle(false)
  94         , mbAssignedToOutlineStyle(false)
  95         , m_bInSwFntCache(false)
  96     {
  97         mpNextTextFormatColl = this;
  98     }
  99
 100     /// To get UL- / LR- / FontHeight-changes.
 101     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
 102
 103 public:
 104     virtual ~SwTextFormatColl();
 105     inline void SetNextTextFormatColl(SwTextFormatColl& rNext);
 106     SwTextFormatColl& GetNextTextFormatColl() const { return *mpNextTextFormatColl; }
 107
 108     void SetLinkedCharFormat(SwCharFormat* pLink);
 109
 110     const SwCharFormat* GetLinkedCharFormat() const;
 111
 112     bool IsAtDocNodeSet() const;
 113
 114     void SetAttrOutlineLevel( int );
 115     int  GetAttrOutlineLevel() const;
 116
 117     // Return the list level of the Outline Style - the List Style for the
 118     // outline numbering -
 119     // to which the Paragraph Style is assigned.
 120     int  GetAssignedOutlineStyleLevel() const;
 121
 122     bool IsAssignedToListLevelOfOutlineStyle() const
 123     {
 124         return mbAssignedToOutlineStyle;
 125     }
 126
 127     // If a Paragraph Style is assigned to list level N of the Outline Style,
 128     // then its outline level - AttrOutlineLevel - is set to N+1
 129     void AssignToListLevelOfOutlineStyle(const int nAssignedListLevel);
 130     void DeleteAssignmentToListLevelOfOutlineStyle();
 131
 132     /** Override to recognize changes on the <SwNumRuleItem> and register/unregister
 133      the paragragh style at the corresponding <SwNumRule> instance. */
 134     virtual bool SetFormatAttr( const SfxPoolItem& rAttr ) override;
 135     virtual bool SetFormatAttr( const SfxItemSet& rSet ) override;
 136     virtual bool ResetFormatAttr( sal_uInt16 nWhich1, sal_uInt16 nWhich2 = 0 ) override;
 137
 138     /// Override <ResetAllFormatAttr()> to stay assigned to list level of outline style.
 139     virtual sal_uInt16 ResetAllFormatAttr() override;
 140
 141     bool StayAssignedToListLevelOfOutlineStyle() const
 142     {
 143         return mbStayAssignedToListLevelOfOutlineStyle;
 144     }
 145
 146     ::sw::ListLevelIndents AreListLevelIndentsApplicable() const;
 147     bool AreListLevelIndentsApplicableImpl(sal_uInt16 nWhich) const;
 148
 149     void dumpAsXml(xmlTextWriterPtr pWriter) const;
 150     virtual void FormatDropNotify(const SwFormatDrop& rDrop) override
 151     {
 152         if(HasWriterListeners() && !IsModifyLocked())
 153             CallSwClientNotify(sw::LegacyModifyHint(&rDrop, &rDrop));
 154     };
 155     bool IsInSwFntCache() const { return m_bInSwFntCache; };
 156     void SetInSwFntCache() { m_bInSwFntCache = true; };
 157     virtual void InvalidateInSwFntCache(sal_uInt16 nWhich) override
 158     {
 159         if(isCHRATR(nWhich))
 160         {
 161             m_bInSwFntCache = false;
 162         }
 163         else
 164         {
 165             switch(nWhich)
 166             {
 167                 case RES_OBJECTDYING:
 168                 case RES_FMT_CHG:
 169                 case RES_ATTRSET_CHG:
 170                     m_bInSwFntCache = false;
 171             }
 172         }
 173     };
 174 };
 175
 176 class SwGrfFormatColl final : public SwFormatColl
 177 {
 178     friend class SwDoc;
 179
 180     SwGrfFormatColl( SwAttrPool& rPool, const char* pFormatCollName,
 181                     SwGrfFormatColl* pDerFrom = nullptr )
 182         : SwFormatColl( rPool, pFormatCollName, aGrfFormatCollSetRange,
 183                     pDerFrom, RES_GRFFMTCOLL )
 184     {}
 185
 186     SwGrfFormatColl( SwAttrPool& rPool, const OUString &rFormatCollName,
 187                     SwGrfFormatColl* pDerFrom )
 188         : SwFormatColl( rPool, rFormatCollName, aGrfFormatCollSetRange,
 189                     pDerFrom, RES_GRFFMTCOLL )
 190     {}
 191 };
 192
 193 // FEATURE::CONDCOLL
 194 /// Conditional styles.
 195 enum class Master_CollCondition
 196 {
 197     NONE,
 198     PARA_IN_LIST,
 199     PARA_IN_OUTLINE,
 200     PARA_IN_FRAME,
 201     PARA_IN_TABLEHEAD,
 202     PARA_IN_TABLEBODY,
 203     PARA_IN_SECTION,
 204     PARA_IN_FOOTNOTE,
 205     PARA_IN_FOOTER,
 206     PARA_IN_HEADER,
 207     PARA_IN_ENDNOTE
 208 };
 209
 210 class SW_DLLPUBLIC SwCollCondition final : public SwClient
 211 {
 212     Master_CollCondition m_nCondition;
 213     sal_uInt32 m_nSubCondition;
 214
 215 public:
 216
 217     SwCollCondition( SwTextFormatColl* pColl, Master_CollCondition nMasterCond,
 218                     sal_uInt32 nSubCond );
 219     virtual ~SwCollCondition() override;
 220
 221     /// @@@ public copy ctor, but no copy assignment?
 222     SwCollCondition( const SwCollCondition& rCpy );
 223 private:
 224     /// @@@ public copy ctor, but no copy assignment?
 225     SwCollCondition & operator= (const SwCollCondition &) = delete;
 226 public:
 227
 228     bool operator==( const SwCollCondition& rCmp ) const;
 229
 230     Master_CollCondition GetCondition() const      { return m_nCondition; }
 231     sal_uInt32 GetSubCondition() const   { return m_nSubCondition; }
 232
 233     void SetCondition( Master_CollCondition nCond, sal_uInt32 nSubCond );
 234     SwTextFormatColl* GetTextFormatColl() const     { return const_cast<SwTextFormatColl*>(static_cast<const SwTextFormatColl*>(GetRegisteredIn())); }
 235     void RegisterToFormat( SwFormat& );
 236 };
 237
 238 using SwFormatCollConditions = std::vector<std::unique_ptr<SwCollCondition>>;
 239
 240 class SW_DLLPUBLIC SwConditionTextFormatColl final : public SwTextFormatColl
 241 {
 242     friend class SwDoc;
 243     friend class ::sw::DocumentStylePoolManager;
 244
 245     SwFormatCollConditions m_CondColls;
 246
 247     SwConditionTextFormatColl( SwAttrPool& rPool, const OUString &rFormatCollName,
 248                             SwTextFormatColl* pDerFrom )
 249         : SwTextFormatColl( rPool, rFormatCollName, pDerFrom, RES_CONDTXTFMTCOLL )
 250     {}
 251
 252 public:
 253
 254     virtual ~SwConditionTextFormatColl() override;
 255
 256     const SwCollCondition* HasCondition( const SwCollCondition& rCond ) const;
 257     const SwFormatCollConditions& GetCondColls() const { return m_CondColls; }
 258     void InsertCondition( const SwCollCondition& rCond );
 259     void RemoveCondition( const SwCollCondition& rCond );
 260
 261     void SetConditions( const SwFormatCollConditions& );
 262 };
 263
 264 // FEATURE::CONDCOLL
 265 /// Inline implementations.
 266 inline void SwTextFormatColl::SetNextTextFormatColl( SwTextFormatColl& rNext )
 267 {
 268     mpNextTextFormatColl = &rNext;
 269 }
 270 #endif
 271
 272 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */