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