/* -*- 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

// SwDoc interfaces

#include <o3tl/typed_flags_set.hxx>

#include <o3tl/sorted_vector.hxx>

#include <string_view>

#include <vcl/idle.hxx>

#include "swdllapi.h"

#include "swtypes.hxx"

#include "tblafmt.hxx"

#include "toxe.hxx"

#include "flyenum.hxx"

#include "flypos.hxx"

#include "swdbdata.hxx"

#include <sfx2/objsh.hxx>

#include <svl/style.hxx>

#include <editeng/numitem.hxx>

#include "tox.hxx"

#include "frmfmt.hxx"

#include "charfmt.hxx"

#include "docary.hxx"

#include "pagedesc.hxx"

#include "tblenum.hxx"

#include "ndarr.hxx"

#include "ndtyp.hxx"

#include <memory>

#include <mutex>

#include <set>

#include <tuple>

#include <unordered_map>

#include <utility>

#include <vector>

namespace editeng { class SvxBorderLine; }

class SwExtTextInput;

class EditFieldInfo;

class Outliner;

class OutputDevice;

class Point;

class SbxArray;

class SdrObject;

class SdrUndoAction;

class SvNumberFormatter;

class SvxMacro;

class SwAutoCompleteWord;

class SwAutoCorrExceptWord;

class SwCellFrame;

class SwCharFormats;

class SwCellStyleTable;

class SwCursorShell;

class SwCursor;

class SwDocShell;

class SwDrawView;

class SwEditShell;

class SwFormat;

class SwFormatINetFormat;

class SwFormatRefMark;

class SwFootnoteIdxs;

class SwFootnoteInfo;

class SwEndNoteInfo;

class SwLineNumberInfo;

class SwDBManager;

class SwNodeIndex;

class SwNodeRange;

class SwNumRule;

class SwPagePreviewPrtData;

class SwRootFrame;

class SwRubyListEntry;

class SwSectionFormat;

class SwSectionData;

class SwSelBoxes;

class SwTableAutoFormatTable;

class SwTOXBaseSection;

class SwTabCols;

class SwTable;

class SwTableAutoFormat;

class SwTableBox;

class SwTableBoxFormat;

class SwTableFormat;

class SwTableLineFormat;

class SwTableNode;

class SwTextBlocks;

class SwURLStateChanged;

class SwUnoCursor;

class SwViewShell;

class SwDrawContact;

class SdrView;

class SdrMarkList;

class SwAuthEntry;

class SwLayoutCache;

class IStyleAccess;

struct SwCallMouseEvent;

struct SwDocStat;

struct SwSortOptions;

struct SwDefTOXBase_Impl;

class SwPrintUIOptions;

struct SwConversionArgs;

class SwRenderData;

class IDocumentUndoRedo;

class IDocumentSettingAccess;

class IDocumentDeviceAccess;

class IDocumentDrawModelAccess;

class IDocumentChartDataProviderAccess;

class IDocumentTimerAccess;

class IDocumentLinksAdministration;

class IDocumentListItems;

class IDocumentListsAccess;

class IDocumentOutlineNodes;

class IDocumentContentOperations;

class IDocumentRedlineAccess;

class IDocumentStatistics;

class IDocumentState;

class IDocumentLayoutAccess;

class IDocumentStylePoolAccess;

class IDocumentExternalData;

class IDocumentMarkAccess;

class SetGetExpFields;

struct SwInsertTableOptions;

class SwContentControlManager;

enum class SvMacroItemId : sal_uInt16;

enum class SvxFrameDirection;

enum class RndStdIds;

class SwMarkName;

namespace sw::mark { class MarkManager; }

namespace sw {

    enum class RedlineMode;

    enum class FieldmarkMode;

    enum class ParagraphBreakMode;

    template<class T> class FrameFormats;

    typedef FrameFormats<::SwTableFormat*> TableFrameFormats;

    class MetaFieldManager;

    class UndoManager;

    class IShellCursorSupplier;

    class DocumentSettingManager;

    class DocumentDeviceManager;

    class DocumentDrawModelManager;

    class DocumentChartDataProviderManager;

    class DocumentTimerManager;

    class DocumentLinksAdministrationManager;

    class DocumentListItemsManager;

    class DocumentListsManager;

    class DocumentOutlineNodesManager;

    class DocumentContentOperationsManager;

    class DocumentRedlineManager;

    class DocumentFieldsManager;

    class DocumentStatisticsManager;

    class DocumentStateManager;

    class DocumentLayoutManager;

    class DocumentStylePoolManager;

    class DocumentExternalDataManager;

    class GrammarContact;

    class OnlineAccessibilityCheck;

}

namespace com::sun::star {

    namespace container {

        class XNameContainer; //< for getXForms()/isXForms()/initXForms() methods

    }

    namespace embed { class XStorage; }

    namespace linguistic2 { class XHyphenatedWord; }

    namespace linguistic2 { class XProofreadingIterator; }

    namespace linguistic2 { class XSpellChecker1; }

    namespace script::vba { class XVBAEventProcessor; }

}

namespace ooo::vba::word {

    class XFind;

}

namespace sfx2 {

    class IXmlIdRegistry;

}

namespace {

    enum SwSplitDocType

    {

        SPLITDOC_TO_GLOBALDOC,

        SPLITDOC_TO_HTML

    };

}

void SetAllScriptItem( SfxItemSet& rSet, const SfxPoolItem& rItem );

using SwRubyList = std::vector<std::unique_ptr<SwRubyListEntry>>;

// Represents the model of a Writer document.

class SwDoc final

{

    friend class ::sw::DocumentContentOperationsManager;

    friend void InitCore();

    friend void FinitCore();

    // private Member

    std::unique_ptr<SwNodes> m_pNodes;    //< document content (Nodes Array)

    rtl::Reference<SwAttrPool> mpAttrPool;  //< the attribute pool

    SwPageDescs              m_PageDescs; //< PageDescriptors

    Link<bool,void>          maOle2Link;  //< OLE 2.0-notification

    /* @@@MAINTAINABILITY-HORROR@@@

       Timer should not be members of the model

    */

    Idle       maOLEModifiedIdle;        //< Timer for update modified OLE-Objects

    SwDBData    maDBData;                //< database descriptor

    OUString    msTOIAutoMarkURL;        //< URL of table of index AutoMark file

    std::vector<OUString> m_PatternNames; //< Array for names of document-templates

    css::uno::Reference<css::container::XNameContainer>

        mxXForms;                        //< container with XForms models

    mutable css::uno::Reference< css::linguistic2::XProofreadingIterator > m_xGCIterator;

    const std::unique_ptr< ::sw::mark::MarkManager> mpMarkManager;

    const std::unique_ptr< ::sw::MetaFieldManager > m_pMetaFieldManager;

    const std::unique_ptr< ::SwContentControlManager > m_pContentControlManager;

    const std::unique_ptr< ::sw::DocumentDrawModelManager > m_pDocumentDrawModelManager;

    const std::unique_ptr< ::sw::DocumentRedlineManager > m_pDocumentRedlineManager;

    const std::unique_ptr< ::sw::DocumentStateManager > m_pDocumentStateManager;

    const std::unique_ptr< ::sw::UndoManager > m_pUndoManager;

    const std::unique_ptr< ::sw::DocumentSettingManager > m_pDocumentSettingManager;

    const std::unique_ptr< ::sw::DocumentChartDataProviderManager > m_pDocumentChartDataProviderManager;

    std::unique_ptr< ::sw::DocumentDeviceManager > m_pDeviceAccess;

    const std::unique_ptr< ::sw::DocumentTimerManager > m_pDocumentTimerManager;

    const std::unique_ptr< ::sw::DocumentLinksAdministrationManager > m_pDocumentLinksAdministrationManager;

    const std::unique_ptr< ::sw::DocumentListItemsManager > m_pDocumentListItemsManager;

    const std::unique_ptr< ::sw::DocumentListsManager > m_pDocumentListsManager;

    const std::unique_ptr< ::sw::DocumentOutlineNodesManager > m_pDocumentOutlineNodesManager;

    const std::unique_ptr< ::sw::DocumentContentOperationsManager > m_pDocumentContentOperationsManager;

    const std::unique_ptr< ::sw::DocumentFieldsManager > m_pDocumentFieldsManager;

    const std::unique_ptr< ::sw::DocumentStatisticsManager > m_pDocumentStatisticsManager;

    const std::unique_ptr< ::sw::DocumentLayoutManager > m_pDocumentLayoutManager;

    const std::unique_ptr< ::sw::DocumentStylePoolManager > m_pDocumentStylePoolManager;

    const std::unique_ptr< ::sw::DocumentExternalDataManager > m_pDocumentExternalDataManager;

    // Pointer

    std::unique_ptr<SwFrameFormat>     mpDfltFrameFormat;     //< Default formats.

    std::unique_ptr<SwFrameFormat>     mpEmptyPageFormat;     //< Format for the default empty page

    std::unique_ptr<SwFrameFormat>     mpColumnContFormat;    //< Format for column container

    std::unique_ptr<SwCharFormat>      mpDfltCharFormat;

    std::unique_ptr<SwTextFormatColl>  mpDfltTextFormatColl;  //< Defaultformatcollections

    std::unique_ptr<SwGrfFormatColl>   mpDfltGrfFormatColl;

    std::unique_ptr<sw::FrameFormats<SwFrameFormat*>>    mpFrameFormatTable;    //< Format table

    std::unique_ptr<SwCharFormats>     mpCharFormatTable;

    std::unique_ptr<SwCharFormats>     mpCharFormatDeletionTable;

    std::unique_ptr<sw::FrameFormats<sw::SpzFrameFormat*>>    mpSpzFrameFormatTable;

    std::unique_ptr<SwSectionFormats>  mpSectionFormatTable;

    std::unique_ptr<sw::TableFrameFormats>    mpTableFrameFormatTable; //< For tables

    std::unique_ptr<SwTextFormatColls> mpTextFormatCollTable;   //< FormatCollections

    std::unique_ptr<SwGrfFormatColls>  mpGrfFormatCollTable;

    std::unique_ptr<SwTOXTypes>        mpTOXTypes;              //< Tables/indices

    std::unique_ptr<SwDefTOXBase_Impl> mpDefTOXBases;           //< defaults of SwTOXBase's

    std::unique_ptr<SwDBManager> m_pOwnDBManager; //< own DBManager

    SwDBManager * m_pDBManager; //< DBManager for evaluation of DB-fields.

    SwNumRule       *mpOutlineRule;

    std::unique_ptr<SwFootnoteInfo>   mpFootnoteInfo;

    std::unique_ptr<SwEndNoteInfo>    mpEndNoteInfo;

    std::unique_ptr<SwLineNumberInfo> mpLineNumberInfo;

    std::unique_ptr<SwFootnoteIdxs>   mpFootnoteIdxs;

    SwDocShell      *mpDocShell;                   //< Ptr to SfxDocShell of Doc.

    SfxObjectShellLock mxTmpDocShell;              //< A temporary shell that is used to copy OLE-Nodes

    std::unique_ptr<SwAutoCorrExceptWord> mpACEWord;               /**< For the automated takeover of

                                                   auto-corrected words that are "re-corrected". */

    std::unique_ptr<SwURLStateChanged> mpURLStateChgd;             //< SfxClient for changes in INetHistory

    std::mutex mNumberFormatterMutex;

    SvNumberFormatter* mpNumberFormatter;             //< NumFormatter for tables / fields

    mutable std::unique_ptr<SwNumRuleTable> mpNumRuleTable;     //< List of all named NumRules.

    // Hash map to find numrules by name

    mutable std::unordered_map<UIName, SwNumRule *> maNumRuleMap;

    std::unique_ptr<SwPagePreviewPrtData> m_pPgPViewPrtData; //< Indenting / spacing for printing of page view.

    SwExtTextInput  *mpExtInputRing;

    std::unique_ptr<IStyleAccess>  mpStyleAccess;                //< handling of automatic styles

    std::unique_ptr<SwLayoutCache> mpLayoutCache;                /**< Layout cache to read and save with the

                                                                    document for a faster formatting */

    std::unique_ptr<sw::GrammarContact> mpGrammarContact; //< for grammar checking in paragraphs during editing

    std::unique_ptr<sw::OnlineAccessibilityCheck> mpOnlineAccessibilityCheck;

    css::uno::Reference< css::script::vba::XVBAEventProcessor > mxVbaEvents;

    css::uno::Reference< ooo::vba::word::XFind > mxVbaFind;

    css::uno::Reference<css::container::XNameContainer> m_xTemplateToProjectCache;

    /// Table styles (autoformats that are applied with table changes).

    std::unique_ptr<SwTableAutoFormatTable> m_pTableStyles;

    /// Cell Styles not assigned to a Table Style

    std::unique_ptr<SwCellStyleTable> mpCellStyles;

private:

    std::unique_ptr< ::sfx2::IXmlIdRegistry > m_pXmlIdRegistry;

    // other

    sal_uInt32  mnRsid;              //< current session ID of the document

    sal_uInt32  mnRsidRoot;          //< session ID when the document was created

    oslInterlockedCount  mReferenceCount;

    bool mbDtor                  : 1;    /**< TRUE: is in SwDoc DTOR.

                                               and unfortunately temporarily also in

                                               SwSwgReader::InLayout() when flawed

                                               frames need deletion. */

    bool mbCopyIsMove            : 1;    //< TRUE: Copy is a hidden Move.

    bool mbInReading             : 1;    //< TRUE: Document is in the process of being read.

    bool mbInWriting : 1; //< TRUE: Document is in the process of being written.

    bool mbInMailMerge           : 1;    //< TRUE: Document is in the process of being written by mail merge.

    bool mbInXMLImport           : 1;    //< TRUE: During xml import, attribute portion building is not necessary.

    bool mbInXMLImport242        : 1 = false; //< TRUE: During xml import, apply workaround for style-ref field

    bool mbInWriterfilterImport  : 1;    //< TRUE: writerfilter import (DOCX,RTF)

    bool mbUpdateTOX             : 1;    //< TRUE: After loading document, update TOX.

    bool mbInLoadAsynchron       : 1;    //< TRUE: Document is in the process of being loaded asynchronously.

    bool mbHasFillBitmapLinks    : 1;    //< TRUE: the fill-bitmap link tracker has registered links.

    bool mbIsAutoFormatRedline   : 1;    //< TRUE: Redlines are recorded by Autoformat.

    bool mbOLEPrtNotifyPending   : 1;    /**< TRUE: Printer has changed. At creation of View

                                                notification of OLE-Objects PrtOLENotify() is required. */

    bool mbAllOLENotify          : 1;    //< True: Notification of all objects is required.

    bool mbInsOnlyTextGlssry     : 1;    //< True: insert 'only text' glossary into doc

    bool mbContains_MSVBasic     : 1;    //< True: MS-VBasic exist is in our storage

    bool mbClipBoard             : 1;    //< TRUE: this document represents the clipboard

    bool mbColumnSelection       : 1;    //< TRUE: this content has been created by a column selection (clipboard docs only)

    bool mbIsPrepareSelAll       : 1;

    bool mbDontCorrectBookmarks = false;

    enum MissingDictionary { False = -1, Undefined = 0, True = 1 };

    MissingDictionary meDictionaryMissing;

    // true: Document contains at least one anchored object, which is anchored AT_PAGE with a content position.

    //       Thus, certain adjustment needed during formatting for these kind of anchored objects.

    bool mbContainsAtPageObjWithContentAnchor : 1;

    static SwAutoCompleteWord *s_pAutoCompleteWords;  //< List of all words for AutoComplete

    /// The last, still alive SwDoc instance, for debugging.

    static SwDoc* s_pLast;

    // private methods

    SwFlyFrameFormat* MakeFlySection_( const SwPosition& rAnchPos,

                                const SwContentNode& rNode, RndStdIds eRequestId,

                                const SfxItemSet* pFlyAttrSet,

                                SwFrameFormat* );

    sal_Int8 SetFlyFrameAnchor( SwFrameFormat& rFlyFormat, SfxItemSet& rSet, bool bNewFrames );

    typedef SwFormat* (SwDoc::*FNCopyFormat)( const UIName&, SwFormat*, bool );

    SwFormat* CopyFormat( const SwFormat& rFormat, const SwFormatsBase& rFormatArr,

                        FNCopyFormat fnCopyFormat, const SwFormat& rDfltFormat );

    void CopyFormatArr( const SwFormatsBase& rSourceArr, SwFormatsBase const & rDestArr,

                        FNCopyFormat fnCopyFormat, SwFormat& rDfltFormat );

    SW_DLLPUBLIC void CopyPageDescHeaderFooterImpl( bool bCpyHeader,

                                const SwFrameFormat& rSrcFormat, SwFrameFormat& rDestFormat );

    SwDoc( const SwDoc &) = delete;

    // Database fields:

    void AddUsedDBToList( std::vector<OUString>& rDBNameList,

                          const std::vector<OUString>& rUsedDBNames );

    void AddUsedDBToList( std::vector<OUString>& rDBNameList, const OUString& rDBName );

    static bool IsNameInArray( const std::vector<OUString>& rOldNames, const OUString& rName );

    void GetAllDBNames( std::vector<OUString>& rAllDBNames );

    static OUString ReplaceUsedDBs( const std::vector<OUString>& rUsedDBNames,

                             const OUString& rNewName, const OUString& rFormula );

    static std::vector<OUString>& FindUsedDBs( const std::vector<OUString>& rAllDBNames,

                                const OUString& rFormula,

                                std::vector<OUString>& rUsedDBNames );

    SW_DLLPUBLIC void EnsureNumberFormatter(); // must be called with mNumberFormatterMutex locked

    bool UnProtectTableCells( SwTable& rTable );

    /**

       Create sub-documents according to the given collection.

       If no collection is given, take chapter style of the 1st level.

       @param eDocType Enumeration value representing doctype to be generated

       @param rPath String representing parent directories of file to be generated

       @param rConcatFunc Function representing how token is concatenated to the filename

    */

    bool SplitDoc(sal_uInt16 eDocType, const OUString& rPath, bool bOutline,

                  const SwTextFormatColl* pSplitColl, int nOutlineLevel = 0,

                  const std::function<OUString(OUString, OUString)>& rConcatFunc =

                  [](OUString aName, OUString token) -> OUString { return aName + token; });

    // Update charts of given table.

    void UpdateCharts_( const SwTable& rTable, SwViewShell const & rVSh ) const;

    static bool SelectNextRubyChars( SwPaM& rPam, SwRubyListEntry& rRubyEntry );

    // CharTimer calls this method.

    void DoUpdateAllCharts();

    DECL_LINK( DoUpdateModifiedOLE, Timer *, void );

public:

    SW_DLLPUBLIC SwFormat *MakeCharFormat_(const UIName &, SwFormat *, bool );

    SwFormat *MakeFrameFormat_(const UIName &, SwFormat *, bool );

private:

    SwFormat *MakeTextFormatColl_(const UIName &, SwFormat *, bool );

private:

    OUString msDocAccTitle;

    void InitTOXTypes();

public:

    enum DocumentType {

        DOCTYPE_NATIVE,

        DOCTYPE_MSWORD              // This doc model comes from MS Word

        };

    DocumentType    meDocType;

    DocumentType    GetDocumentType() const { return meDocType; }

    void            SetDocumentType( DocumentType eDocType ) { meDocType = eDocType; }

    // Life cycle

    SW_DLLPUBLIC SwDoc();

    SW_DLLPUBLIC ~SwDoc();

    bool IsInDtor() const { return mbDtor; }

    /* @@@MAINTAINABILITY-HORROR@@@

       Implementation details made public.

    */

    SwNodes      & GetNodes()       { return *m_pNodes; }

    SwNodes const& GetNodes() const { return *m_pNodes; }

private:

    friend class ::rtl::Reference<SwDoc>;

    /** Acquire a reference to an instance. A caller shall release

        the instance by calling 'release' when it is no longer needed.

        'acquire' and 'release' calls need to be balanced.

        @returns

        the current reference count of the instance for debugging purposes.

    */

    SW_DLLPUBLIC sal_Int32 acquire();

    /** Releases a reference to an instance. A caller has to call

        'release' when a before acquired reference to an instance

        is no longer needed. 'acquire' and 'release' calls need to

        be balanced.

    @returns

        the current reference count of the instance for debugging purposes.

    */

    SW_DLLPUBLIC sal_Int32 release();

    /** Returns the current reference count. This method should be used for

        debugging purposes. Using it otherwise is a signal of a design flaw.

    */

public:

    sal_Int32 getReferenceCount() const;

    //MarkManager

    SW_DLLPUBLIC ::sw::mark::MarkManager& GetMarkManager();

    // IDocumentSettingAccess

    SW_DLLPUBLIC IDocumentSettingAccess const & getIDocumentSettingAccess() const; //The IDocumentSettingAccess interface

    SW_DLLPUBLIC IDocumentSettingAccess & getIDocumentSettingAccess();

    ::sw::DocumentSettingManager      & GetDocumentSettingManager(); //The implementation of the interface with some additional methods

    ::sw::DocumentSettingManager const& GetDocumentSettingManager() const;

    sal_uInt32 getRsid() const;

    void setRsid( sal_uInt32 nVal );

    sal_uInt32 getRsidRoot() const;

    void setRsidRoot( sal_uInt32 nVal );

    // IDocumentDeviceAccess

    IDocumentDeviceAccess const & getIDocumentDeviceAccess() const;

    SW_DLLPUBLIC IDocumentDeviceAccess & getIDocumentDeviceAccess();

    // IDocumentMarkAccess

    SW_DLLPUBLIC IDocumentMarkAccess* getIDocumentMarkAccess();

    SW_DLLPUBLIC const IDocumentMarkAccess* getIDocumentMarkAccess() const;

    // IDocumentRedlineAccess

    IDocumentRedlineAccess const& getIDocumentRedlineAccess() const;

    SW_DLLPUBLIC IDocumentRedlineAccess& getIDocumentRedlineAccess();

    ::sw::DocumentRedlineManager const& GetDocumentRedlineManager() const;

    SW_DLLPUBLIC ::sw::DocumentRedlineManager& GetDocumentRedlineManager();

    // IDocumentUndoRedo

    SW_DLLPUBLIC IDocumentUndoRedo      & GetIDocumentUndoRedo();

    IDocumentUndoRedo const& GetIDocumentUndoRedo() const;

    // IDocumentLinksAdministration

    IDocumentLinksAdministration const & getIDocumentLinksAdministration() const;

    SW_DLLPUBLIC IDocumentLinksAdministration & getIDocumentLinksAdministration();

    ::sw::DocumentLinksAdministrationManager const & GetDocumentLinksAdministrationManager() const;

    ::sw::DocumentLinksAdministrationManager & GetDocumentLinksAdministrationManager();

    // IDocumentFieldsAccess

    IDocumentFieldsAccess const & getIDocumentFieldsAccess() const;

    SW_DLLPUBLIC IDocumentFieldsAccess & getIDocumentFieldsAccess();

    ::sw::DocumentFieldsManager & GetDocumentFieldsManager();

    // Returns 0 if the field cannot hide para, or a positive integer indicating the field type

    // "weight" when several hiding fields' FieldHidesPara() give conflicting results

    int FieldCanHideParaWeight(SwFieldIds eFieldId) const;

    bool FieldHidesPara(const SwField& rField) const;

    // IDocumentContentOperations

    IDocumentContentOperations const & getIDocumentContentOperations() const;

    SW_DLLPUBLIC IDocumentContentOperations & getIDocumentContentOperations();

    ::sw::DocumentContentOperationsManager const & GetDocumentContentOperationsManager() const;

    ::sw::DocumentContentOperationsManager & GetDocumentContentOperationsManager();

    bool UpdateParRsid( SwTextNode *pTextNode, sal_uInt32 nVal = 0 );

    void UpdateRsid( const SwPaM &rRg, sal_Int32 nLen );

    // IDocumentStylePoolAccess

    IDocumentStylePoolAccess const & getIDocumentStylePoolAccess() const;

    SW_DLLPUBLIC IDocumentStylePoolAccess & getIDocumentStylePoolAccess();

    // SwLineNumberInfo

    SW_DLLPUBLIC const SwLineNumberInfo& GetLineNumberInfo() const;

    SW_DLLPUBLIC void SetLineNumberInfo(const SwLineNumberInfo& rInfo);

    // IDocumentStatistics

    IDocumentStatistics const & getIDocumentStatistics() const;

    SW_DLLPUBLIC IDocumentStatistics & getIDocumentStatistics();

    ::sw::DocumentStatisticsManager const & GetDocumentStatisticsManager() const;

    ::sw::DocumentStatisticsManager & GetDocumentStatisticsManager();

    // IDocumentState

    IDocumentState const & getIDocumentState() const;

    SW_DLLPUBLIC IDocumentState & getIDocumentState();

    // IDocumentDrawModelAccess

    void AddDrawUndo( std::unique_ptr<SdrUndoAction> );

    SW_DLLPUBLIC IDocumentDrawModelAccess const & getIDocumentDrawModelAccess() const;

    SW_DLLPUBLIC IDocumentDrawModelAccess & getIDocumentDrawModelAccess();

    ::sw::DocumentDrawModelManager const & GetDocumentDrawModelManager() const;

    ::sw::DocumentDrawModelManager & GetDocumentDrawModelManager();

    // IDocumentLayoutAccess

    SW_DLLPUBLIC IDocumentLayoutAccess const & getIDocumentLayoutAccess() const;

    SW_DLLPUBLIC IDocumentLayoutAccess & getIDocumentLayoutAccess();

    ::sw::DocumentLayoutManager const & GetDocumentLayoutManager() const;

    ::sw::DocumentLayoutManager & GetDocumentLayoutManager();

    // IDocumentTimerAccess

    // Our own 'IdleTimer' calls the following method

    IDocumentTimerAccess const & getIDocumentTimerAccess() const;

    IDocumentTimerAccess & getIDocumentTimerAccess();

    // IDocumentChartDataProviderAccess

    IDocumentChartDataProviderAccess const & getIDocumentChartDataProviderAccess() const;

    IDocumentChartDataProviderAccess & getIDocumentChartDataProviderAccess();

    // IDocumentListItems

    IDocumentListItems const & getIDocumentListItems() const;

    IDocumentListItems & getIDocumentListItems();

    // IDocumentOutlineNodes

    IDocumentOutlineNodes const & getIDocumentOutlineNodes() const;

    IDocumentOutlineNodes & getIDocumentOutlineNodes();

    // IDocumentListsAccess

    IDocumentListsAccess const & getIDocumentListsAccess() const;

    SW_DLLPUBLIC IDocumentListsAccess & getIDocumentListsAccess();

    //IDocumentExternalData

    IDocumentExternalData const & getIDocumentExternalData() const;

    SW_DLLPUBLIC IDocumentExternalData & getIDocumentExternalData();

    //End of Interfaces

    void setDocAccTitle( const OUString& rTitle ) { msDocAccTitle = rTitle; }

    const OUString& getDocAccTitle() const { return msDocAccTitle; }

    // INextInterface here

    DECL_LINK(CalcFieldValueHdl, EditFieldInfo*, void);

    // OLE ???

    bool IsOLEPrtNotifyPending() const  { return mbOLEPrtNotifyPending; }

    inline void SetOLEPrtNotifyPending( bool bSet = true );

    void PrtOLENotify( bool bAll ); // All or only marked

    bool IsPrepareSelAll() const { return mbIsPrepareSelAll; }

    void SetPrepareSelAll() { mbIsPrepareSelAll = true; }

    void SetContainsAtPageObjWithContentAnchor( const bool bFlag )

    {

        mbContainsAtPageObjWithContentAnchor = bFlag;

    }

    bool DoesContainAtPageObjWithContentAnchor()

    {

        return mbContainsAtPageObjWithContentAnchor;

    }

    /** Returns positions of all FlyFrames in the document.

     If a Pam-Pointer is passed the FlyFrames attached to paragraphs

     have to be surrounded completely by css::awt::Selection.

     ( Start < Pos < End ) !!!

     (Required for Writers.) */

    SW_DLLPUBLIC SwPosFlyFrames GetAllFlyFormats( const SwPaM*,

                        bool bDrawAlso,

                        bool bAsCharAlso = false ) const;

    SwFlyFrameFormat  *MakeFlyFrameFormat (const UIName &rFormatName, SwFrameFormat *pDerivedFrom);

    SwDrawFrameFormat *MakeDrawFrameFormat(const UIName &rFormatName, SwFrameFormat *pDerivedFrom);

    // From now on this interface has to be used for Flys.

    // pAnchorPos must be set, if they are not attached to pages AND

    // Anchor is not already set at valid ContentPos

    // in FlySet/FrameFormat.

    /* new parameter bCalledFromShell

       true: An existing adjust item at pAnchorPos is propagated to

       the content node of the new fly section. That propagation only

       takes place if there is no adjust item in the paragraph style

       for the new fly section.

       false: no propagation

    */

    SW_DLLPUBLIC SwFlyFrameFormat* MakeFlySection( RndStdIds eAnchorType,

                                 const SwPosition* pAnchorPos,

                                 const SfxItemSet* pSet = nullptr,

                                 SwFrameFormat *pParent = nullptr,

                                 bool bCalledFromShell = false );

    SwFlyFrameFormat* MakeFlyAndMove( const SwPaM& rPam, const SfxItemSet& rSet,

                                const SwSelBoxes* pSelBoxes,

                                SwFrameFormat *pParent );

    // Helper that checks for unique items for DrawingLayer items of type NameOrIndex

    // and evtl. corrects that items to ensure unique names for that type. This call may

    // modify/correct entries inside of the given SfxItemSet, and it will apply a name to

    // the items in question (what is essential to make the named slots associated with

    // these items work for the UNO API and thus e.g. for ODF import/export)

    void CheckForUniqueItemForLineFillNameOrIndex(SfxItemSet& rSet);

    SW_DLLPUBLIC bool SetFlyFrameAttr( SwFrameFormat& rFlyFormat, SfxItemSet& rSet );

    bool SetFrameFormatToFly( SwFrameFormat& rFlyFormat, SwFrameFormat& rNewFormat,

                        SfxItemSet* pSet = nullptr, bool bKeepOrient = false );

    void SetFlyFrameTitle( SwFlyFrameFormat& rFlyFrameFormat,

                         const OUString& sNewTitle );

    void SetFlyFrameDescription( SwFlyFrameFormat& rFlyFrameFormat,

                               const OUString& sNewDescription );

    void SetFlyFrameDecorative(SwFlyFrameFormat& rFlyFrameFormat,

                               bool isDecorative);

    // Footnotes

    // Footnote information

    const SwFootnoteInfo& GetFootnoteInfo() const         { return *mpFootnoteInfo; }

    SW_DLLPUBLIC void SetFootnoteInfo(const SwFootnoteInfo& rInfo);

    const SwEndNoteInfo& GetEndNoteInfo() const { return *mpEndNoteInfo; }

    SW_DLLPUBLIC void SetEndNoteInfo(const SwEndNoteInfo& rInfo);

          SwFootnoteIdxs& GetFootnoteIdxs()       { return *mpFootnoteIdxs; }

    const SwFootnoteIdxs& GetFootnoteIdxs() const { return *mpFootnoteIdxs; }

    /// change footnotes in range

    bool SetCurFootnote( const SwPaM& rPam, const OUString& rNumStr,

                    bool bIsEndNote );

    /** Operations on the content of the document e.g.

        spell-checking/hyphenating/word-counting

    */

    css::uno::Any

            Spell( SwPaM&, css::uno::Reference< css::linguistic2::XSpellChecker1 > const &,

                   sal_uInt16* pPageCnt, sal_uInt16* pPageSt, bool bGrammarCheck,

                   SwRootFrame const* pLayout, // for grammar-check

                   SwConversionArgs *pConvArgs = nullptr ) const;

    css::uno::Reference< css::linguistic2::XHyphenatedWord >

            Hyphenate( SwPaM *pPam, const Point &rCursorPos,

                         sal_uInt16* pPageCnt, sal_uInt16* pPageSt );

    // count words in pam

    static void CountWords( const SwPaM& rPaM, SwDocStat& rStat );

    // Glossary Document

    bool IsInsOnlyTextGlossary() const      { return mbInsOnlyTextGlssry; }

    void Summary(SwDoc& rExtDoc, sal_uInt8 nLevel, sal_uInt8 nPara, bool bImpress);

    void ChangeAuthorityData(const SwAuthEntry* pNewData);

    bool IsInHeaderFooter( const SwNode& ) const;

    SW_DLLPUBLIC SvxFrameDirection GetTextDirection( const SwPosition& rPos,

                            const Point* pPt = nullptr ) const;

    SW_DLLPUBLIC bool IsInVerticalText( const SwPosition& rPos ) const;

    // Database  and DB-Manager

    void SetDBManager( SwDBManager* pNewMgr )     { m_pDBManager = pNewMgr; }

    SwDBManager* GetDBManager() const             { return m_pDBManager; }

    void ChangeDBFields( const std::vector<OUString>& rOldNames,

                        const OUString& rNewName );

    SW_DLLPUBLIC void SetInitDBFields(bool b);

    // Find out which databases are used by fields.

    void GetAllUsedDB( std::vector<OUString>& rDBNameList,

                       const std::vector<OUString>* pAllDBNames = nullptr );

    void ChgDBData( const SwDBData& rNewData );

    SW_DLLPUBLIC SwDBData const & GetDBData();

    // Some helper functions

    UIName GetUniqueGrfName(UIName rPrefix = UIName()) const;

    UIName GetUniqueOLEName() const;

    SW_DLLPUBLIC UIName GetUniqueFrameName() const;

    UIName GetUniqueShapeName() const;

    SW_DLLPUBLIC UIName GetUniqueDrawObjectName() const;

    SW_DLLPUBLIC o3tl::sorted_vector<SwRootFrame*> GetAllLayouts();

    void SetFlyName( SwFlyFrameFormat& rFormat, const UIName& rName );

    SW_DLLPUBLIC const SwFlyFrameFormat* FindFlyByName( const UIName& rName, SwNodeType nNdTyp = SwNodeType::NONE ) const;

    static void GetGrfNms( const SwFlyFrameFormat& rFormat, OUString* pGrfName, OUString* pFltName );

    // Set a valid name for all Flys that have none (Called by Readers after reading).

    void SetAllUniqueFlyNames();

    /** Reset attributes. All TextHints and (if completely selected) all hard-

     formatted stuff (auto-formats) are removed.

     Introduce new optional parameter <bSendDataChangedEvents> in order to

     control, if the side effect "send data changed events" is triggered or not. */

    void ResetAttrs( const SwPaM &rRg,

                     bool bTextAttr = true,

                     const o3tl::sorted_vector<sal_uInt16> &rAttrs = o3tl::sorted_vector<sal_uInt16>(),

                     const bool bSendDataChangedEvents = true,

                     SwRootFrame const* pLayout = nullptr);

    void RstTextAttrs(const SwPaM &rRg, bool bInclRefToxMark = false,

            bool bExactRange = false, SwRootFrame const* pLayout = nullptr);

    /** Set attribute in given format.1y

     *  If Undo is enabled, the old values is added to the Undo history. */

    SW_DLLPUBLIC void SetAttr( const SfxPoolItem&, SwFormat& );

    /** Set attribute in given format.1y

     *  If Undo is enabled, the old values is added to the Undo history. */

    SW_DLLPUBLIC void SetAttr( const SfxItemSet&, SwFormat& );

    // method to reset a certain attribute at the given format

    void ResetAttrAtFormat( const std::vector<sal_uInt16>& rIds,

                            SwFormat& rChangedFormat );

    /** Set attribute as new default attribute in current document.

     If Undo is activated, the old one is listed in Undo-History. */

    void SetDefault( const SfxPoolItem& );

    void SetDefault( const SfxItemSet& );

    // Query default attribute in this document.

    SW_DLLPUBLIC const SfxPoolItem& GetDefault( sal_uInt16 nFormatHint ) const;

    template<class T> const T&  GetDefault( TypedWhichId<T> nWhich ) const

    {

        return static_cast<const T&>(GetDefault(sal_uInt16(nWhich)));

    }

Unexecuted instantiation: SvxTabStopItem const& SwDoc::GetDefault<SvxTabStopItem>(TypedWhichId<SvxTabStopItem>) const

SvxLanguageItem const& SwDoc::GetDefault<SvxLanguageItem>(TypedWhichId<SvxLanguageItem>) const

Line

Count

Source

771

250k

    {

772

250k

        return static_cast<const T&>(GetDefault(sal_uInt16(nWhich)));

773

250k

    }

Unexecuted instantiation: SvxFontItem const& SwDoc::GetDefault<SvxFontItem>(TypedWhichId<SvxFontItem>) const

SvxHyphenZoneItem const& SwDoc::GetDefault<SvxHyphenZoneItem>(TypedWhichId<SvxHyphenZoneItem>) const

Line

Count

Source

771

77.3k

    {

772

77.3k

        return static_cast<const T&>(GetDefault(sal_uInt16(nWhich)));

773

77.3k

    }

SwTextGridItem const& SwDoc::GetDefault<SwTextGridItem>(TypedWhichId<SwTextGridItem>) const

Line

Count

Source

771

739k

    {

772

739k

        return static_cast<const T&>(GetDefault(sal_uInt16(nWhich)));

773

739k

    }

SvxColorItem const& SwDoc::GetDefault<SvxColorItem>(TypedWhichId<SvxColorItem>) const

Line

Count

Source

771

67

    {

772

67

        return static_cast<const T&>(GetDefault(sal_uInt16(nWhich)));

773

67

    }

    // Do not expand text attributes.

    bool DontExpandFormat( const SwPosition& rPos, bool bFlag = true );

    // Formats

    const sw::FrameFormats<SwFrameFormat*>* GetFrameFormats() const     { return mpFrameFormatTable.get(); }

          sw::FrameFormats<SwFrameFormat*>* GetFrameFormats()           { return mpFrameFormatTable.get(); }

    const SwCharFormats* GetCharFormats() const   { return mpCharFormatTable.get();}

          SwCharFormats* GetCharFormats()         { return mpCharFormatTable.get();}

    // LayoutFormats (frames, DrawObjects), sometimes const sometimes not

    const sw::FrameFormats<sw::SpzFrameFormat*>* GetSpzFrameFormats() const   { return mpSpzFrameFormatTable.get(); }

          sw::FrameFormats<sw::SpzFrameFormat*>* GetSpzFrameFormats()         { return mpSpzFrameFormatTable.get(); }

    const SwFrameFormat *GetDfltFrameFormat() const   { return mpDfltFrameFormat.get(); }

          SwFrameFormat *GetDfltFrameFormat()         { return mpDfltFrameFormat.get(); }

    const SwFrameFormat *GetEmptyPageFormat() const { return mpEmptyPageFormat.get(); }

          SwFrameFormat *GetEmptyPageFormat()       { return mpEmptyPageFormat.get(); }

    const SwFrameFormat *GetColumnContFormat() const{ return mpColumnContFormat.get(); }

          SwFrameFormat *GetColumnContFormat()      { return mpColumnContFormat.get(); }

    const SwCharFormat *GetDfltCharFormat() const { return mpDfltCharFormat.get();}

          SwCharFormat *GetDfltCharFormat()       { return mpDfltCharFormat.get();}

    // @return the interface of the management of (auto)styles

    IStyleAccess& GetIStyleAccess() { return *mpStyleAccess; }

    // Remove all language dependencies from all existing formats

    void RemoveAllFormatLanguageDependencies();

    SW_DLLPUBLIC SwFrameFormat* MakeFrameFormat(const UIName &rFormatName, SwFrameFormat *pDerivedFrom,

                          bool bAuto = true);

    SW_DLLPUBLIC void DelFrameFormat( SwFrameFormat *pFormat, bool bBroadcast = false );

    SwFrameFormat* FindFrameFormatByName( const UIName& rName ) const;

    SW_DLLPUBLIC SwCharFormat *MakeCharFormat(const UIName &rFormatName, SwCharFormat *pDerivedFrom);

    void       DelCharFormat(size_t nFormat, bool bBroadcast = false);

    void       DelCharFormat(SwCharFormat const * pFormat, bool bBroadcast = false);

    SW_DLLPUBLIC SwCharFormat* FindCharFormatByName( const UIName& rName ) const;

    // Formatcollections (styles)

    // TXT

    const SwTextFormatColl* GetDfltTextFormatColl() const { return mpDfltTextFormatColl.get(); }

    SwTextFormatColl* GetDfltTextFormatColl() { return mpDfltTextFormatColl.get(); }

    const SwTextFormatColls *GetTextFormatColls() const { return mpTextFormatCollTable.get(); }

    SwTextFormatColls *GetTextFormatColls() { return mpTextFormatCollTable.get(); }

    SW_DLLPUBLIC SwTextFormatColl *MakeTextFormatColl( const UIName &rFormatName,

                                  SwTextFormatColl *pDerivedFrom);

    SwConditionTextFormatColl* MakeCondTextFormatColl( const UIName &rFormatName,

                                               SwTextFormatColl *pDerivedFrom);

    void DelTextFormatColl(size_t nFormat, bool bBroadcast = false);

    void DelTextFormatColl( SwTextFormatColl const * pColl, bool bBroadcast = false );

    /** Add 4th optional parameter <bResetListAttrs>.

     'side effect' of <SetTextFormatColl> with <bReset = true> is that the hard

     attributes of the affected text nodes are cleared, except the break

     attribute, the page description attribute and the list style attribute.

     The new parameter <bResetListAttrs> indicates, if the list attributes

     (list style, restart at and restart with) are cleared as well in case

     that <bReset = true> and the paragraph style has a list style attribute set. */

    SW_DLLPUBLIC bool SetTextFormatColl(const SwPaM &rRg, SwTextFormatColl *pFormat,

                       const bool bReset = true,

                       const bool bResetListAttrs = false,

                       const bool bResetAllCharAttrs = false,

                       SwRootFrame const* pLayout = nullptr);

    SwTextFormatColl* FindTextFormatCollByName( const UIName& rName ) const

        {   return mpTextFormatCollTable->FindFormatByName(rName); }

    void ChkCondColls();

    const SwGrfFormatColl* GetDfltGrfFormatColl() const   { return mpDfltGrfFormatColl.get(); }

    SwGrfFormatColl* GetDfltGrfFormatColl()  { return mpDfltGrfFormatColl.get(); }

    const SwGrfFormatColls *GetGrfFormatColls() const     { return mpGrfFormatCollTable.get(); }

    SwGrfFormatColl *MakeGrfFormatColl(const UIName &rFormatName,

                                    SwGrfFormatColl *pDerivedFrom);

    // Table formatting

    const sw::TableFrameFormats* GetTableFrameFormats() const  { return mpTableFrameFormatTable.get(); }

          sw::TableFrameFormats* GetTableFrameFormats()        { return mpTableFrameFormatTable.get(); }

    SW_DLLPUBLIC size_t GetTableFrameFormatCount( bool bUsed ) const;

    SwTableFormat& GetTableFrameFormat(size_t nFormat, bool bUsed ) const;

    SwTableFormat* MakeTableFrameFormat(const UIName &rFormatName, SwFrameFormat *pDerivedFrom);

    void        DelTableFrameFormat( SwTableFormat* pFormat );

    SW_DLLPUBLIC SwTableFormat* FindTableFormatByName( const UIName& rName, bool bAll = false ) const;

    /** Access to frames.

    Iterate over Flys - for Basic-Collections. */

    SW_DLLPUBLIC size_t GetFlyCount( FlyCntType eType, bool bIgnoreTextBoxes = false ) const;

    SwFrameFormat* GetFlyNum(size_t nIdx, FlyCntType eType, bool bIgnoreTextBoxes = false );

    SW_DLLPUBLIC std::vector<SwFrameFormat const*> GetFlyFrameFormats(

            FlyCntType eType,

            bool bIgnoreTextBoxes);

    SwFrameFormat* GetFlyFrameFormatByName( const UIName& sFrameFormatName );

    // Copy formats in own arrays and return them.

    SwFrameFormat  *CopyFrameFormat ( const SwFrameFormat& );

    SwCharFormat *CopyCharFormat( const SwCharFormat& );

    SwTextFormatColl* CopyTextColl( const SwTextFormatColl& rColl );

    SwGrfFormatColl* CopyGrfColl( const SwGrfFormatColl& rColl );

    // Replace all styles with those from rSource.

    void ReplaceStyles( const SwDoc& rSource, bool bIncludePageStyles = true );

    // Replace all property defaults with those from rSource.

    SW_DLLPUBLIC void ReplaceDefaults( const SwDoc& rSource );

    // Replace all compatibility options with those from rSource.

    SW_DLLPUBLIC void ReplaceCompatibilityOptions( const SwDoc& rSource );

    /** Replace all user defined document properties with xSourceDocProps.

        Convenience function used by ReplaceDocumentProperties to skip some UNO calls.

     */

    void ReplaceUserDefinedDocumentProperties( const css::uno::Reference< css::document::XDocumentProperties >& xSourceDocProps );

    /** Replace document properties with those from rSource.

        This includes the user defined document properties!

     */

    SW_DLLPUBLIC void ReplaceDocumentProperties(const SwDoc& rSource, bool mailMerge = false);

    // Query if style (paragraph- / character- / frame- / page-) is used.

    bool IsUsed( const sw::BroadcastingModify& ) const;

    /// Query if table style is used.

    bool IsUsed( const SwTableAutoFormat& ) const;

    SW_DLLPUBLIC bool IsUsed( const SwNumRule& ) const;

    // Set name of newly loaded document template.

    size_t SetDocPattern(const OUString& rPatternName);

    // @return name of document template. Can be 0!

    const OUString* GetDocPattern(size_t nPos) const;

    // travel over PaM Ring

    bool InsertGlossary( SwTextBlocks& rBlock, const OUString& rEntry,

                        SwPaM& rPaM, SwCursorShell* pShell = nullptr);

    /** get the set of printable pages for the XRenderable API by

     evaluating the respective settings (see implementation) */

    static void CalculatePagesForPrinting( const SwRootFrame& rLayout, SwRenderData &rData, const SwPrintUIOptions &rOptions, bool bIsPDFExport,

            sal_Int32 nDocPageCount );

    static void UpdatePagesForPrintingWithPostItData( SwRenderData &rData, const SwPrintUIOptions &rOptions,

            sal_Int32 nDocPageCount );

    static void CalculatePagePairsForProspectPrinting( const SwRootFrame& rLayout, SwRenderData &rData, const SwPrintUIOptions &rOptions,

            sal_Int32 nDocPageCount );

    static void CalculateNonBlankPages( const SwRootFrame& rLayout, sal_uInt16& nDocPageCount, sal_uInt16& nActualPage );

    // PageDescriptor interface.

    size_t GetPageDescCnt() const { return m_PageDescs.size(); }

    const SwPageDesc& GetPageDesc(const size_t i) const { return *m_PageDescs[i]; }

    SwPageDesc& GetPageDesc(size_t const i) { return *m_PageDescs[i]; }

    SW_DLLPUBLIC SwPageDesc* FindPageDesc(const UIName& rName, size_t* pPos = nullptr) const;

    // Just searches the pointer in the m_PageDescs vector!

    bool        ContainsPageDesc(const SwPageDesc *pDesc, size_t* pPos) const;

    /** Copy the complete PageDesc - beyond document and "deep"!

     Optionally copying of PoolFormatId, -HlpId can be prevented. */

    SW_DLLPUBLIC void CopyPageDesc( const SwPageDesc& rSrcDesc, SwPageDesc& rDstDesc,

                        bool bCopyPoolIds = true );

    /** Copy header (with contents) from SrcFormat to DestFormat

     (can also be copied into other document). */

    void CopyHeader( const SwFrameFormat& rSrcFormat, SwFrameFormat& rDestFormat )

        { CopyPageDescHeaderFooterImpl( true, rSrcFormat, rDestFormat ); }

    /** Copy footer (with contents) from SrcFormat to DestFormat.

     (can also be copied into other document). */

    void CopyFooter( const SwFrameFormat& rSrcFormat, SwFrameFormat& rDestFormat )

        { CopyPageDescHeaderFooterImpl( false, rSrcFormat, rDestFormat ); }

    // For Reader

    SW_DLLPUBLIC void ChgPageDesc( const UIName & rName, const SwPageDesc& );

    SW_DLLPUBLIC void ChgPageDesc( size_t i, const SwPageDesc& );

    SW_DLLPUBLIC void DelPageDesc( const UIName & rName, bool bBroadcast = false );

    SW_DLLPUBLIC void DelPageDesc( size_t i, bool bBroadcast = false );

    void PreDelPageDesc(SwPageDesc const * pDel);

    SW_DLLPUBLIC SwPageDesc* MakePageDesc(const UIName &rName, const SwPageDesc* pCpy = nullptr,

                             bool bRegardLanguage = true);

    void BroadcastStyleOperation(const UIName& rName, SfxStyleFamily eFamily,

                                 SfxHintId nOp);

    /** The html import sometimes overwrites the page sizes set in

     the page descriptions. This function is used to correct this. */

    void CheckDefaultPageFormat();

    // Methods for tables/indices

    static sal_uInt16 GetCurTOXMark( const SwPosition& rPos, SwTOXMarks& );

    void DeleteTOXMark( const SwTOXMark* pTOXMark );

    SW_DLLPUBLIC const SwTOXMark& GotoTOXMark( const SwTOXMark& rCurTOXMark,

                                SwTOXSearch eDir, bool bInReadOnly );

    /// Iterate over all SwTOXMark, if the function returns false, iteration is stopped

    SW_DLLPUBLIC void ForEachTOXMark( const std::function<bool(const SwTOXMark&)>&  ) const;

    // Insert/Renew table/index

    SW_DLLPUBLIC SwTOXBaseSection* InsertTableOf( const SwPosition& rPos,

                                            const SwTOXBase& rTOX,

                                            const SfxItemSet* pSet = nullptr,

                                            bool bExpand = false,

                                    SwRootFrame const* pLayout = nullptr);

    SwTOXBaseSection* InsertTableOf( const SwPaM& aPam,

                                            const SwTOXBase& rTOX,

                                            const SfxItemSet* pSet = nullptr,

                                            bool bExpand = false,

                                    SwRootFrame const* pLayout = nullptr );

    void              InsertTableOf( SwNodeOffset nSttNd, SwNodeOffset nEndNd,

                                            const SwTOXBase& rTOX,

                                            const SfxItemSet* pSet );

    SW_DLLPUBLIC static SwTOXBase* GetCurTOX( const SwPosition& rPos );

    static const SwAttrSet* GetTOXBaseAttrSet(const SwTOXBase& rTOX);

    bool DeleteTOX( const SwTOXBase& rTOXBase, bool bDelNodes );

    OUString GetUniqueTOXBaseName( const SwTOXType& rType,

                                   const OUString& sChkStr ) const;

    bool SetTOXBaseName(const SwTOXBase& rTOXBase, const UIName& rName);

    // After reading file update all tables/indices

    void SetUpdateTOX( bool bFlag )            { mbUpdateTOX = bFlag; }

    bool IsUpdateTOX() const                   { return mbUpdateTOX; }

    const OUString& GetTOIAutoMarkURL() const {return msTOIAutoMarkURL;}

    void            SetTOIAutoMarkURL(const OUString& rSet) {msTOIAutoMarkURL = rSet;}

    bool IsInReading() const                    { return mbInReading; }

    void SetInReading( bool bNew )              { mbInReading = bNew; }

    bool IsInWriting() const { return mbInWriting; }

    void SetInWriting(bool bNew) { mbInWriting = bNew; }

    bool IsInMailMerge() const                  { return mbInMailMerge; }

    void SetInMailMerge( bool bNew )            { mbInMailMerge = bNew; }

    bool IsClipBoard() const                    { return mbClipBoard; }

    // N.B.: must be called right after constructor! (@see GetXmlIdRegistry)

    void SetClipBoard( bool bNew )              { mbClipBoard = bNew; }

    bool IsColumnSelection() const              { return mbColumnSelection; }

    void SetColumnSelection( bool bNew )        { mbColumnSelection = bNew; }

    bool IsInXMLImport() const { return mbInXMLImport; }

    void SetInXMLImport( bool bNew ) { mbInXMLImport = bNew; }

    bool IsInXMLImport242() const { return mbInXMLImport242; }

    void SetInXMLImport242(bool const bNew) { mbInXMLImport242 = bNew; }

    bool IsInWriterfilterImport() const { return mbInWriterfilterImport; }

    void SetInWriterfilterImport(bool const b) { mbInWriterfilterImport = b; }

    // Manage types of tables/indices

    SW_DLLPUBLIC sal_uInt16 GetTOXTypeCount( TOXTypes eTyp ) const;

    SW_DLLPUBLIC const SwTOXType* GetTOXType( TOXTypes eTyp, sal_uInt16 nId ) const;

    const SwTOXType* InsertTOXType( const SwTOXType& rTyp );

    const SwTOXTypes& GetTOXTypes() const { return *mpTOXTypes; }

    const SwTOXBase*    GetDefaultTOXBase( TOXTypes eTyp, bool bCreate );

    void                SetDefaultTOXBase(const SwTOXBase& rBase);

    // Key for management of index.

    void GetTOIKeys(SwTOIKeyType eTyp, std::vector<OUString>& rArr,

            SwRootFrame const& rLayout) const;

    // Sort table text.

    bool SortTable(const SwSelBoxes& rBoxes, const SwSortOptions&);

    bool SortText(const SwPaM&, const SwSortOptions&);

    // Correct the SwPosition-Objects that are registered with the document

    // e. g. Bookmarks or tables/indices.

    // If bMoveCursor is set move Cursor too.

    // Set everything in rOldNode on rNewPos + Offset.

    void CorrAbs(

        const SwNode& rOldNode,

        const SwPosition& rNewPos,

        const sal_Int32 nOffset = 0,

        bool bMoveCursor = false );

    // Set everything in the range of [rStartNode, rEndNode] to rNewPos.

    static void CorrAbs(

        const SwNodeIndex& rStartNode,

        const SwNodeIndex& rEndNode,

        const SwPosition& rNewPos,

        bool bMoveCursor = false );

    // Set everything in this range from rRange to rNewPos.

    static void CorrAbs(

        const SwPaM& rRange,

        const SwPosition& rNewPos,

        bool bMoveCursor = false );

    // Set everything in rOldNode to relative Pos.

    void CorrRel(

        const SwNode& rOldNode,

        const SwPosition& rNewPos,

        const sal_Int32 nOffset = 0,

        bool bMoveCursor = false );

    // Query / set rules for Outline.

    SwNumRule* GetOutlineNumRule() const

    {

        return mpOutlineRule;

    }

    SW_DLLPUBLIC void SetOutlineNumRule( const SwNumRule& rRule );

    SW_DLLPUBLIC void PropagateOutlineRule();

    // Outline - promote / demote.

    bool OutlineUpDown(const SwPaM& rPam, short nOffset, SwRootFrame const* pLayout = nullptr);

    /// Outline - move up / move down.

    bool MoveOutlinePara( const SwPaM& rPam,

                    SwOutlineNodes::difference_type nOffset,

                    const SwOutlineNodesInline* pOutlNdsInline = nullptr);

    SW_DLLPUBLIC bool GotoOutline(SwPosition& rPos, const OUString& rName, SwRootFrame const* = nullptr) const;

    enum class SetNumRuleMode {

        Default = 0,

        /// indicates if a new list is created by applying the given list style.

        CreateNewList = 1,

        DontSetItem = 2,

        /** If enabled, the indent attributes "before text" and

          "first line indent" are additionally reset at the provided PaM,

          if the list style makes use of the new list level attributes. */

        ResetIndentAttrs = 4,

        DontSetIfAlreadyApplied = 8

    };

    /** Set or change numbering rule on text nodes, as direct formatting.

     @param sContinuedListId If bCreateNewList is false, may contain the

      list Id of a list which has to be continued by applying the given list style

     @return the set ListId if bSetItem is true */

    OUString SetNumRule( const SwPaM&,

                     const SwNumRule&,

                     SetNumRuleMode mode,