sw/inc/IDocumentRedlineAccess.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 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <cstddef>
  25
  26 #include <sal/types.h>
  27
  28 #include <com/sun/star/uno/Sequence.h>
  29 #include <o3tl/typed_flags_set.hxx>
  30 #include <svx/ctredlin.hxx>
  31
  32 #include "docary.hxx"
  33
  34 class SwRangeRedline;
  35 class SwTableRowRedline;
  36 class SwTableCellRedline;
  37 class SwPaM;
  38 struct SwPosition;
  39 class SwStartNode;
  40 class SwNode;
  41
  42 enum class RedlineFlags
  43 {
  44     NONE                 = 0x000, ///< no RedlineFlags
  45     On                   = 0x001, ///< RedlineFlags on
  46     Ignore               = 0x002, ///< ignore Redlines
  47     ShowInsert           = 0x010, ///< show all inserts
  48     ShowDelete           = 0x020, ///< show all deletes
  49     ShowMask             = ShowInsert | ShowDelete,
  50
  51     // For internal management:
  52     // remove the original Redlines together with their content
  53     // (Clipboard/text modules).
  54     DeleteRedlines       = 0x100,
  55     // don't combine any redlines. This flag may be only used in Undo.
  56     DontCombineRedlines  = 0x400,
  57 };
  58 namespace o3tl
  59 {
  60     template<> struct typed_flags<RedlineFlags> : is_typed_flags<RedlineFlags, 0x533> {};
  61 }
  62
  63 inline OUString SwRedlineTypeToOUString(RedlineType eType)
  64 {
  65     OUString sRet;
  66     switch(eType)
  67     {
  68         case RedlineType::Insert: sRet = "Insert"; break;
  69         case RedlineType::Delete: sRet = "Delete"; break;
  70         case RedlineType::Format: sRet = "Format"; break;
  71         case RedlineType::ParagraphFormat: sRet = "ParagraphFormat"; break;
  72         case RedlineType::Table:  sRet = "TextTable"; break;
  73         case RedlineType::FmtColl:sRet = "Style"; break;
  74         default: break;
  75     }
  76     return sRet;
  77 };
  78
  79 class IDocumentRedlineAccess
  80 {
  81      // Static helper functions
  82 public:
  83     static bool IsShowChanges(const RedlineFlags eM)
  84     { return (RedlineFlags::ShowInsert | RedlineFlags::ShowDelete) == (eM & RedlineFlags::ShowMask); }
  85
  86     static bool IsHideChanges(const RedlineFlags eM)
  87     { return RedlineFlags::ShowInsert == (eM & RedlineFlags::ShowMask); }
  88
  89     static bool IsShowOriginal(const RedlineFlags eM)
  90     { return RedlineFlags::ShowDelete == (eM & RedlineFlags::ShowMask); }
  91
  92     static bool IsRedlineOn(const RedlineFlags eM)
  93     { return RedlineFlags::On == (eM & (RedlineFlags::On | RedlineFlags::Ignore )); }
  94
  95 public:
  96
  97     /** Query the currently set redline mode
  98
  99         @returns
 100         the currently set redline mode
 101     */
 102      virtual RedlineFlags GetRedlineFlags() const = 0;
 103
 104     /** Set a new redline mode.
 105
 106         @param eMode
 107         [in] the new redline mode.
 108     */
 109     virtual void SetRedlineFlags_intern(/*[in]*/RedlineFlags eMode) = 0;
 110
 111     /** Set a new redline mode.
 112
 113         @param eMode
 114         [in] the new redline mode.
 115     */
 116     virtual void SetRedlineFlags(/*[in]*/RedlineFlags eMode) = 0;
 117
 118     /** Query if redlining is on.
 119
 120         @returns
 121         <TRUE/> if redlining is on <FALSE/> otherwise
 122     */
 123     virtual bool IsRedlineOn() const = 0;
 124
 125     virtual bool IsIgnoreRedline() const = 0;
 126
 127     virtual const SwRedlineTable& GetRedlineTable() const = 0;
 128     virtual SwRedlineTable& GetRedlineTable() = 0;
 129     virtual const SwExtraRedlineTable& GetExtraRedlineTable() const = 0;
 130     virtual SwExtraRedlineTable& GetExtraRedlineTable() = 0;
 131
 132     virtual bool IsInRedlines(const SwNode& rNode) const = 0;
 133
 134     enum class AppendResult { IGNORED, MERGED, APPENDED };
 135     /** Append a new redline
 136
 137         @param pNewRedl redline to insert
 138
 139         @param bCallDelete
 140             if set, then for a new DELETE redline that is inserted so that it
 141             overlaps an existing INSERT redline with the same author, the
 142             overlapping range is deleted, i.e. the new DELETE removes
 143             existing INSERT for that range
 144
 145         @returns
 146             APPENDED if pNewRedl is still alive and was appended
 147             MERGED if pNewRedl was deleted but has been merged with existing one
 148             IGNORED if pNewRedl was deleted and ignored/invalid
 149     */
 150     virtual AppendResult AppendRedline(/*[in]*/SwRangeRedline* pNewRedl, /*[in]*/bool bCallDelete) = 0;
 151
 152     virtual bool AppendTableRowRedline(/*[in]*/SwTableRowRedline* pPtr) = 0;
 153     virtual bool AppendTableCellRedline(/*[in]*/SwTableCellRedline* pPtr) = 0;
 154
 155     virtual bool SplitRedline(/*[in]*/const SwPaM& rPam) = 0;
 156
 157     virtual bool DeleteRedline(
 158         /*[in]*/const SwPaM& rPam,
 159         /*[in]*/bool bSaveInUndo,
 160         /*[in]*/RedlineType nDelType) = 0;
 161
 162     virtual bool DeleteRedline(
 163         /*[in]*/const SwStartNode& rSection,
 164         /*[in]*/bool bSaveInUndo,
 165         /*[in]*/RedlineType nDelType) = 0;
 166
 167     virtual SwRedlineTable::size_type GetRedlinePos(
 168         /*[in]*/const SwNode& rNode,
 169         /*[in]*/RedlineType nType) const = 0;
 170
 171     virtual bool HasRedline(
 172         /*[in]*/const SwPaM& rPam,
 173         /*[in]*/RedlineType nType,
 174         /*[in]*/bool bStartOrEndInRange) const = 0;
 175
 176     virtual void CompressRedlines(size_t nStartIndex = 0) = 0;
 177
 178     virtual const SwRangeRedline* GetRedline(
 179         /*[in]*/const SwPosition& rPos,
 180         /*[in]*/SwRedlineTable::size_type* pFndPos) const = 0;
 181
 182     virtual bool IsRedlineMove() const = 0;
 183
 184     virtual void SetRedlineMove(/*[in]*/bool bFlag) = 0;
 185
 186     virtual bool AcceptRedline(/*[in]*/SwRedlineTable::size_type nPos, /*[in]*/bool bCallDelete) = 0;
 187
 188     virtual bool AcceptRedline(/*[in]*/const SwPaM& rPam, /*[in]*/bool bCallDelete) = 0;
 189
 190     virtual void AcceptRedlineParagraphFormatting(/*[in]*/const SwPaM& rPam ) = 0;
 191
 192     virtual bool RejectRedline(/*[in]*/SwRedlineTable::size_type nPos, /*[in]*/bool bCallDelete) = 0;
 193
 194     virtual bool RejectRedline(/*[in]*/const SwPaM& rPam, /*[in]*/bool bCallDelete) = 0;
 195
 196     virtual const SwRangeRedline* SelNextRedline(/*[in]*/SwPaM& rPam) const = 0;
 197
 198     virtual const SwRangeRedline* SelPrevRedline(/*[in]*/SwPaM& rPam) const = 0;
 199
 200     virtual void AcceptAllRedline(/*[in]*/bool bAcceptReject) = 0;
 201
 202     // Representation has changed, invalidate all Redlines.
 203     virtual void UpdateRedlineAttr() = 0;
 204
 205     // Create a new Author if required.
 206     virtual std::size_t GetRedlineAuthor() = 0;
 207
 208     // For Readers etc.: register new Author in table.
 209     virtual std::size_t InsertRedlineAuthor(const OUString& rAuthor) = 0;
 210
 211     // Place a comment at Redline at given position.
 212     virtual bool SetRedlineComment(
 213         /*[in]*/const SwPaM& rPam,
 214         /*[in]*/const OUString& rComment) = 0;
 215
 216     virtual const css::uno::Sequence <sal_Int8>& GetRedlinePassword() const = 0;
 217
 218     virtual void SetRedlinePassword(
 219         /*[in]*/const css::uno::Sequence <sal_Int8>& rNewPassword) = 0;
 220
 221 protected:
 222      virtual ~IDocumentRedlineAccess() {};
 223 };
 224
 225 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */