sw/inc/IDocumentContentOperations.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_INC_IDOCUMENTCONTENTOPERATIONS_HXX
  21 #define INCLUDED_SW_INC_IDOCUMENTCONTENTOPERATIONS_HXX
  22
  23 #include <sal/types.h>
  24 #include <rtl/ustring.hxx>
  25 #include "swtypes.hxx"
  26
  27 class SwPaM;
  28 struct SwPosition;
  29 class SwNode;
  30 class SwNodeRange;
  31 class Graphic;
  32 class SfxItemSet;
  33 class SfxPoolItem;
  34 class GraphicObject;
  35 class SdrObject;
  36 class SwFrameFormat;
  37 class SwDrawFrameFormat;
  38 class SwFlyFrameFormat;
  39 class SwNodeIndex;
  40 class SwFormatField;
  41
  42 namespace utl { class TransliterationWrapper; }
  43 namespace svt { class EmbeddedObjectRef; }
  44
  45 enum class SwMoveFlags
  46 {
  47     DEFAULT       = 0x00,
  48     ALLFLYS       = 0x01,
  49     CREATEUNDOOBJ = 0x02,
  50     REDLINES      = 0x04,
  51     NO_DELFRMS    = 0x08
  52 };
  53 namespace o3tl
  54 {
  55     template<> struct typed_flags<SwMoveFlags> : is_typed_flags<SwMoveFlags, 0x0f> {};
  56 }
  57
  58 // constants for inserting text
  59 enum class SwInsertFlags
  60 {
  61     DEFAULT         = 0x00, // no extras
  62     EMPTYEXPAND     = 0x01, // expand empty hints at insert position
  63     NOHINTEXPAND    = 0x02, // do not expand any hints at insert pos
  64     FORCEHINTEXPAND = 0x04 // expand all hints at insert position
  65 };
  66 namespace o3tl
  67 {
  68     template<> struct typed_flags<SwInsertFlags> : is_typed_flags<SwInsertFlags, 0x07> {};
  69 }
  70
  71 /** Text operation/manipulation interface
  72 */
  73 class IDocumentContentOperations
  74 {
  75 public:
  76 public:
  77     /** Copy a selected content range to a position
  78
  79         The position can be in the same or in an another document. It can also
  80         be within the range!
  81
  82         \warning The range has to include at least two nodes or has to be a
  83         SwDoc::IsColumnSelection!
  84
  85         Normally this function should work only with content nodes. But there
  86         is a special case used by SwDoc::Paste, which starts the SwPaM at the
  87         content start node. This position doesn't contain any content:
  88
  89         @code
  90         SwNodeIndex aSourceIdx( rSource.GetNodes().GetEndOfExtras(), 1 );
  91         @endcode
  92
  93         This is important, because it prevents merging of the first node of
  94         the range into the node pointed to by \p rPos.
  95         As a result this keeps all properties of the first real content node,
  96         which is the 2nd, including the Flys and the page description. In this
  97         case the first (fake) node is silently dropped and all other nodes are
  98         just copied.
  99
 100         @param rPam
 101         The source node range to copy
 102
 103         @param rPos
 104         The target copy destination
 105
 106         @param bCheckPos
 107         If this function should check if rPos is in a fly frame anchored in
 108         rPam. If false, then no such check will be performed, and it is assumed
 109         that the caller took care of verifying this constraint already.
 110      */
 111     virtual bool CopyRange(SwPaM& rPam, SwPosition& rPos, const bool bCopyAll, bool bCheckPos ) const = 0;
 112
 113     /** Delete section containing the node.
 114     */
 115     virtual void DeleteSection(SwNode* pNode) = 0;
 116
 117     /** Delete a range SwFlyFrameFormat.
 118     */
 119     virtual bool DeleteRange(SwPaM&) = 0;
 120
 121     /** Delete full paragraphs.
 122     */
 123     virtual bool DelFullPara(SwPaM&) = 0;
 124
 125     /** complete delete of a given PaM
 126
 127         #i100466#
 128         Add optional parameter <bForceJoinNext>, default value <false>
 129         Needed for hiding of deletion redlines
 130     */
 131     virtual bool DeleteAndJoin( SwPaM&,
 132         const bool bForceJoinNext = false ) = 0;
 133
 134     virtual bool MoveRange(SwPaM&, SwPosition&, SwMoveFlags) = 0;
 135
 136     virtual bool MoveNodeRange(SwNodeRange&, SwNodeIndex&, SwMoveFlags) = 0;
 137
 138     /** Move a range.
 139     */
 140     virtual bool MoveAndJoin(SwPaM&, SwPosition&, SwMoveFlags) = 0;
 141
 142     /** Overwrite string in an existing text node.
 143     */
 144     virtual bool Overwrite(const SwPaM &rRg, const OUString& rStr) = 0;
 145
 146     /** Insert string into existing text node at position rRg.Point().
 147      */
 148     virtual bool InsertString(const SwPaM &rRg, const OUString&,
 149               const SwInsertFlags nInsertMode = SwInsertFlags::EMPTYEXPAND ) = 0;
 150
 151     /** change text to Upper/Lower/Hiragana/Katagana/...
 152      */
 153     virtual void TransliterateText(const SwPaM& rPaM, utl::TransliterationWrapper&) = 0;
 154
 155     /** Insert graphic or formula. The XXXX are copied.
 156      */
 157     virtual SwFlyFrameFormat* Insert(const SwPaM &rRg, const OUString& rGrfName, const OUString& rFltName, const Graphic* pGraphic,
 158                         const SfxItemSet* pFlyAttrSet, const SfxItemSet* pGrfAttrSet, SwFrameFormat*) = 0;
 159
 160     virtual SwFlyFrameFormat* Insert(const SwPaM& rRg, const GraphicObject& rGrfObj, const SfxItemSet* pFlyAttrSet,
 161         const SfxItemSet* pGrfAttrSet, SwFrameFormat*) = 0;
 162
 163     /** Transpose graphic (with undo)
 164      */
 165     virtual void ReRead(SwPaM&, const OUString& rGrfName, const OUString& rFltName, const Graphic* pGraphic, const GraphicObject* pGrfObj) = 0;
 166
 167     /** Insert a DrawObject. The object must be already registered
 168         in DrawModel.
 169     */
 170     virtual SwDrawFrameFormat* InsertDrawObj( const SwPaM &rRg, SdrObject& rDrawObj, const SfxItemSet& rFlyAttrSet ) = 0;
 171
 172     /** Insert OLE-objects.
 173     */
 174     virtual SwFlyFrameFormat* Insert(const SwPaM &rRg, const svt::EmbeddedObjectRef& xObj, const SfxItemSet* pFlyAttrSet,
 175         const SfxItemSet* pGrfAttrSet, SwFrameFormat*) = 0;
 176
 177     virtual SwFlyFrameFormat* InsertOLE(const SwPaM &rRg, const OUString& rObjName, sal_Int64 nAspect, const SfxItemSet* pFlyAttrSet,
 178                            const SfxItemSet* pGrfAttrSet, SwFrameFormat*) = 0;
 179
 180     /** Split a node at rPos (implemented only for TextNode).
 181     */
 182     virtual bool SplitNode(const SwPosition &rPos, bool bChkTableStart) = 0;
 183
 184     virtual bool AppendTextNode(SwPosition& rPos) = 0;
 185
 186     /** Replace selected range in a TextNode with string.
 187         Intended for search & replace.
 188         bRegExpRplc - replace tabs (\\t) and insert the found string
 189         ( not \& ). E.g.: Find: "zzz", Replace: "xx\t\\t..&..\&"
 190         --> "xx\t<Tab>..zzz..&"
 191     */
 192     virtual bool ReplaceRange(SwPaM& rPam, const OUString& rNewStr,
 193                               const bool bRegExReplace) = 0;
 194
 195     /** Insert an attribute. If rRg spans several nodes the
 196         attribute is split, provided it makes sense.
 197         Nodes, where this attribute does not make sense are ignored.
 198         In nodes completely enclosed in the selection the attribute
 199         becomes hard-formatted, in all other (text-) nodes the attribute
 200         is inserted into the attribute array.
 201         For a character attribute, in cases where no selection exists
 202         an "empty" hint is inserted. If there is a selection the attribute
 203         is hard-formatted and added to the node at rRg.Start().
 204         If the attribute could not be inserted, the method returns
 205         false.
 206     */
 207     virtual bool InsertPoolItem(const SwPaM &rRg, const SfxPoolItem&,
 208                                 const SetAttrMode nFlags = SetAttrMode::DEFAULT, bool bExpandCharToPara=false) = 0;
 209
 210     virtual bool InsertItemSet (const SwPaM &rRg, const SfxItemSet&,
 211         const SetAttrMode nFlags = SetAttrMode::DEFAULT) = 0;
 212
 213     /** Removes any leading white space from the paragraph
 214     */
 215     virtual void RemoveLeadingWhiteSpace(const SwPosition & rPos ) = 0;
 216
 217 protected:
 218     virtual ~IDocumentContentOperations() {};
 219 };
 220
 221 #endif // INCLUDED_SW_INC_IDOCUMENTCONTENTOPERATIONS_HXX
 222
 223 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */