sw/inc/numrule.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_NUMRULE_HXX
  20 #define INCLUDED_SW_INC_NUMRULE_HXX
  21
  22 #include <sal/types.h>
  23 #include <rtl/ustring.hxx>
  24 #include <editeng/numitem.hxx>
  25 #include <i18nlangtag/lang.h>
  26 #include "swdllapi.h"
  27 #include "swtypes.hxx"
  28 #include "calbck.hxx"
  29 #include "SwNumberTreeTypes.hxx"
  30 #include "ndarr.hxx"
  31 #include <unordered_map>
  32 #include <memory>
  33 #include <vector>
  34 #include "charfmt.hxx"
  35 #include "fmtornt.hxx"
  36
  37 class SwTextFormatColl;
  38 class IDocumentListsAccess;
  39 class SwNodeNum;
  40 namespace vcl { class Font; }
  41 class SvxBrushItem;
  42 class SfxGrabBagItem;
  43 class SwDoc;
  44 class SwTextNode;
  45 class Size;
  46 class SwWrtShell;
  47
  48 const sal_Unicode cBulletChar = 0x2022; ///< Character for lists.
  49
  50 class SW_DLLPUBLIC SwNumFormat final : public SvxNumberFormat, public SwClient
  51 {
  52     SwFormatVertOrient m_aVertOrient;
  53     //For i120928,record the cp info of graphic within bullet
  54     sal_Unicode     m_cGrfBulletCP;
  55     SAL_DLLPRIVATE void UpdateNumNodes(SwDoc& rDoc);
  56
  57     using SvxNumberFormat::operator ==;
  58     using SvxNumberFormat::operator !=;
  59
  60     virtual void SwClientNotify(const SwModify&, const SfxHint&) override;
  61
  62 public:
  63     SwNumFormat();
  64     SwNumFormat( const SwNumFormat& );
  65     SwNumFormat( const SvxNumberFormat&, SwDoc* pDoc);
  66
  67     virtual ~SwNumFormat() override;
  68
  69     SwNumFormat& operator=( const SwNumFormat& );
  70
  71     bool operator==( const SwNumFormat& ) const;
  72     bool operator!=( const SwNumFormat& r ) const { return !(*this == r); }
  73
  74     SwCharFormat* GetCharFormat() const { return const_cast<SwCharFormat*>(static_cast<const SwCharFormat*>(GetRegisteredIn())); }
  75     void       SetCharFormat( SwCharFormat* );
  76
  77     using SvxNumberFormat::SetCharFormatName;
  78     virtual OUString        GetCharFormatName() const override;
  79
  80     //For i120928,access the cp info of graphic within bullet
  81     void            SetGrfBulletCP(sal_Unicode cP){m_cGrfBulletCP = cP;}
  82     sal_Unicode     GetGrfBulletCP() const {return m_cGrfBulletCP;}
  83
  84     virtual void    SetGraphicBrush( const SvxBrushItem* pBrushItem, const Size* pSize = nullptr, const sal_Int16* pOrient = nullptr) override;
  85
  86     const SwFormatVertOrient*      GetGraphicOrientation() const;
  87
  88     bool IsEnumeration() const; // #i22362#
  89     bool IsItemize() const; // #i29560#
  90 };
  91
  92 enum SwNumRuleType { OUTLINE_RULE = 0, NUM_RULE = 1, RULE_END = 2 };
  93 class SW_DLLPUBLIC SwNumRule
  94 {
  95
  96 public:
  97     typedef std::vector< SwTextNode* > tTextNodeList;
  98     typedef std::vector< SwTextFormatColl* > tParagraphStyleList;
  99
 100     struct Extremities
 101     {
 102         sal_uInt16 nPrefixChars;
 103         sal_uInt16 nSuffixChars;
 104     };
 105
 106 private:
 107     friend void FinitCore();
 108
 109     static SwNumFormat* saBaseFormats [ RULE_END ][ MAXLEVEL ];
 110     static const sal_uInt16 saDefNumIndents[ MAXLEVEL ];
 111     /// default list level properties for position-and-space mode LABEL_ALIGNMENT
 112     static SwNumFormat* saLabelAlignmentBaseFormats [ RULE_END ][ MAXLEVEL ];
 113     static sal_uInt16 snRefCount;
 114
 115     std::unique_ptr<SwNumFormat> maFormats[ MAXLEVEL ];
 116
 117     /** container for associated text nodes */
 118     tTextNodeList maTextNodeList;
 119
 120     /** container for associated paragraph styles */
 121     tParagraphStyleList maParagraphStyleList;
 122
 123     /** unordered_map containing "name->rule" relation */
 124     std::unordered_map<OUString, SwNumRule *> * mpNumRuleMap;
 125
 126     OUString msName;
 127     SwNumRuleType meRuleType;
 128     sal_uInt16 mnPoolFormatId;      ///< Id-for NumRules created "automatically"
 129     sal_uInt16 mnPoolHelpId;     ///< HelpId for this Pool-style.
 130     sal_uInt8 mnPoolHlpFileId;   ///< FilePos at Doc on style helps.
 131     bool mbAutoRuleFlag : 1;
 132     bool mbInvalidRuleFlag : 1;
 133     bool mbContinusNum : 1;  ///< Continuous numbering without levels.
 134     bool mbAbsSpaces : 1;    ///< Levels represent absolute indents.
 135     bool mbHidden : 1;       ///< Is the numbering rule to be hidden in the UI?
 136     bool mbCountPhantoms;
 137     bool mbUsedByRedline;    /// it needs to export as part of tracked numbering change
 138
 139     SvxNumberFormat::SvxNumPositionAndSpaceMode meDefaultNumberFormatPositionAndSpaceMode;
 140     OUString msDefaultListId;
 141     std::shared_ptr<SfxGrabBagItem> mpGrabBagItem; ///< Style InteropGrabBag.
 142
 143 public:
 144     /// add parameter <eDefaultNumberFormatPositionAndSpaceMode>
 145     SwNumRule( OUString aNm,
 146                const SvxNumberFormat::SvxNumPositionAndSpaceMode eDefaultNumberFormatPositionAndSpaceMode,
 147                SwNumRuleType = NUM_RULE );
 148
 149     SwNumRule( const SwNumRule& );
 150     ~SwNumRule();
 151
 152     SwNumRule& operator=( const SwNumRule& );
 153     bool operator==( const SwNumRule& ) const;
 154     bool operator!=( const SwNumRule& r ) const { return !(*this == r); }
 155
 156     void Reset( const OUString& rName );
 157
 158     const SwNumFormat* GetNumFormat( sal_uInt16 i ) const;
 159     const SwNumFormat& Get( sal_uInt16 i ) const;
 160
 161     bool IsHidden( ) const { return mbHidden; }
 162     void SetHidden( bool bValue ) { mbHidden = bValue; }
 163
 164     void Set( sal_uInt16 i, const SwNumFormat* );
 165     void Set( sal_uInt16 i, const SwNumFormat& );
 166     OUString MakeNumString( const SwNodeNum&, bool bInclStrings = true ) const;
 167     /** - add optional parameter <_nRestrictToThisLevel> in order to
 168          restrict returned string to this level. */
 169     OUString MakeNumString( const SwNumberTree::tNumberVector & rNumVector,
 170                           const bool bInclStrings = true,
 171                           const unsigned int _nRestrictToThisLevel = MAXLEVEL,
 172                           Extremities* pExtremities = nullptr,
 173                           LanguageType nLang = LANGUAGE_SYSTEM) const;
 174     OUString MakeRefNumString( const SwNodeNum& rNodeNum,
 175                              const bool bInclSuperiorNumLabels,
 176                              const int nRestrictInclToThisLevel ) const;
 177     OUString MakeParagraphStyleListString() const;
 178
 179     /** @return list of associated text nodes */
 180     void GetTextNodeList( SwNumRule::tTextNodeList& rTextNodeList ) const;
 181     SwNumRule::tTextNodeList::size_type GetTextNodeListSize() const;
 182
 183     void AddTextNode( SwTextNode& rTextNode );
 184     void RemoveTextNode( SwTextNode& rTextNode );
 185
 186     SwNumRule::tParagraphStyleList::size_type GetParagraphStyleListSize() const;
 187     void AddParagraphStyle( SwTextFormatColl& rTextFormatColl );
 188     void RemoveParagraphStyle( SwTextFormatColl& rTextFormatColl );
 189
 190     void SetDefaultListId( const OUString& sDefaultListId )
 191     {
 192         msDefaultListId = sDefaultListId;
 193     }
 194     const OUString& GetDefaultListId() const
 195     {
 196         return msDefaultListId;
 197     }
 198     /**
 199        Register this rule in a "name->numrule" map.
 200
 201        @param pNumRuleMap      map to register in
 202      */
 203     void SetNumRuleMap(
 204                 std::unordered_map<OUString, SwNumRule *>* pNumRuleMap );
 205
 206     static OUString GetOutlineRuleName();
 207
 208     static sal_uInt16 GetNumIndent( sal_uInt8 nLvl );
 209     static sal_uInt16 GetBullIndent( sal_uInt8 nLvl );
 210
 211     SwNumRuleType GetRuleType() const           { return meRuleType; }
 212     void SetRuleType( SwNumRuleType eNew )      { meRuleType = eNew;
 213                                                   mbInvalidRuleFlag = true; }
 214
 215     /** A kind of copy-constructor to make sure the num formats are
 216        attached to the correctCharFormats of a document!!
 217        (Copies the NumFormats and returns itself). */
 218     SwNumRule& CopyNumRule( SwDoc&, const SwNumRule& );
 219
 220     /** Tests whether the CharFormats are from the given doc
 221        and copies them if appropriate. */
 222     void CheckCharFormats( SwDoc& rDoc );
 223
 224     const OUString& GetName() const { return msName; }
 225
 226     void SetName( const OUString& rNm,
 227                   IDocumentListsAccess& rDocListAccess );
 228
 229     bool IsAutoRule() const             { return mbAutoRuleFlag; }
 230     void SetAutoRule( bool bFlag )      { mbAutoRuleFlag = bFlag; }
 231
 232     bool IsInvalidRule() const          { return mbInvalidRuleFlag; }
 233     void SetInvalidRule( bool bFlag );
 234
 235     bool IsContinusNum() const          { return mbContinusNum; }
 236     void SetContinusNum( bool bFlag )   { mbContinusNum = bFlag; }
 237
 238     bool IsAbsSpaces() const            { return mbAbsSpaces; }
 239     void SetAbsSpaces( bool bFlag )     { mbAbsSpaces = bFlag; }
 240
 241     bool IsOutlineRule() const { return meRuleType == OUTLINE_RULE; }
 242
 243     bool IsCountPhantoms() const        { return mbCountPhantoms; }
 244     void SetCountPhantoms(bool bCountPhantoms);
 245
 246     bool IsUsedByRedline() const        { return mbUsedByRedline; }
 247     void SetUsedByRedline(bool bUsed )  { mbUsedByRedline = bUsed; }
 248
 249     /// Query and set PoolFormat IDs.
 250     sal_uInt16 GetPoolFormatId() const         { return mnPoolFormatId; }
 251     void SetPoolFormatId( sal_uInt16 nId )     { mnPoolFormatId = nId; }
 252
 253     /// Query and set Help-IDs for document styles.
 254     sal_uInt16 GetPoolHelpId() const        { return mnPoolHelpId; }
 255     void SetPoolHelpId( sal_uInt16 nId )    { mnPoolHelpId = nId; }
 256     sal_uInt8 GetPoolHlpFileId() const      { return mnPoolHlpFileId; }
 257     void SetPoolHlpFileId( sal_uInt8 nId )  { mnPoolHlpFileId = nId; }
 258
 259     void        SetSvxRule(const SvxNumRule&, SwDoc* pDoc);
 260     SvxNumRule  MakeSvxNumRule() const;
 261
 262     /// change indent of all list levels by given difference
 263     void ChangeIndent( const sal_Int32 nDiff );
 264     /// set indent of certain list level to given value
 265     void SetIndent( const short nNewIndent,
 266                     const sal_uInt16 nListLevel );
 267     /** set indent of first list level to given value and change other list level's
 268        indents accordingly */
 269     void SetIndentOfFirstListLevelAndChangeOthers( const short nNewIndent );
 270
 271     void Validate(const SwDoc& rDoc);
 272     void dumpAsXml(xmlTextWriterPtr w) const;
 273     void GetGrabBagItem(css::uno::Any& rVal) const;
 274     void SetGrabBagItem(const css::uno::Any& rVal);
 275 };
 276
 277 /// namespace for static functions and methods for numbering and bullets
 278 namespace numfunc
 279 {
 280     /** retrieve font family name used for the default bullet list characters */
 281     OUString const & GetDefBulletFontname();
 282
 283     /** determine if default bullet font is user defined
 284
 285         The default bullet font is user defined, if it is given in the user configuration
 286     */
 287     bool IsDefBulletFontUserDefined();
 288
 289     /** retrieve font used for the default bullet list characters */
 290     SW_DLLPUBLIC const vcl::Font& GetDefBulletFont();
 291
 292     /** retrieve unicode of character used for the default bullet list for the given list level */
 293     sal_Unicode GetBulletChar( sal_uInt8 nLevel );
 294
 295     /** configuration, if at first position of the first list item the <TAB>-key
 296         increased the indent of the complete list or only demotes this list item.
 297         The same for <SHIFT-TAB>-key at the same position for decreasing the
 298         indent of the complete list or only promotes this list item.
 299     */
 300     bool ChangeIndentOnTabAtFirstPosOfFirstListItem();
 301
 302     /**
 303      * Decides if increasing ("downing") the numbering level will change the amount of indentation
 304      * or not. This is typically true, unless the numbering levels are invisible and have no
 305      * indents.
 306      */
 307     bool NumDownChangesIndent(const SwWrtShell& rShell);
 308
 309     SvxNumberFormat::SvxNumPositionAndSpaceMode GetDefaultPositionAndSpaceMode();
 310 }
 311
 312 #endif // INCLUDED_SW_INC_NUMRULE_HXX
 313
 314 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */