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