Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 926 insertions, 0 deletions

diff --git a/sw/inc/ndtxt.hxx b/sw/inc/ndtxt.hxx
new file mode 100644
index 0000000000..3f99919f77
--- /dev/null
+++ b/sw/inc/ndtxt.hxx
@@ -0,0 +1,926 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#pragma once
+
+#include <cppuhelper/weakref.hxx>
+#include <com/sun/star/text/XTextContent.hpp>
+
+#include "swdllapi.h"
+#include "IDocumentContentOperations.hxx"
+#include "SwNumberTreeTypes.hxx"
+#include "hintids.hxx"
+#include "list.hxx"
+#include "modeltoviewhelper.hxx"
+#include "ndhints.hxx"
+#include "node.hxx"
+#include "paratr.hxx"
+
+#include <sfx2/Metadatable.hxx>
+#include <unotools/weakref.hxx>
+#include <o3tl/sorted_vector.hxx>
+#include <memory>
+#include <vector>
+#include <functional>
+
+class SfxHint;
+class SwNumRule;
+class SwNodeNum;
+class SvxFirstLineIndentItem;
+class SvxTextLeftMarginItem;
+class SwXParagraph;
+
+namespace utl {
+    class TransliterationWrapper;
+}
+namespace vcl
+{
+class Font;
+}
+
+class SwContentFrame;
+class SwTextField;
+class SwTextInputField;
+class SfxItemSet;
+class SwUndoTransliterate;
+struct SwSpellArgs;
+struct SwConversionArgs;
+class SwInterHyphInfo;
+class SwWrongList;
+class SwGrammarMarkUp;
+struct SwDocStat;
+enum class ExpandMode;
+enum class SwFieldIds : sal_uInt16;
+class SwField;
+
+namespace sw {
+    class TextNodeNotificationSuppressor;
+    namespace mark { enum class RestoreMode; }
+}
+
+namespace com::sun::star {
+    namespace uno {
+        template < class > class Sequence;
+    }
+}
+
+typedef o3tl::sorted_vector< sal_Int32 > SwSoftPageBreakList;
+
+namespace sw
+{
+
+enum class WrongState { TODO, PENDING, DONE };
+
+struct ParagraphIdleData
+{
+    std::unique_ptr<SwWrongList> pWrong;                // for spell checking
+    std::unique_ptr<SwGrammarMarkUp> pGrammarCheck;     // for grammar checking /  proof reading
+    std::unique_ptr<SwWrongList> pSmartTags;
+    sal_uLong nNumberOfWords  = 0;
+    sal_uLong nNumberOfAsianWords  = 0;
+    sal_uLong nNumberOfChars  = 0;
+    sal_uLong nNumberOfCharsExcludingSpaces = 0;
+    bool bWordCountDirty = true;
+    WrongState eWrongDirty = WrongState::TODO; ///< online spell checking needed/done?
+    bool bGrammarCheckDirty = true;
+    bool bSmartTagDirty = true;
+    bool bAutoComplDirty = true;               ///< auto complete list dirty
+};
+
+} // end namespace sw
+
+/// SwTextNode is a paragraph in the document model.
+class SW_DLLPUBLIC SwTextNode final
+    : public SwContentNode
+    , public ::sfx2::Metadatable
+    , public sw::FormatDropDefiner
+{
+    friend class SwContentNode;
+    /// For creating the first TextNode.
+    friend class SwDoc;         ///< CTOR and AppendTextNode()
+    friend class SwNodes;
+    friend class SwTextFrame;
+    friend class SwScriptInfo;
+    friend class sw::TextNodeNotificationSuppressor;
+
+    /** May be 0. It is only then not 0 if it contains hard attributes.
+       Therefore: never access directly! */
+    std::unique_ptr<SwpHints> m_pSwpHints;
+
+    mutable std::unique_ptr<SwNodeNum> mpNodeNum;  ///< Numbering for this paragraph.
+    mutable std::unique_ptr<SwNodeNum> mpNodeNumRLHidden; ///< Numbering for this paragraph (hidden redlines)
+    mutable std::unique_ptr<SwNodeNum> mpNodeNumOrig; ///< Numbering for this paragraph (before changes)
+
+    OUString m_Text;
+
+    mutable sw::ParagraphIdleData m_aParagraphIdleData;
+
+    /** Some of the chars this para are hidden. Paragraph has to be reformatted
+       on changing the view to print preview. */
+    mutable bool m_bContainsHiddenChars : 1;
+    /// The whole paragraph is hidden because of the hidden text attribute
+    mutable bool m_bHiddenCharsHidePara : 1;
+    /// The last two flags have to be recalculated if this flag is set:
+    mutable bool m_bRecalcHiddenCharFlags : 1;
+
+    mutable bool m_bLastOutlineState : 1;
+    bool m_bNotifiable;
+
+    bool mbEmptyListStyleSetDueToSetOutlineLevelAttr;
+
+    /** boolean, indicating that a <SetAttr(..)> or <ResetAttr(..)> or
+       <ResetAllAttr(..)> method is running.
+       Needed to avoid duplicate handling of attribute change actions. */
+    bool mbInSetOrResetAttr;
+
+    /// Is an undo operation in progress?
+    bool m_bInUndo;
+
+    std::optional< OUString > m_oNumStringCache;
+
+    unotools::WeakReference<SwXParagraph> m_wXParagraph;
+
+    // DrawingLayer FillAttributes in a preprocessed form for primitive usage
+    drawinglayer::attribute::SdrAllFillAttributesHelperPtr  maFillAttributes;
+
+    SAL_DLLPRIVATE SwTextNode( SwNode& rWhere, SwTextFormatColl *pTextColl,
+                             const SfxItemSet* pAutoAttr = nullptr );
+    virtual void SwClientNotify( const SwModify&, const SfxHint& ) override;
+    /// Copies the attributes at nStart to pDest.
+    SAL_DLLPRIVATE void CopyAttr( SwTextNode *pDest, const sal_Int32 nStart, const sal_Int32 nOldPos);
+
+    SAL_DLLPRIVATE SwTextNode* MakeNewTextNode( SwNode&, bool bNext = true,
+                                bool bChgFollow = true );
+
+    SAL_DLLPRIVATE void CutImpl(
+          SwTextNode * const pDest, const SwContentIndex & rDestStart,
+          const SwContentIndex & rStart, /*const*/ sal_Int32 nLen,
+          const bool bUpdate = true );
+
+    /// Move all comprising hard attributes to the AttrSet of the paragraph.
+    SAL_DLLPRIVATE void MoveTextAttr_To_AttrSet();  // Called by SplitNode.
+
+    /// Create the specific AttrSet.
+    SAL_DLLPRIVATE virtual void NewAttrSet( SwAttrPool& ) override;
+
+    /// Optimization: Asking for information about hidden characters at SwScriptInfo
+    /// updates these flags.
+    bool IsCalcHiddenCharFlags() const
+        { return m_bRecalcHiddenCharFlags; }
+    void SetHiddenCharAttribute( bool bNewHiddenCharsHidePara, bool bNewContainsHiddenChars ) const
+    {
+        m_bHiddenCharsHidePara = bNewHiddenCharsHidePara;
+        m_bContainsHiddenChars = bNewContainsHiddenChars;
+        m_bRecalcHiddenCharFlags = false;
+    }
+
+    SAL_DLLPRIVATE void CalcHiddenCharFlags() const;
+
+    SAL_DLLPRIVATE void SetLanguageAndFont( const SwPaM &rPaM,
+            LanguageType nLang, sal_uInt16 nLangWhichId,
+            const vcl::Font *pFont,  sal_uInt16 nFontWhichId );
+
+    inline void TryDeleteSwpHints();
+
+    SAL_DLLPRIVATE void impl_FormatToTextAttr(const SfxItemSet& i_rAttrSet);
+
+    const SwTextInputField* GetOverlappingInputField( const SwTextAttr& rTextAttr ) const;
+
+    void DelFrames_TextNodePart();
+    void HandleNonLegacyHint(const SfxHint&);
+
+public:
+    bool IsWordCountDirty() const;
+    sw::WrongState GetWrongDirty() const;
+    bool IsWrongDirty() const;
+    bool IsGrammarCheckDirty() const;
+    bool IsSmartTagDirty() const;
+    bool IsAutoCompleteWordDirty() const;
+    void SetWordCountDirty( bool bNew ) const;
+    void SetWrongDirty(sw::WrongState eNew) const;
+    void SetGrammarCheckDirty( bool bNew ) const;
+    void SetSmartTagDirty( bool bNew ) const;
+    void SetAutoCompleteWordDirty( bool bNew ) const;
+    void SetWrong( std::unique_ptr<SwWrongList> pNew );
+    void ClearWrong();
+    std::unique_ptr<SwWrongList> ReleaseWrong();
+    SwWrongList* GetWrong();
+    const SwWrongList* GetWrong() const;
+    void SetGrammarCheck( std::unique_ptr<SwGrammarMarkUp> pNew );
+    void ClearGrammarCheck();
+    std::unique_ptr<SwGrammarMarkUp> ReleaseGrammarCheck();
+    SwGrammarMarkUp* GetGrammarCheck();
+    // return SwWrongList because *function pointer* return values aren't covariant
+    SwWrongList const* GetGrammarCheck() const;
+    void SetSmartTags( std::unique_ptr<SwWrongList> pNew );
+    void ClearSmartTags();
+    std::unique_ptr<SwWrongList> ReleaseSmartTags();
+    SwWrongList* GetSmartTags();
+    SwWrongList const* GetSmartTags() const;
+
+    /// End: Data collected during idle time
+
+public:
+    using SwContentNode::GetAttr;
+    void UpdateDocPos(const SwTwips nDocPos, const sal_uInt32 nIndex);
+    /// for hanging TextFormatCollections somewhere else (Outline-Numbering!)
+    void TriggerNodeUpdate(const sw::LegacyModifyHint&);
+
+    const OUString& GetText() const { return m_Text; }
+
+    // returns the maximum number of characters that can still be added to the node
+    inline sal_Int32 GetSpaceLeft() const;
+
+    /// getters for SwpHints
+    inline       SwpHints &GetSwpHints();
+    inline const SwpHints &GetSwpHints() const;
+          SwpHints *GetpSwpHints()       { return m_pSwpHints.get(); }
+    const SwpHints *GetpSwpHints() const { return m_pSwpHints.get(); }
+    bool   HasHints() const { return m_pSwpHints != nullptr; }
+    inline       SwpHints &GetOrCreateSwpHints();
+
+    virtual ~SwTextNode() override;
+
+    virtual sal_Int32 Len() const override;
+
+    /// Is in itratr.
+    void GetMinMaxSize( SwNodeOffset nIndex, sal_uLong& rMin, sal_uLong &rMax, sal_uLong &rAbs ) const;
+
+    /// overriding to handle change of certain paragraph attributes
+    virtual bool SetAttr( const SfxPoolItem& ) override;
+    virtual bool SetAttr( const SfxItemSet& rSet ) override;
+    virtual bool ResetAttr( sal_uInt16 nWhich1, sal_uInt16 nWhich2 = 0 ) override;
+    virtual bool ResetAttr( const std::vector<sal_uInt16>& rWhichArr ) override;
+    virtual sal_uInt16 ResetAllAttr() override;
+
+    /// insert text content
+    /// @param rStr text to insert; in case it does not fit into the capacity
+    ///             of the node, the longest prefix that fits is inserted
+    /// @return the prefix of rStr that was actually inserted
+    OUString InsertText( const OUString & rStr, const SwContentIndex & rIdx,
+                     const SwInsertFlags nMode
+                         = SwInsertFlags::DEFAULT );
+    OUString InsertText( const OUString & rStr, const SwPosition & rIdx,
+                     const SwInsertFlags nMode
+                         = SwInsertFlags::DEFAULT );
+    /// Add a dummy character to the redline of the table changes
+    void InsertDummy() { m_Text = OUStringChar(CH_TXT_TRACKED_DUMMY_CHAR); }
+
+    /** delete text content
+        ATTENTION: must not be called with a range that overlaps the start of
+                   an attribute with both extent and dummy char
+     */
+    void EraseText ( const SwContentIndex &rIdx, const sal_Int32 nCount = SAL_MAX_INT32,
+                     const SwInsertFlags nMode = SwInsertFlags::DEFAULT );
+    void EraseText ( const SwPosition& rIdx, const sal_Int32 nCount = SAL_MAX_INT32,
+                     const SwInsertFlags nMode = SwInsertFlags::DEFAULT );
+
+    /** delete all attributes.
+        If neither pSet nor nWhich is given, delete all attributes (except
+        refmarks, toxmarks, meta) in range.
+        @param nContentStart start position
+        @param nLen     range in which attributes will be deleted
+        @param pSet     if not 0, delete only attributes contained in pSet
+        @param nWhich   if not 0, delete only attributes with matching which
+        @param bInclRefToxMark
+            refmarks, toxmarks, and metas will be ignored unless this is true
+        ATTENTION: setting bInclRefToxMark is only allowed from UNDO!
+        @param bExactRange From the attributes included in the range, delete
+        only the ones which have exactly same range. Don't delete the ones
+        which are simply included in the range.
+     */
+    void RstTextAttr(
+        const sal_Int32 nContentStart,
+        const sal_Int32 nLen,
+        const sal_uInt16 nWhich = 0,
+        const SfxItemSet* pSet = nullptr,
+        const bool bInclRefToxMark = false,
+        const bool bExactRange = false );
+    void    GCAttr();
+
+    // Delete text attribute (needs to be deregistered at Pool!)
+    void    DestroyAttr( SwTextAttr* pAttr );
+
+    // delete all attributes from SwpHintsArray.
+    void    ClearSwpHintsArr( bool bDelFields );
+
+    /// initialize the hints after file loading (which takes shortcuts)
+    void    FileLoadedInitHints();
+
+    /// Insert pAttr into hints array. @return true iff inserted successfully
+    bool    InsertHint( SwTextAttr * const pAttr,
+                  const SetAttrMode nMode = SetAttrMode::DEFAULT );
+    /// create new text attribute from rAttr and insert it
+    /// @return     inserted hint; 0 if not sure the hint is inserted
+    SwTextAttr* InsertItem( SfxPoolItem& rAttr,
+                  const sal_Int32 nStart, const sal_Int32 nEnd,
+                  const SetAttrMode nMode = SetAttrMode::DEFAULT );
+
+    /** Set these attributes at TextNode. If the whole range is comprised
+       set them only in AutoAttrSet (SwContentNode::SetAttr). */
+    bool SetAttr( const SfxItemSet& rSet,
+                  sal_Int32 nStt, sal_Int32 nEnd,
+                  const SetAttrMode nMode = SetAttrMode::DEFAULT,
+                  SwTextAttr **ppNewTextAttr = nullptr);
+    /** Query the attributes of textnode over the range.
+       Introduce 4th optional parameter <bMergeIndentValuesOfNumRule>.
+       If <bMergeIndentValuesOfNumRule> == true, the indent attributes of
+       the corresponding list level of an applied list style is merged into
+       the requested item set as a LR-SPACE item, if <bOnlyTextAttr> == false,
+       corresponding node has not its own indent attributes and the
+       position-and-space mode of the list level is SvxNumberFormat::LABEL_ALIGNMENT. */
+    bool GetParaAttr( SfxItemSet& rSet, sal_Int32 nStt, sal_Int32 nEnd,
+                  const bool bOnlyTextAttr  = false,
+                  const bool bGetFromChrFormat = true,
+                  const bool bMergeIndentValuesOfNumRule = false,
+                  SwRootFrame const* pLayout = nullptr) const;
+
+    /// Convey attributes of an AttrSet (AutoFormat) to SwpHintsArray.
+    void FormatToTextAttr( SwTextNode* pNd );
+
+    /// delete all attributes of type nWhich at nStart (opt. end nEnd)
+    void DeleteAttributes( const sal_uInt16 nWhich,
+                  const sal_Int32 nStart, const sal_Int32 nEnd = 0 );
+    /// delete the attribute pTextAttr
+    void DeleteAttribute ( SwTextAttr * const pTextAttr );
+
+    /** Actions on text and attributes.
+       introduce optional parameter to control, if all attributes have to be copied. */
+    void CopyText( SwTextNode * const pDest,
+               const SwContentIndex &rStart,
+               const sal_Int32 nLen,
+               const bool bForceCopyOfAllAttrs );
+    void CopyText( SwTextNode * const pDest,
+               const SwContentIndex &rDestStart,
+               const SwContentIndex &rStart,
+               sal_Int32 nLen,
+               const bool bForceCopyOfAllAttrs = false );
+    void CopyText( SwTextNode * const pDest,
+               const SwContentIndex &rDestStart,
+               const SwPosition &rStart,
+               sal_Int32 nLen,
+               const bool bForceCopyOfAllAttrs = false );
+
+    void        CutText(SwTextNode * const pDest,
+                    const SwContentIndex & rStart, const sal_Int32 nLen);
+    inline void CutText(SwTextNode * const pDest, const SwContentIndex &rDestStart,
+                    const SwContentIndex & rStart, const sal_Int32 nLen);
+
+    /// replace nDelLen characters at rStart with rText
+    /// in case the replacement does not fit, it is partially inserted up to
+    /// the capacity of the node
+    void ReplaceText( const SwContentIndex& rStart, const sal_Int32 nDelLen,
+            const OUString & rText );
+    void ReplaceText( SwPosition& rStart, const sal_Int32 nDelLen,
+            const OUString & rText );
+    void ReplaceTextOnly( sal_Int32 nPos, sal_Int32 nLen,
+            std::u16string_view aText,
+            const css::uno::Sequence<sal_Int32>& rOffsets );
+
+    /// Virtual methods from ContentNode.
+    virtual SwContentFrame *MakeFrame( SwFrame* ) override;
+    SwTextNode * SplitContentNode(const SwPosition &,
+            std::function<void (SwTextNode *, sw::mark::RestoreMode, bool AtStart)> const* pContentIndexRestore);
+    virtual SwContentNode *JoinNext() override;
+    void JoinPrev();
+
+    SwContentNode *AppendNode( const SwPosition & );
+
+    /// When appropriate set DontExpand-flag at INet or character styles respectively.
+    bool DontExpandFormat( sal_Int32 nContentIdx, bool bFlag = true,
+                        bool bFormatToTextAttributes = true );
+
+    /** get the innermost text attribute covering position nIndex.
+        @param nWhich   only attribute with this id is returned.
+        @param eMode    the predicate for matching (@see GetTextAttrMode).
+
+        ATTENTION: this function is not well-defined for those
+        hints of which several may cover a single position, like
+        RES_TXTATR_CHARFMT, RES_TXTATR_REFMARK, RES_TXTATR_TOXMARK
+     */
+    SwTextAttr *GetTextAttrAt(
+        sal_Int32 const nIndex,
+        sal_uInt16 const nWhich,
+        ::sw::GetTextAttrMode const eMode = ::sw::GetTextAttrMode::Default) const;
+
+    /** get the innermost text attributes covering position nIndex.
+        @param nWhich   only attributes with this id are returned.
+        @param eMode    the predicate for matching (@see GetTextAttrMode).
+     */
+    std::vector<SwTextAttr *> GetTextAttrsAt(
+        sal_Int32 const nIndex,
+        sal_uInt16 const nWhich ) const;
+
+    /** get the text attribute at position nIndex which owns
+        the dummy character CH_TXTATR_* at that position, if one exists.
+        @param nIndex   the position in the text
+        @param nWhich   if different from RES_TXTATR_END, return only
+                        attribute with given which id
+        @return the text attribute at nIndex of type nWhich, if it exists
+    */
+    SwTextAttr *GetTextAttrForCharAt(
+        const sal_Int32 nIndex,
+        const sal_uInt16 nWhich = RES_TXTATR_END ) const;
+
+    /**
+     * Get the text attribute of an end dummy character at nIndex. Return the attribute only in
+     * case its which id is nWhich.
+     *
+     * Note that the position of the end dummy character is one less than the end of the attribute.
+     */
+    SwTextAttr* GetTextAttrForEndCharAt(sal_Int32 nIndex, sal_uInt16 nWhich) const;
+
+    SwTextField* GetFieldTextAttrAt(
+        const sal_Int32 nIndex,
+        ::sw::GetTextAttrMode const eMode = ::sw::GetTextAttrMode::Expand) const;
+
+    bool Spell(SwSpellArgs*);
+    bool Convert( SwConversionArgs & );
+
+    inline SwTextFormatColl *GetTextColl() const;
+    virtual SwFormatColl *ChgFormatColl( SwFormatColl* ) override;
+    void ChgTextCollUpdateNum( const SwTextFormatColl* pOld,
+                                const SwTextFormatColl* pNew );
+
+    /** Copy collection with all auto formats to dest-node.
+        The latter might be in another document!
+       (Method in ndcopy.cxx!!). */
+    void CopyCollFormat(SwTextNode& rDestNd, bool bUndoForChgFormatColl = true);
+
+    // BEGIN OF BULLET/NUMBERING/OUTLINE STUFF:
+
+    /**
+       Returns numbering rule of this text node.
+
+       @param bInParent     search in parent attributes, too
+
+       @return numbering rule of this text node or NULL if none is set
+     */
+    SwNumRule *GetNumRule(bool bInParent = true) const;
+
+    const SwNodeNum* GetNum(SwRootFrame const* pLayout = nullptr,
+             SwListRedlineType eRedline = SwListRedlineType::SHOW) const;
+    void DoNum(std::function<void (SwNodeNum &)> const&);
+
+    SwNumberTree::tNumberVector GetNumberVector(SwRootFrame const* pLayout = nullptr,
+            SwListRedlineType eRedline = SwListRedlineType::SHOW) const;
+
+    /**
+       Returns if this text node is an outline.
+
+       @retval true      this text node is an outline
+       @retval false     else
+     */
+    bool IsOutline() const;
+
+    bool IsOutlineStateChanged() const;
+
+    void UpdateOutlineState();
+
+    /**
+       Notify this textnode that its numbering rule has changed.
+     */
+    void NumRuleChgd();
+
+    /** Returns outline of numbering string
+
+        Introduce parameter <_bInclPrefixAndSuffixStrings> in order to control,
+        if the prefix and the suffix strings have to been included or not.
+
+        @param _bInclPrefixAndSuffixStrings
+        optional input parameter - boolean indicating, if the prefix and the
+        suffix strings have to been included or not. default value = <true>
+
+        @param _nRestrictToThisLevel
+        optional input parameter - unsigned integer indicating the maximum outline
+        level to which the output string must be restricted to. Default value is
+        MAXLEVEL
+    */
+    OUString GetNumString( const bool _bInclPrefixAndSuffixStrings = true,
+            const unsigned int _nRestrictToThisLevel = MAXLEVEL,
+            SwRootFrame const* pLayout = nullptr,
+            SwListRedlineType eRedline = SwListRedlineType::SHOW) const;
+
+    /**
+       Returns the additional indents of this text node and its numbering.
+
+       @param bTextLeft return text-left-margin instead of left-margin
+                        (include negative first-line-indent, see lrspitem.hxx)
+
+       @return additional num indents - a delta to be added to node's items
+     */
+     tools::Long GetLeftMarginWithNum( bool bTextLeft = false ) const;
+
+    /**
+       Returns the combined first line indent of this text node and
+       its numbering.
+
+       @param the first line indent of this text node taking the
+               numbering into account (return parameter)
+
+       @retval true   this node has SwNodeNum and has numbering rule
+       @retval false  else
+     */
+    bool GetFirstLineOfsWithNum( short& rFirstOffset ) const;
+
+    SwTwips GetAdditionalIndentForStartingNewList() const;
+
+    /** return left margin for tab stop position calculation
+
+        Needed for text formatting
+        Method considers new list level attributes, which also can provide a left margin value
+    */
+    tools::Long GetLeftMarginForTabCalculation() const;
+
+    /** Returns if this text node has a number.
+
+        This text node has a number if it has a SwNodeNum and a
+        numbering rule and the numbering format specified for the
+        level of the SwNodeNum is of an enumeration type.
+
+        @retval true    This text node has a number.
+        @retval false   else
+     */
+    bool HasNumber(SwRootFrame const* pLayout = nullptr) const;
+
+    /** Returns if this text node has a bullet.
+
+        This text node has a bullet if it has a SwNodeNum and a
+        numbering rule and the numbering format specified for the
+        level of the SwNodeNum is of a bullet type.
+
+        @retval true    This text node has a bullet.
+        @retval false   else
+     */
+    bool HasBullet() const;
+
+    /** Returns is this text node is numbered.
+
+        This node is numbered if it has a SwNodeNum and it has a
+        numbering rule and has not a hidden SwNodeNum.
+
+        ATTENTION: Returns true even if the SwNumFormat has type
+        SVX_NUM_NUMBER_NONE.
+
+        @retval true      This node is numbered.
+        @retval false     else
+     */
+    bool IsNumbered(SwRootFrame const* pLayout = nullptr) const;
+
+    /** Returns if this text node has a marked label.
+
+        @retval true       This text node has a marked label.
+        @retval false      else
+     */
+    bool HasMarkedLabel() const;
+
+    /** Sets the list level of this text node.
+
+        Side effect, when the text node is a list item:
+        The text node's representation in the list tree (<SwNodeNum> instance)
+        is updated.
+
+        @param nLevel level to set
+    */
+    void SetAttrListLevel(int nLevel);
+
+    bool HasAttrListLevel() const;
+
+    int GetAttrListLevel() const;
+
+    /** Returns the actual list level of this text node, when it is a list item
+
+        @return the actual list level of this text node, if it is a list item,
+               -1 otherwise
+    */
+    int GetActualListLevel(SwListRedlineType eRedline = SwListRedlineType::SHOW) const;
+
+    /**
+       Returns outline level of this text node.
+
+       If a text node has an outline number (i.e. it has an SwNodeNum
+       and an outline numbering rule) the outline level is the level of
+       this SwNodeNum.
+
+       If a text node has no outline number and has a paragraph style
+       attached the outline level is the outline level of the
+       paragraph style.
+
+       Otherwise the text node has no outline level (NO_NUMBERING).
+
+       NOTE: The outline level of text nodes is subject to change. The
+       plan is to have an SwTextNode::nOutlineLevel member that is
+       updated from a paragraph style upon appliance of that paragraph
+       style.
+
+       @return outline level or NO_NUMBERING if there is no outline level
+     */
+    int GetAttrOutlineLevel() const;
+
+    /**
+       Sets the out line level *at* a text node.
+
+       @param nLevel     the level to be set
+
+       If the text node has an outline number the level is set at the
+       outline number.
+
+       If the text node has no outline number but has a paragraph
+       style applied the outline level is set at the paragraph style.
+
+       NOTE: This is subject to change, see GetOutlineLevel.
+     */
+    void SetAttrOutlineLevel(int nLevel);
+
+    /**
+     * @brief GetAttrOutlineContentVisible
+     * @param bOutlineContentVisibleAttr    the value stored in RES_PARATR_GRABBAG for 'OutlineContentVisibleAttr'
+     * @return true if 'OutlineContentVisibleAttr' is found in RES_PARATR_GRABBAG
+     */
+    void GetAttrOutlineContentVisible(bool& bOutlineContentVisibleAttr);
+    void SetAttrOutlineContentVisible(bool bVisible);
+
+    bool IsEmptyListStyleDueToSetOutlineLevelAttr() const { return mbEmptyListStyleSetDueToSetOutlineLevelAttr;}
+    void SetEmptyListStyleDueToSetOutlineLevelAttr();
+    void ResetEmptyListStyleDueToResetOutlineLevelAttr();
+
+    /**
+       Returns the width of leading tabs/blanks in this paragraph.
+       This space will be converted into numbering indent if the paragraph
+       is set to be numbered.
+
+       @return     the width of the leading whitespace
+     */
+    SwTwips GetWidthOfLeadingTabs() const;
+
+    /**
+       Returns if the paragraph has a visible numbering or bullet.
+       This includes all kinds of numbering/bullet/outlines.
+       Note: This function returns false, if the numbering format is
+       SVX_NUM_NUMBER_NONE or if the numbering/bullet has been deleted.
+
+       @return     true if the paragraph has a visible numbering/bullet/outline
+     */
+    bool HasVisibleNumberingOrBullet() const;
+
+    void SetListId(OUString const& rListId);
+    OUString GetListId() const;
+
+    /** Determines, if the list level indent attributes can be applied to the
+        paragraph.
+
+        The list level indents can be applied to the paragraph under the one
+        of following conditions:
+        - the list style is directly applied to the paragraph and the paragraph
+          has no own indent attributes.
+        - the list style is applied to the paragraph through one of its paragraph
+          styles, the paragraph has no own indent attributes and on the paragraph
+          style hierarchy from the paragraph to the paragraph style with the
+          list style no indent attributes are found.
+
+        @return bitmask
+    */
+    ::sw::ListLevelIndents AreListLevelIndentsApplicable() const;
+    bool AreListLevelIndentsApplicableImpl(sal_uInt16 nWhich) const;
+
+    /** Retrieves the list tab stop position, if the paragraph's list level defines
+        one and this list tab stop has to merged into the tap stops of the paragraph
+
+        @param nListTabStopPosition
+        output parameter - containing the list tab stop position
+
+        @return boolean - indicating, if a list tab stop position is provided
+    */
+    bool GetListTabStopPosition( tools::Long& nListTabStopPosition ) const;
+
+    /** Retrieves the character following the list label, if the paragraph's
+        list level defines one.
+
+        @return the list tab stop position as string
+    */
+    OUString GetLabelFollowedBy() const;
+
+    // END OF BULLET/NUMBERING/OUTLINE STUFF:
+
+    void fillSoftPageBreakList( SwSoftPageBreakList& rBreak ) const;
+
+    LanguageType GetLang( const sal_Int32 nBegin, const sal_Int32 nLen = 0,
+                    sal_uInt16 nScript = 0 ) const;
+
+    /// in ndcopy.cxx
+    bool IsSymbolAt(sal_Int32 nBegin) const; // In itratr.cxx.
+    virtual SwContentNode* MakeCopy(SwDoc&, SwNode& rWhere, bool bNewFrames) const override;
+
+    /// Interactive hyphenation: we find TextFrame and call its CalcHyph.
+    bool Hyphenate( SwInterHyphInfo &rHyphInf );
+    void DelSoftHyph( const sal_Int32 nStart, const sal_Int32 nEnd );
+
+    /** add 4th optional parameter <bAddSpaceAfterListLabelStr> indicating,
+       when <bWithNum = true> that a space is inserted after the string for
+       the list label.
+       add 5th optional parameter <bWithSpacesForLevel> indicating, if additional
+       spaces are inserted in front of the expanded text string depending on
+       the list level. */
+    OUString GetExpandText( SwRootFrame const* pLayout,
+                            const sal_Int32 nIdx = 0,
+                            const sal_Int32 nLen = -1,
+                            const bool bWithNum = false,
+                            const bool bAddSpaceAfterListLabelStr = false,
+                            const bool bWithSpacesForLevel = false,
+                            const ExpandMode eAdditionalMode = ExpandMode::ExpandFootnote | ExpandMode::HideFieldmarkCommands) const;
+    bool CopyExpandText( SwTextNode& rDestNd, const SwContentIndex* pDestIdx,
+                           sal_Int32 nIdx, sal_Int32 nLen,
+                           SwRootFrame const* pLayout,
+                           bool bWithNum = false, bool bWithFootnote = true,
+                           bool bReplaceTabsWithSpaces = false ) const;
+
+    OUString GetRedlineText() const;
+
+    /** @return actual count of initial chars for initial-function.
+       If nWishLen == 0 that of first word. */
+    sal_Int32 GetDropLen(sal_Int32 nWishLen) const;
+
+    /// Passes back info needed on the dropcap dimensions
+    bool GetDropSize(int& rFontHeight, int& rDropHeight, int& rDropDescent) const;
+
+    /// Hidden Paragraph Field:
+    bool CalcHiddenParaField()
+        { return m_pSwpHints && m_pSwpHints->CalcHiddenParaField(); }
+    /// set CalcVisible flags
+    void SetCalcHiddenParaField()
+        { if (m_pSwpHints) m_pSwpHints->SetCalcHiddenParaField(); }
+
+    /// is the paragraph visible?
+    bool IsHiddenByParaField() const
+        { return m_pSwpHints && m_pSwpHints->IsHiddenByParaField(); }
+
+    /// Hidden Paragraph Field:
+
+    bool HasHiddenCharAttribute( bool bWholePara ) const
+    {
+        if ( m_bRecalcHiddenCharFlags )
+            CalcHiddenCharFlags();
+        return bWholePara ? m_bHiddenCharsHidePara : m_bContainsHiddenChars;
+    }
+
+    void SetCalcHiddenCharFlags() const
+        { m_bRecalcHiddenCharFlags = true; }
+
+    /** @return if the node is hidden due to
+       1. HiddenParaField
+       2. HiddenCharAttribute
+       3. HiddenSection */
+
+    bool IsHidden() const;
+
+
+    /// override SwContentIndexReg
+    virtual void Update(
+        SwContentIndex const & rPos,
+        const sal_Int32 nChangeLen,
+        UpdateMode eMode) override;
+
+    /// change text to Upper/Lower/Hiragana/Katakana/...
+    void TransliterateText( utl::TransliterationWrapper& rTrans,
+                            sal_Int32 nStart, sal_Int32 nEnd,
+                            SwUndoTransliterate* pUndo, bool bUseRedlining = false );
+
+    /// count words in given range - returns true if we refreshed out count
+    bool CountWords( SwDocStat& rStat, sal_Int32 nStart, sal_Int32 nEnd ) const;
+
+    /** Checks some global conditions like loading or destruction of document
+       to economize notifications */
+    bool IsNotificationEnabled() const;
+
+    /// Checks a temporary notification blocker and the global conditions of IsNotificationEnabled()
+    bool IsNotifiable() const;
+
+    void SetListRestart( bool bRestart );
+    bool IsListRestart() const;
+
+    void SetAttrListRestartValue( SwNumberTree::tSwNumTreeNumber nNum );
+    bool HasAttrListRestartValue() const;
+    SwNumberTree::tSwNumTreeNumber GetAttrListRestartValue() const;
+    SwNumberTree::tSwNumTreeNumber GetActualListStartValue() const;
+
+    void SetCountedInList( bool bCounted );
+    bool IsCountedInList() const;
+
+    void AddToList();
+    void AddToListRLHidden();
+    void AddToListOrig();
+    void RemoveFromList();
+    void RemoveFromListRLHidden();
+    void RemoveFromListOrig();
+    bool IsInList() const;
+
+    bool IsFirstOfNumRule(SwRootFrame const& rLayout) const;
+
+    SAL_DLLPRIVATE unotools::WeakReference<SwXParagraph> const& GetXParagraph() const
+            { return m_wXParagraph; }
+    SAL_DLLPRIVATE void SetXParagraph(rtl::Reference<SwXParagraph> const& xParagraph);
+
+    /// sfx2::Metadatable
+    virtual ::sfx2::IXmlIdRegistry& GetRegistry() override;
+    virtual bool IsInClipboard() const override;
+    /// Is this node in the undo array?
+    virtual bool IsInUndo() const override;
+    virtual bool IsInContent() const override;
+    virtual css::uno::Reference< css::rdf::XMetadatable > MakeUnoObject() override;
+
+    bool IsCollapse() const;
+
+    virtual void dumpAsXml(xmlTextWriterPtr pWriter) const override;
+
+    sal_uInt32 GetRsid( sal_Int32 nStt, sal_Int32 nEnd ) const;
+    sal_uInt32 GetParRsid() const;
+
+    bool CompareRsid( const SwTextNode &rTextNode, sal_Int32 nStt1, sal_Int32 nStt2 ) const;
+    bool CompareParRsid( const SwTextNode &rTextNode ) const;
+
+    // Access to DrawingLayer FillAttributes in a preprocessed form for primitive usage
+    virtual drawinglayer::attribute::SdrAllFillAttributesHelperPtr getSdrAllFillAttributesHelper() const override;
+
+    /// In MS Word, the font underline setting of the paragraph end position won't affect the formatting of numbering, so we ignore it
+    static bool IsIgnoredCharFormatForNumbering(const sal_uInt16 nWhich, bool bIsCharStyle = false);
+    void FormatDropNotify(const SwFormatDrop& rDrop) override
+            { TriggerNodeUpdate(sw::LegacyModifyHint(&rDrop, &rDrop)); };
+
+    void SetInSwUndo(bool bInUndo);
+};
+
+inline SwpHints & SwTextNode::GetSwpHints()
+{
+    assert( m_pSwpHints );
+    return *m_pSwpHints;
+}
+inline const SwpHints &SwTextNode::GetSwpHints() const
+{
+    assert( m_pSwpHints );
+    return *m_pSwpHints;
+}
+
+inline SwpHints& SwTextNode::GetOrCreateSwpHints()
+{
+    if ( !m_pSwpHints )
+    {
+        m_pSwpHints.reset(new SwpHints(*this));
+    }
+    return *m_pSwpHints;
+}
+
+inline void SwTextNode::TryDeleteSwpHints()
+{
+    if ( m_pSwpHints && m_pSwpHints->CanBeDeleted() )
+    {
+        m_pSwpHints.reset();
+    }
+}
+
+inline SwTextFormatColl* SwTextNode::GetTextColl() const
+{
+    return const_cast<SwTextFormatColl*>(static_cast<const SwTextFormatColl*>(GetRegisteredIn()));
+}
+
+/// Inline methods from Node.hxx
+inline SwTextNode *SwNode::GetTextNode()
+{
+     return SwNodeType::Text == m_nNodeType ? static_cast<SwTextNode*>(this) : nullptr;
+}
+
+inline const SwTextNode *SwNode::GetTextNode() const
+{
+     return SwNodeType::Text == m_nNodeType ? static_cast<const SwTextNode*>(this) : nullptr;
+}
+
+inline void
+SwTextNode::CutText(SwTextNode * const pDest, const SwContentIndex & rDestStart,
+                    const SwContentIndex & rStart, const sal_Int32 nLen)
+{
+    CutImpl( pDest, rDestStart, rStart, nLen );
+}
+
+inline sal_Int32 SwTextNode::GetSpaceLeft() const
+{
+    // do not fill the String up to the max - need to be able to have a
+    // SwPosition "behind" the last character, i.e., at index TXTNODE_MAX + 1
+    const sal_Int32 TXTNODE_MAX = SAL_MAX_INT32 - 2;
+    return TXTNODE_MAX-m_Text.getLength();
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */