diff options
Diffstat (limited to 'sw/inc/IDocumentRedlineAccess.hxx')
| -rw-r--r-- | sw/inc/IDocumentRedlineAccess.hxx | 262 |
1 files changed, 262 insertions, 0 deletions
diff --git a/sw/inc/IDocumentRedlineAccess.hxx b/sw/inc/IDocumentRedlineAccess.hxx new file mode 100644 index 000000000000..7cd6bb57059c --- /dev/null +++ b/sw/inc/IDocumentRedlineAccess.hxx @@ -0,0 +1,262 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: IDocumentRedlineAccess.hxx,v $ + * $Revision: 1.6 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + + #ifndef IDOCUMENTREDLINE_HXX_INCLUDED + #define IDOCUMENTREDLINE_HXX_INCLUDED + + #ifndef _SAL_TYPES_H_ + #include <sal/types.h> + #endif + #ifndef _SOLAR_H + #include <tools/solar.h> + #endif + + #include <limits.h> // USHRT_MAX + + #ifndef _COM_SUN_STAR_SEQUENCE_HXX_ + #include <com/sun/star/uno/Sequence.hxx> + #endif + + class SwRedline; + class SwRedlineTbl; + class SwPaM; + struct SwPosition; + class SwStartNode; + class SwNode; + class String; + +typedef USHORT RedlineMode_t; +namespace nsRedlineMode_t +{ + const RedlineMode_t REDLINE_NONE = 0; // no RedlineMode + const RedlineMode_t REDLINE_ON = 0x01;// RedlineMode on + const RedlineMode_t REDLINE_IGNORE = 0x02;// ignore Redlines + const RedlineMode_t REDLINE_SHOW_INSERT = 0x10;// show all inserts + const RedlineMode_t REDLINE_SHOW_DELETE = 0x20;// show all delets + const RedlineMode_t REDLINE_SHOW_MASK = REDLINE_SHOW_INSERT | REDLINE_SHOW_DELETE; + + // fuer die interne Verwaltung: + // die originalen Redlines inclusive des Contents entfernen + // (ClipBoard/Textbausteine) + const RedlineMode_t REDLINE_DELETE_REDLINES = 0x100; + // beim Loeschen innerhalb ein RedlineObjectes, waehrend des Appends, + // das DeleteRedline ignorieren + const RedlineMode_t REDLINE_IGNOREDELETE_REDLINES = 0x200; + // don't combine any readlines. This flags is may only used in the Undo. + const RedlineMode_t REDLINE_DONTCOMBINE_REDLINES = 0x400; +} + +typedef USHORT RedlineType_t; +namespace nsRedlineType_t +{ + // die RedlineTypen gehen von 0 bis 127 + const RedlineType_t REDLINE_INSERT = 0x0;// Inhalt wurde eingefuegt + const RedlineType_t REDLINE_DELETE = 0x1;// Inhalt wurde geloescht + const RedlineType_t REDLINE_FORMAT = 0x2;// Attributierung wurde angewendet + const RedlineType_t REDLINE_TABLE = 0x3;// TabellenStruktur wurde veraendert + const RedlineType_t REDLINE_FMTCOLL = 0x4;// FormatVorlage wurde veraendert (Autoformat!) + + // ab 128 koennen Flags hineinverodert werden + const RedlineType_t REDLINE_NO_FLAG_MASK = 0x7F; + //const RedlineType_t REDLINE_FLAG_MASK = 0xFF80; + const RedlineType_t REDLINE_FORM_AUTOFMT = 0x80;// kann als Flag im RedlineType stehen +} + +/** IDocumentRedlineAccess +*/ +class IDocumentRedlineAccess +{ + // Static helper functions +public: + static bool IsShowChanges(const USHORT eM) + { return (nsRedlineMode_t::REDLINE_SHOW_INSERT | nsRedlineMode_t::REDLINE_SHOW_DELETE) == (eM & nsRedlineMode_t::REDLINE_SHOW_MASK); } + + static bool IsHideChanges(const USHORT eM) + { return nsRedlineMode_t::REDLINE_SHOW_INSERT == (eM & nsRedlineMode_t::REDLINE_SHOW_MASK); } + + static bool IsShowOriginal(const USHORT eM) + { return nsRedlineMode_t::REDLINE_SHOW_DELETE == (eM & nsRedlineMode_t::REDLINE_SHOW_MASK); } + + static bool IsRedlineOn(const USHORT eM) + { return nsRedlineMode_t::REDLINE_ON == (eM & (nsRedlineMode_t::REDLINE_ON | nsRedlineMode_t::REDLINE_IGNORE )); } + +public: + + /************************************************* + Query + *************************************************/ + + /** Query the currently set redline mode + + @returns + the currently set redline mode + */ + virtual RedlineMode_t GetRedlineMode() const = 0; + + /** Set a new redline mode. + + @param eMode + [in] the new redline mode. + */ + virtual void SetRedlineMode_intern(/*[in]*/RedlineMode_t eMode) = 0; + + /** Set a new redline mode. + + @param eMode + [in] the new redline mode. + */ + virtual void SetRedlineMode(/*[in]*/RedlineMode_t eMode) = 0; + + /** Query if redlining is on. + + @returns + </TRUE> if redlining is on </FALSE> otherwise + */ + virtual bool IsRedlineOn() const = 0; + + /** + */ + virtual bool IsIgnoreRedline() const = 0; + + /** + */ + virtual const SwRedlineTbl& GetRedlineTbl() const = 0; + + + /* + */ + virtual bool IsInRedlines(const SwNode& rNode) const = 0; + + /*************************************************** + Manipulation + ***************************************************/ + + /** Append a new redline + + @param pPtr + + @param bCallDelete + + @returns + */ + virtual bool AppendRedline(/*[in]*/SwRedline* pPtr, /*[in]*/bool bCallDelete) = 0; + + /** + */ + virtual bool SplitRedline(/*[in]*/const SwPaM& rPam) = 0; + + /** + */ + virtual bool DeleteRedline( + /*[in]*/const SwPaM& rPam, + /*[in]*/bool bSaveInUndo, + /*[in]*/sal_uInt16 nDelType) = 0; + + /** + */ + virtual bool DeleteRedline( + /*[in]*/const SwStartNode& rSection, + /*[in]*/bool bSaveInUndo, + /*[in]*/sal_uInt16 nDelType) = 0; + + /** + */ + virtual sal_uInt16 GetRedlinePos( + /*[in]*/const SwNode& rNode, + /*[in]*/sal_uInt16 nType) const = 0; + + virtual void CompressRedlines() = 0; + + /** + */ + virtual const SwRedline* GetRedline( + /*[in]*/const SwPosition& rPos, + /*[in]*/sal_uInt16* pFndPos) const = 0; + + /** + */ + virtual bool IsRedlineMove() const = 0; + + /** + */ + virtual void SetRedlineMove(/*[in]*/bool bFlag) = 0; + + /** + */ + virtual bool AcceptRedline(/*[in]*/sal_uInt16 nPos, /*[in]*/bool bCallDelete) = 0; + + /** + */ + virtual bool AcceptRedline(/*[in]*/const SwPaM& rPam, /*[in]*/bool bCallDelete) = 0; + + /** + */ + virtual bool RejectRedline(/*[in]*/sal_uInt16 nPos, /*[in]*/bool bCallDelete) = 0; + + /** + */ + virtual bool RejectRedline(/*[in]*/const SwPaM& rPam, /*[in]*/bool bCallDelete) = 0; + + /** + */ + virtual const SwRedline* SelNextRedline(/*[in]*/SwPaM& rPam) const = 0; + + /** + */ + virtual const SwRedline* SelPrevRedline(/*[in]*/SwPaM& rPam) const = 0; + + // alle Redline invalidieren, die Darstellung hat sich geaendert + virtual void UpdateRedlineAttr() = 0; + + // legt gegebenenfalls einen neuen Author an + virtual sal_uInt16 GetRedlineAuthor() = 0; + + // fuer die Reader usw. - neuen Author in die Tabelle eintragen + virtual sal_uInt16 InsertRedlineAuthor(const String& rAuthor) = 0; + + // Kommentar am Redline an der Position setzen + virtual bool SetRedlineComment( + /*[in]*/const SwPaM& rPam, + /*[in]*/const String& rComment) = 0; + + /** + */ + virtual const ::com::sun::star::uno::Sequence <sal_Int8>& GetRedlinePassword() const = 0; + + /** + */ + virtual void SetRedlinePassword( + /*[in]*/const ::com::sun::star::uno::Sequence <sal_Int8>& rNewPassword) = 0; + + protected: + virtual ~IDocumentRedlineAccess() {}; + }; + + #endif |