sw/source/core/inc/UndoInsert.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SW_SOURCE_CORE_INC_UNDOINSERT_HXX
  21 #define INCLUDED_SW_SOURCE_CORE_INC_UNDOINSERT_HXX
  22
  23 #include <memory>
  24
  25 #include <undobj.hxx>
  26 #include <svx/svdtypes.hxx>
  27 #include <rtl/ustring.hxx>
  28 #include <vcl/graph.hxx>
  29 #include <swtypes.hxx>
  30 #include <ndindex.hxx>
  31 #include <IDocumentContentOperations.hxx>
  32 #include <optional>
  33
  34 class SwGrfNode;
  35 class SwUndoDelete;
  36 class SwUndoFormatAttr;
  37 class SwDoc;
  38 namespace sw { class DocumentContentOperationsManager; }
  39 enum class MirrorGraph;
  40
  41 /// Typing one or more characters to a single paragraph.
  42 class SwUndoInsert final : public SwUndo, private SwUndoSaveContent
  43 {
  44     /// start of Content in UndoNodes for Redo
  45     std::optional<SwNodeIndex> m_oUndoNodeIndex;
  46     std::optional<OUString> maText;
  47     std::optional<OUString> maUndoText;
  48     std::unique_ptr<SwRedlineData> m_pRedlData;
  49     SwNodeOffset m_nNode;
  50     sal_Int32 m_nContent, m_nLen;
  51     bool m_bIsWordDelim : 1;
  52     bool m_bIsAppend : 1;
  53     bool m_bWithRsid : 1;
  54
  55     const SwInsertFlags m_nInsertFlags;
  56
  57     friend class ::sw::DocumentContentOperationsManager;     // actually only DocumentContentOperationsManager::InsertString, because it uses CanGrouping
  58     bool CanGrouping( sal_Unicode cIns );
  59     bool CanGrouping( const SwPosition& rPos );
  60
  61     SwDoc * m_pDoc;
  62
  63     void Init(const SwNode & rNode);
  64     std::optional<OUString> GetTextFromDoc() const;
  65
  66 public:
  67     SwUndoInsert( const SwNode& rNode, sal_Int32 nContent, sal_Int32 nLen,
  68                   const SwInsertFlags nInsertFlags,
  69                   bool bWDelim = true );
  70     SwUndoInsert( const SwNode& rNode );
  71     virtual ~SwUndoInsert() override;
  72
  73     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
  74     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
  75     virtual void RepeatImpl( ::sw::RepeatContext & ) override;
  76
  77     /**
  78        Returns rewriter for this undo object.
  79
  80        The returned rewriter has the following rule:
  81
  82            $1 -> '<inserted text>'
  83
  84        <inserted text> is shortened to a length of nUndoStringLength.
  85
  86        @return rewriter for this undo object
  87      */
  88     virtual SwRewriter GetRewriter() const override;
  89
  90     void SetWithRsid() { m_bWithRsid = true; }
  91
  92     bool IsIndependent(const SwUndoInsert& rOther) const;
  93 };
  94
  95 SwRewriter
  96 MakeUndoReplaceRewriter(sal_uLong const occurrences,
  97     OUString const& sOld, OUString const& sNew);
  98
  99 class SwUndoReplace final
 100     : public SwUndo
 101 {
 102 public:
 103     SwUndoReplace(SwPaM const& rPam,
 104             OUString const& rInsert, bool const bRegExp);
 105
 106     virtual ~SwUndoReplace() override;
 107
 108     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
 109     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
 110
 111     /**
 112        Returns the rewriter of this undo object.
 113
 114        If this undo object represents several replacements the
 115        rewriter contains the following rules:
 116
 117            $1 -> <number of replacements>
 118            $2 -> occurrences of
 119            $3 -> <replaced text>
 120
 121        If this undo object represents one replacement the rewriter
 122        contains these rules:
 123
 124            $1 -> <replaced text>
 125            $2 -> "->"                   (STR_YIELDS)
 126            $3 -> <replacing text>
 127
 128        @return the rewriter of this undo object
 129     */
 130     virtual SwRewriter GetRewriter() const override;
 131
 132     void SetEnd( const SwPaM& rPam );
 133
 134 private:
 135     class Impl;
 136     std::unique_ptr<Impl> m_pImpl;
 137 };
 138
 139 /// Handles the undo/redo of the 'Replace...' context menu item for an image.
 140 class SwUndoReRead final : public SwUndo
 141 {
 142     std::optional<Graphic> moGraphic;
 143     std::optional<OUString> maNm;
 144     std::optional<OUString> maFltr;
 145     SwNodeOffset mnPosition;
 146     MirrorGraph mnMirror;
 147
 148     void SaveGraphicData( const SwGrfNode& );
 149     void SetAndSave( ::sw::UndoRedoContext & );
 150
 151 public:
 152     SwUndoReRead( const SwPaM& rPam, const SwGrfNode& pGrfNd );
 153
 154     virtual ~SwUndoReRead() override;
 155
 156     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
 157     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
 158 };
 159
 160 class SwUndoInsertLabel final : public SwUndo
 161 {
 162     union {
 163         struct {
 164             // for NoTextFrames
 165             SwUndoInsLayFormat* pUndoFly;
 166             SwUndoFormatAttr* pUndoAttr;
 167         } OBJECT;
 168         struct {
 169             // for tables or TextFrames
 170             SwUndoDelete* pUndoInsNd;
 171             SwNodeOffset nNode;
 172         } NODE;
 173     };
 174
 175     OUString m_sText;
 176     // #i39983# the separator is drawn with a character style
 177     OUString m_sSeparator;
 178     OUString m_sNumberSeparator;
 179     OUString m_sCharacterStyle;
 180     // #i26791# - re-store of drawing object position no longer needed
 181     sal_uInt16 m_nFieldId;
 182     SwLabelType m_eType;
 183     SdrLayerID m_nLayerId;              // for character objects
 184     bool m_bBefore        :1;
 185     bool m_bUndoKeep      :1;
 186     bool m_bCopyBorder        :1;
 187
 188 public:
 189     SwUndoInsertLabel( const SwLabelType eTyp, OUString rText,
 190     // #i39983# the separator is drawn with a character style
 191                         OUString aSeparator,
 192                         OUString aNumberSeparator, //#i61007# order of captions
 193                         const bool bBefore, const sal_uInt16 nId,
 194                         OUString aCharacterStyle,
 195                         const bool bCpyBrd,
 196                         const SwDoc* pDoc );
 197     virtual ~SwUndoInsertLabel() override;
 198
 199     virtual void UndoImpl( ::sw::UndoRedoContext & ) override;
 200     virtual void RedoImpl( ::sw::UndoRedoContext & ) override;
 201     virtual void RepeatImpl( ::sw::RepeatContext & ) override;
 202
 203     /**
 204        Returns the rewriter of this undo object.
 205
 206        The rewriter contains this rule:
 207
 208            $1 -> '<text of inserted label>'
 209
 210        <text of inserted label> is shortened to nUndoStringLength
 211        characters.
 212
 213        @return the rewriter of this undo object
 214      */
 215     virtual SwRewriter GetRewriter() const override;
 216     static SwRewriter CreateRewriter(const OUString &rStr);
 217
 218     void SetNodePos( SwNodeOffset nNd )
 219         { if( SwLabelType::Object != m_eType ) NODE.nNode = nNd; }
 220
 221     void SetUndoKeep()  { m_bUndoKeep = true; }
 222     void SetFlys( SwFrameFormat& rOldFly, SfxItemSet const & rChgSet, SwFrameFormat& rNewFly );
 223     void SetDrawObj( SdrLayerID nLayerId );
 224 };
 225
 226 #endif // INCLUDED_SW_SOURCE_CORE_INC_UNDOINSERT_HXX
 227
 228 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */