1*1d2dbeb0SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*1d2dbeb0SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*1d2dbeb0SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*1d2dbeb0SAndrew Rist * distributed with this work for additional information 6*1d2dbeb0SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*1d2dbeb0SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*1d2dbeb0SAndrew Rist * "License"); you may not use this file except in compliance 9*1d2dbeb0SAndrew Rist * with the License. You may obtain a copy of the License at 10*1d2dbeb0SAndrew Rist * 11*1d2dbeb0SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*1d2dbeb0SAndrew Rist * 13*1d2dbeb0SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*1d2dbeb0SAndrew Rist * software distributed under the License is distributed on an 15*1d2dbeb0SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*1d2dbeb0SAndrew Rist * KIND, either express or implied. See the License for the 17*1d2dbeb0SAndrew Rist * specific language governing permissions and limitations 18*1d2dbeb0SAndrew Rist * under the License. 19*1d2dbeb0SAndrew Rist * 20*1d2dbeb0SAndrew Rist *************************************************************/ 21*1d2dbeb0SAndrew Rist 22*1d2dbeb0SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef IDOCUMENTREDLINE_HXX_INCLUDED 25cdf0e10cSrcweir #define IDOCUMENTREDLINE_HXX_INCLUDED 26cdf0e10cSrcweir 27cdf0e10cSrcweir #ifndef _SAL_TYPES_H_ 28cdf0e10cSrcweir #include <sal/types.h> 29cdf0e10cSrcweir #endif 30cdf0e10cSrcweir #ifndef _SOLAR_H 31cdf0e10cSrcweir #include <tools/solar.h> 32cdf0e10cSrcweir #endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir #include <limits.h> // USHRT_MAX 35cdf0e10cSrcweir 36cdf0e10cSrcweir #ifndef _COM_SUN_STAR_SEQUENCE_HXX_ 37cdf0e10cSrcweir #include <com/sun/star/uno/Sequence.hxx> 38cdf0e10cSrcweir #endif 39cdf0e10cSrcweir 40cdf0e10cSrcweir class SwRedline; 41cdf0e10cSrcweir class SwRedlineTbl; 42cdf0e10cSrcweir class SwPaM; 43cdf0e10cSrcweir struct SwPosition; 44cdf0e10cSrcweir class SwStartNode; 45cdf0e10cSrcweir class SwNode; 46cdf0e10cSrcweir class String; 47cdf0e10cSrcweir 48cdf0e10cSrcweir typedef sal_uInt16 RedlineMode_t; 49cdf0e10cSrcweir namespace nsRedlineMode_t 50cdf0e10cSrcweir { 51cdf0e10cSrcweir const RedlineMode_t REDLINE_NONE = 0; // no RedlineMode 52cdf0e10cSrcweir const RedlineMode_t REDLINE_ON = 0x01;// RedlineMode on 53cdf0e10cSrcweir const RedlineMode_t REDLINE_IGNORE = 0x02;// ignore Redlines 54cdf0e10cSrcweir const RedlineMode_t REDLINE_SHOW_INSERT = 0x10;// show all inserts 55cdf0e10cSrcweir const RedlineMode_t REDLINE_SHOW_DELETE = 0x20;// show all delets 56cdf0e10cSrcweir const RedlineMode_t REDLINE_SHOW_MASK = REDLINE_SHOW_INSERT | REDLINE_SHOW_DELETE; 57cdf0e10cSrcweir 58cdf0e10cSrcweir // fuer die interne Verwaltung: 59cdf0e10cSrcweir // die originalen Redlines inclusive des Contents entfernen 60cdf0e10cSrcweir // (ClipBoard/Textbausteine) 61cdf0e10cSrcweir const RedlineMode_t REDLINE_DELETE_REDLINES = 0x100; 62cdf0e10cSrcweir // beim Loeschen innerhalb ein RedlineObjectes, waehrend des Appends, 63cdf0e10cSrcweir // das DeleteRedline ignorieren 64cdf0e10cSrcweir const RedlineMode_t REDLINE_IGNOREDELETE_REDLINES = 0x200; 65cdf0e10cSrcweir // don't combine any readlines. This flags is may only used in the Undo. 66cdf0e10cSrcweir const RedlineMode_t REDLINE_DONTCOMBINE_REDLINES = 0x400; 67cdf0e10cSrcweir } 68cdf0e10cSrcweir 69cdf0e10cSrcweir typedef sal_uInt16 RedlineType_t; 70cdf0e10cSrcweir namespace nsRedlineType_t 71cdf0e10cSrcweir { 72cdf0e10cSrcweir // die RedlineTypen gehen von 0 bis 127 73cdf0e10cSrcweir const RedlineType_t REDLINE_INSERT = 0x0;// Inhalt wurde eingefuegt 74cdf0e10cSrcweir const RedlineType_t REDLINE_DELETE = 0x1;// Inhalt wurde geloescht 75cdf0e10cSrcweir const RedlineType_t REDLINE_FORMAT = 0x2;// Attributierung wurde angewendet 76cdf0e10cSrcweir const RedlineType_t REDLINE_TABLE = 0x3;// TabellenStruktur wurde veraendert 77cdf0e10cSrcweir const RedlineType_t REDLINE_FMTCOLL = 0x4;// FormatVorlage wurde veraendert (Autoformat!) 78cdf0e10cSrcweir 79cdf0e10cSrcweir // ab 128 koennen Flags hineinverodert werden 80cdf0e10cSrcweir const RedlineType_t REDLINE_NO_FLAG_MASK = 0x7F; 81cdf0e10cSrcweir //const RedlineType_t REDLINE_FLAG_MASK = 0xFF80; 82cdf0e10cSrcweir const RedlineType_t REDLINE_FORM_AUTOFMT = 0x80;// kann als Flag im RedlineType stehen 83cdf0e10cSrcweir } 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** IDocumentRedlineAccess 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir class IDocumentRedlineAccess 88cdf0e10cSrcweir { 89cdf0e10cSrcweir // Static helper functions 90cdf0e10cSrcweir public: IsShowChanges(const sal_uInt16 eM)91cdf0e10cSrcweir static bool IsShowChanges(const sal_uInt16 eM) 92cdf0e10cSrcweir { return (nsRedlineMode_t::REDLINE_SHOW_INSERT | nsRedlineMode_t::REDLINE_SHOW_DELETE) == (eM & nsRedlineMode_t::REDLINE_SHOW_MASK); } 93cdf0e10cSrcweir IsHideChanges(const sal_uInt16 eM)94cdf0e10cSrcweir static bool IsHideChanges(const sal_uInt16 eM) 95cdf0e10cSrcweir { return nsRedlineMode_t::REDLINE_SHOW_INSERT == (eM & nsRedlineMode_t::REDLINE_SHOW_MASK); } 96cdf0e10cSrcweir IsShowOriginal(const sal_uInt16 eM)97cdf0e10cSrcweir static bool IsShowOriginal(const sal_uInt16 eM) 98cdf0e10cSrcweir { return nsRedlineMode_t::REDLINE_SHOW_DELETE == (eM & nsRedlineMode_t::REDLINE_SHOW_MASK); } 99cdf0e10cSrcweir IsRedlineOn(const sal_uInt16 eM)100cdf0e10cSrcweir static bool IsRedlineOn(const sal_uInt16 eM) 101cdf0e10cSrcweir { return nsRedlineMode_t::REDLINE_ON == (eM & (nsRedlineMode_t::REDLINE_ON | nsRedlineMode_t::REDLINE_IGNORE )); } 102cdf0e10cSrcweir 103cdf0e10cSrcweir public: 104cdf0e10cSrcweir 105cdf0e10cSrcweir /************************************************* 106cdf0e10cSrcweir Query 107cdf0e10cSrcweir *************************************************/ 108cdf0e10cSrcweir 109cdf0e10cSrcweir /** Query the currently set redline mode 110cdf0e10cSrcweir 111cdf0e10cSrcweir @returns 112cdf0e10cSrcweir the currently set redline mode 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir virtual RedlineMode_t GetRedlineMode() const = 0; 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** Set a new redline mode. 117cdf0e10cSrcweir 118cdf0e10cSrcweir @param eMode 119cdf0e10cSrcweir [in] the new redline mode. 120cdf0e10cSrcweir */ 121cdf0e10cSrcweir virtual void SetRedlineMode_intern(/*[in]*/RedlineMode_t eMode) = 0; 122cdf0e10cSrcweir 123cdf0e10cSrcweir /** Set a new redline mode. 124cdf0e10cSrcweir 125cdf0e10cSrcweir @param eMode 126cdf0e10cSrcweir [in] the new redline mode. 127cdf0e10cSrcweir */ 128cdf0e10cSrcweir virtual void SetRedlineMode(/*[in]*/RedlineMode_t eMode) = 0; 129cdf0e10cSrcweir 130cdf0e10cSrcweir /** Query if redlining is on. 131cdf0e10cSrcweir 132cdf0e10cSrcweir @returns 133cdf0e10cSrcweir <TRUE/> if redlining is on <FALSE/> otherwise 134cdf0e10cSrcweir */ 135cdf0e10cSrcweir virtual bool IsRedlineOn() const = 0; 136cdf0e10cSrcweir 137cdf0e10cSrcweir /** 138cdf0e10cSrcweir */ 139cdf0e10cSrcweir virtual bool IsIgnoreRedline() const = 0; 140cdf0e10cSrcweir 141cdf0e10cSrcweir /** 142cdf0e10cSrcweir */ 143cdf0e10cSrcweir virtual const SwRedlineTbl& GetRedlineTbl() const = 0; 144cdf0e10cSrcweir 145cdf0e10cSrcweir 146cdf0e10cSrcweir /* 147cdf0e10cSrcweir */ 148cdf0e10cSrcweir virtual bool IsInRedlines(const SwNode& rNode) const = 0; 149cdf0e10cSrcweir 150cdf0e10cSrcweir /*************************************************** 151cdf0e10cSrcweir Manipulation 152cdf0e10cSrcweir ***************************************************/ 153cdf0e10cSrcweir 154cdf0e10cSrcweir /** Append a new redline 155cdf0e10cSrcweir 156cdf0e10cSrcweir @param pPtr 157cdf0e10cSrcweir 158cdf0e10cSrcweir @param bCallDelete 159cdf0e10cSrcweir 160cdf0e10cSrcweir @returns 161cdf0e10cSrcweir */ 162cdf0e10cSrcweir virtual bool AppendRedline(/*[in]*/SwRedline* pPtr, /*[in]*/bool bCallDelete) = 0; 163cdf0e10cSrcweir 164cdf0e10cSrcweir /** 165cdf0e10cSrcweir */ 166cdf0e10cSrcweir virtual bool SplitRedline(/*[in]*/const SwPaM& rPam) = 0; 167cdf0e10cSrcweir 168cdf0e10cSrcweir /** 169cdf0e10cSrcweir */ 170cdf0e10cSrcweir virtual bool DeleteRedline( 171cdf0e10cSrcweir /*[in]*/const SwPaM& rPam, 172cdf0e10cSrcweir /*[in]*/bool bSaveInUndo, 173cdf0e10cSrcweir /*[in]*/sal_uInt16 nDelType) = 0; 174cdf0e10cSrcweir 175cdf0e10cSrcweir /** 176cdf0e10cSrcweir */ 177cdf0e10cSrcweir virtual bool DeleteRedline( 178cdf0e10cSrcweir /*[in]*/const SwStartNode& rSection, 179cdf0e10cSrcweir /*[in]*/bool bSaveInUndo, 180cdf0e10cSrcweir /*[in]*/sal_uInt16 nDelType) = 0; 181cdf0e10cSrcweir 182cdf0e10cSrcweir /** 183cdf0e10cSrcweir */ 184cdf0e10cSrcweir virtual sal_uInt16 GetRedlinePos( 185cdf0e10cSrcweir /*[in]*/const SwNode& rNode, 186cdf0e10cSrcweir /*[in]*/sal_uInt16 nType) const = 0; 187cdf0e10cSrcweir 188cdf0e10cSrcweir virtual void CompressRedlines() = 0; 189cdf0e10cSrcweir 190cdf0e10cSrcweir /** 191cdf0e10cSrcweir */ 192cdf0e10cSrcweir virtual const SwRedline* GetRedline( 193cdf0e10cSrcweir /*[in]*/const SwPosition& rPos, 194cdf0e10cSrcweir /*[in]*/sal_uInt16* pFndPos) const = 0; 195cdf0e10cSrcweir 196cdf0e10cSrcweir /** 197cdf0e10cSrcweir */ 198cdf0e10cSrcweir virtual bool IsRedlineMove() const = 0; 199cdf0e10cSrcweir 200cdf0e10cSrcweir /** 201cdf0e10cSrcweir */ 202cdf0e10cSrcweir virtual void SetRedlineMove(/*[in]*/bool bFlag) = 0; 203cdf0e10cSrcweir 204cdf0e10cSrcweir /** 205cdf0e10cSrcweir */ 206cdf0e10cSrcweir virtual bool AcceptRedline(/*[in]*/sal_uInt16 nPos, /*[in]*/bool bCallDelete) = 0; 207cdf0e10cSrcweir 208cdf0e10cSrcweir /** 209cdf0e10cSrcweir */ 210cdf0e10cSrcweir virtual bool AcceptRedline(/*[in]*/const SwPaM& rPam, /*[in]*/bool bCallDelete) = 0; 211cdf0e10cSrcweir 212cdf0e10cSrcweir /** 213cdf0e10cSrcweir */ 214cdf0e10cSrcweir virtual bool RejectRedline(/*[in]*/sal_uInt16 nPos, /*[in]*/bool bCallDelete) = 0; 215cdf0e10cSrcweir 216cdf0e10cSrcweir /** 217cdf0e10cSrcweir */ 218cdf0e10cSrcweir virtual bool RejectRedline(/*[in]*/const SwPaM& rPam, /*[in]*/bool bCallDelete) = 0; 219cdf0e10cSrcweir 220cdf0e10cSrcweir /** 221cdf0e10cSrcweir */ 222cdf0e10cSrcweir virtual const SwRedline* SelNextRedline(/*[in]*/SwPaM& rPam) const = 0; 223cdf0e10cSrcweir 224cdf0e10cSrcweir /** 225cdf0e10cSrcweir */ 226cdf0e10cSrcweir virtual const SwRedline* SelPrevRedline(/*[in]*/SwPaM& rPam) const = 0; 227cdf0e10cSrcweir 228cdf0e10cSrcweir // alle Redline invalidieren, die Darstellung hat sich geaendert 229cdf0e10cSrcweir virtual void UpdateRedlineAttr() = 0; 230cdf0e10cSrcweir 231cdf0e10cSrcweir // legt gegebenenfalls einen neuen Author an 232cdf0e10cSrcweir virtual sal_uInt16 GetRedlineAuthor() = 0; 233cdf0e10cSrcweir 234cdf0e10cSrcweir // fuer die Reader usw. - neuen Author in die Tabelle eintragen 235cdf0e10cSrcweir virtual sal_uInt16 InsertRedlineAuthor(const String& rAuthor) = 0; 236cdf0e10cSrcweir 237cdf0e10cSrcweir // Kommentar am Redline an der Position setzen 238cdf0e10cSrcweir virtual bool SetRedlineComment( 239cdf0e10cSrcweir /*[in]*/const SwPaM& rPam, 240cdf0e10cSrcweir /*[in]*/const String& rComment) = 0; 241cdf0e10cSrcweir 242cdf0e10cSrcweir /** 243cdf0e10cSrcweir */ 244cdf0e10cSrcweir virtual const ::com::sun::star::uno::Sequence <sal_Int8>& GetRedlinePassword() const = 0; 245cdf0e10cSrcweir 246cdf0e10cSrcweir /** 247cdf0e10cSrcweir */ 248cdf0e10cSrcweir virtual void SetRedlinePassword( 249cdf0e10cSrcweir /*[in]*/const ::com::sun::star::uno::Sequence <sal_Int8>& rNewPassword) = 0; 250cdf0e10cSrcweir 251cdf0e10cSrcweir protected: ~IDocumentRedlineAccess()252cdf0e10cSrcweir virtual ~IDocumentRedlineAccess() {}; 253cdf0e10cSrcweir }; 254cdf0e10cSrcweir 255cdf0e10cSrcweir #endif 256