/************************************************************************* * * $RCSfile: IDocumentRedlineAccess.hxx,v $ * * $Revision: 1.2 $ * * last change: $Author: hr $ $Date: 2006-08-14 15:13:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef IDOCUMENTREDLINE_HXX_INCLUDED #define IDOCUMENTREDLINE_HXX_INCLUDED #ifndef _SAL_TYPES_H_ #include #endif #ifndef _SOLAR_H #include #endif #include // USHRT_MAX #ifndef _COM_SUN_STAR_SEQUENCE_HXX_ #include #endif class SwRedline; class SwRedlineTbl; class SwPaM; struct SwPosition; class SwStartNode; class SwNode; class String; /** IDocumentRedlineAccess */ class IDocumentRedlineAccess { public: typedef int RedlineMode_t; static const RedlineMode_t REDLINE_NONE = 0;// no RedlineMode static const RedlineMode_t REDLINE_ON = 0x01;// RedlineMode on static const RedlineMode_t REDLINE_IGNORE = 0x02;// ignore Redlines static const RedlineMode_t REDLINE_SHOW_INSERT = 0x10;// show all inserts static const RedlineMode_t REDLINE_SHOW_DELETE = 0x20;// show all delets static 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) static const RedlineMode_t REDLINE_DELETE_REDLINES = 0x100; // beim Loeschen innerhalb ein RedlineObjectes, waehrend des Appends, // das DeleteRedline ignorieren static const RedlineMode_t REDLINE_IGNOREDELETE_REDLINES = 0x200; // don't combine any readlines. This flags is may only used in the Undo. static const RedlineMode_t REDLINE_DONTCOMBINE_REDLINES = 0x400; typedef int RedlineType_t; // die RedlineTypen gehen von 0 bis 127 static const RedlineType_t REDLINE_INSERT = 0x0;// Inhalt wurde eingefuegt static const RedlineType_t REDLINE_DELETE = 0x1;// Inhalt wurde geloescht static const RedlineType_t REDLINE_FORMAT = 0x2;// Attributierung wurde angewendet static const RedlineType_t REDLINE_TABLE = 0x3;// TabellenStruktur wurde veraendert static const RedlineType_t REDLINE_FMTCOLL = 0x4;// FormatVorlage wurde veraendert (Autoformat!) // ab 128 koennen Flags hineinverodert werden static const RedlineType_t REDLINE_NO_FLAG_MASK = 0x7F; static const RedlineType_t REDLINE_FLAG_MASK = 0xFF80; static const RedlineType_t REDLINE_FORM_AUTOFMT = 0x80;// kann als Flag im RedlineType stehen // Static helper functions public: static int IsShowChanges(const USHORT eM) { return (REDLINE_SHOW_INSERT | REDLINE_SHOW_DELETE) == (eM & REDLINE_SHOW_MASK); } static int IsHideChanges(const USHORT eM) { return REDLINE_SHOW_INSERT == (eM & REDLINE_SHOW_MASK); } static int IsShowOriginal(const USHORT eM) { return REDLINE_SHOW_DELETE == (eM & REDLINE_SHOW_MASK); } static int IsRedlineOn(const USHORT eM) { return REDLINE_ON == (eM & (REDLINE_ON | 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 if redlining is on 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 & GetRedlinePassword() const = 0; /** */ virtual void SetRedlinePassword( /*[in]*/const ::com::sun::star::uno::Sequence & rNewPassword) = 0; protected: virtual ~IDocumentRedlineAccess() {}; }; #endif