office-gobmx/sw/inc/redline.hxx
2004-05-25 15:22:43 +00:00

329 lines
12 KiB
C++

/*************************************************************************
*
* $RCSfile: redline.hxx,v $
*
* $Revision: 1.6 $
*
* last change: $Author: rt $ $Date: 2004-05-25 16:21:38 $
*
* 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 _REDLINE_HXX
#define _REDLINE_HXX
#ifndef _DATETIME_HXX //autogen
#include <tools/datetime.hxx>
#endif
#ifndef _STRING_HXX //autogen
#include <tools/string.hxx>
#endif
#define _SVSTDARR_USHORTS
#include <svtools/svstdarr.hxx>
#ifndef _PAM_HXX
#include <pam.hxx>
#endif
#ifndef _REDLENUM_HXX
#include <redlenum.hxx>
#endif
class SfxItemSet;
class SwRedlineExtraData
{
SwRedlineExtraData( const SwRedlineExtraData& );
SwRedlineExtraData& operator=( const SwRedlineExtraData& );
protected:
SwRedlineExtraData() {}
public:
virtual ~SwRedlineExtraData();
virtual SwRedlineExtraData* CreateNew() const = 0;
virtual void Accept( SwPaM& rPam ) const;
virtual void Reject( SwPaM& rPam ) const;
virtual int operator == ( const SwRedlineExtraData& ) const;
};
class SwRedlineExtraData_FmtColl : public SwRedlineExtraData
{
String sFmtNm;
SfxItemSet* pSet;
USHORT nPoolId;
public:
SwRedlineExtraData_FmtColl( const String& rColl, USHORT nPoolFmtId,
const SfxItemSet* pSet = 0 );
virtual ~SwRedlineExtraData_FmtColl();
virtual SwRedlineExtraData* CreateNew() const;
virtual void Reject( SwPaM& rPam ) const;
virtual int operator == ( const SwRedlineExtraData& ) const;
void SetItemSet( const SfxItemSet& rSet );
};
class SwRedlineExtraData_Format : public SwRedlineExtraData
{
SvUShorts aWhichIds;
SwRedlineExtraData_Format( const SwRedlineExtraData_Format& rCpy );
public:
SwRedlineExtraData_Format( const SfxItemSet& rSet );
virtual ~SwRedlineExtraData_Format();
virtual SwRedlineExtraData* CreateNew() const;
virtual void Reject( SwPaM& rPam ) const;
virtual int operator == ( const SwRedlineExtraData& ) const;
};
class SwRedlineData
{
friend class SwRedline;
SwRedlineData* pNext; // Verweis auf weitere Daten
SwRedlineExtraData* pExtraData;
String sComment;
DateTime aStamp;
SwRedlineType eType;
USHORT nAuthor, nSeqNo;
public:
SwRedlineData( SwRedlineType eT, USHORT nAut );
SwRedlineData( const SwRedlineData& rCpy, BOOL bCpyNext = TRUE );
// fuer sw3io: pNext/pExtraData gehen in eigenen Besitz ueber!
SwRedlineData( SwRedlineType eT, USHORT nAut, const DateTime& rDT,
const String& rCmnt, SwRedlineData* pNxt,
SwRedlineExtraData* pExtraData = 0 );
~SwRedlineData();
int operator==( const SwRedlineData& rCmp ) const
{
return nAuthor == rCmp.nAuthor &&
eType == rCmp.eType &&
sComment == rCmp.sComment &&
(( !pNext && !rCmp.pNext ) ||
( pNext && rCmp.pNext && *pNext == *rCmp.pNext )) &&
(( !pExtraData && !rCmp.pExtraData ) ||
( pExtraData && rCmp.pExtraData &&
*pExtraData == *rCmp.pExtraData ));
}
int operator!=( const SwRedlineData& rCmp ) const
{ return !operator==( rCmp ); }
SwRedlineType GetType() const
{ return SwRedlineType( eType & REDLINE_NO_FLAG_MASK); }
SwRedlineType GetRealType() const { return eType; }
USHORT GetAuthor() const { return nAuthor; }
const String& GetComment() const { return sComment; }
const DateTime& GetTimeStamp() const { return aStamp; }
inline const SwRedlineData* Next() const{ return pNext; }
void SetTimeStamp( const DateTime& rDT)
{ aStamp = rDT; aStamp.SetSec( 0 ); aStamp.Set100Sec( 0 ); }
void SetComment( const String& rS ) { sComment = rS; }
void SetAutoFmtFlag()
{ eType = SwRedlineType( eType | REDLINE_FORM_AUTOFMT ); }
int CanCombine( const SwRedlineData& rCmp ) const
{
return nAuthor == rCmp.nAuthor &&
eType == rCmp.eType &&
sComment == rCmp.sComment &&
GetTimeStamp() == rCmp.GetTimeStamp() &&
(( !pNext && !rCmp.pNext ) ||
( pNext && rCmp.pNext &&
pNext->CanCombine( *rCmp.pNext ))) &&
(( !pExtraData && !rCmp.pExtraData ) ||
( pExtraData && rCmp.pExtraData &&
*pExtraData == *rCmp.pExtraData ));
}
// ExtraData wird kopiert, der Pointer geht also NICHT in den Besitz
// des RedlineObjectes!
void SetExtraData( const SwRedlineExtraData* pData );
const SwRedlineExtraData* GetExtraData() const { return pExtraData; }
// fuers UI-seitige zusammenfassen von Redline-Actionen. Wird z.Z. nur
// fuers Autoformat mit Redline benoetigt. Der Wert != 0 bedeutet dabei,
// das es noch weitere geben kann!
USHORT GetSeqNo() const { return nSeqNo; }
void SetSeqNo( USHORT nNo ) { nSeqNo = nNo; }
String GetDescr() const;
};
class SwRedline : public SwPaM
{
SwRedlineData* pRedlineData;
SwNodeIndex* pCntntSect;
BOOL bDelLastPara : 1;
BOOL bIsLastParaDelete : 1;
BOOL bIsVisible : 1;
void MoveToSection();
void CopyToSection();
void DelCopyOfSection();
void MoveFromSection();
public:
SwRedline( SwRedlineType eType, const SwPaM& rPam );
SwRedline( SwRedlineType eTyp, const SwPosition& rPos );
SwRedline( const SwRedlineData& rData, const SwPaM& rPam );
SwRedline( const SwRedlineData& rData, const SwPosition& rPos );
// fuer sw3io: pData geht in eigenen Besitz ueber!
SwRedline(SwRedlineData* pData, const SwPosition& rPos, BOOL bVsbl,
BOOL bDelLP, BOOL bIsPD) :
SwPaM( rPos ), pRedlineData( pData ), pCntntSect( 0 ),
bDelLastPara( bDelLP ), bIsLastParaDelete( bIsPD ), bIsVisible( bVsbl )
{}
SwRedline( const SwRedline& );
virtual ~SwRedline();
SwNodeIndex* GetContentIdx() const { return pCntntSect; }
// fuers Undo
void SetContentIdx( const SwNodeIndex* );
BOOL IsVisible() const { return bIsVisible; }
BOOL IsDelLastPara() const { return bDelLastPara; }
BOOL IsLastParaDelete() const { return bIsLastParaDelete; }
// das BOOL besagt, ob nach dem setzen der Pos kein Bereich mehr
// aufgespannt ist. -> TRUE, ansonten Bereich und FALSE
void SetStart( const SwPosition& rPos, SwPosition* pSttPtr = 0 )
{
if( !pSttPtr ) pSttPtr = Start();
*pSttPtr = rPos;
}
void SetEnd( const SwPosition& rPos, SwPosition* pEndPtr = 0 )
{
if( !pEndPtr ) pEndPtr = End();
*pEndPtr = rPos;
}
// liegt eine gueltige Selektion vor?
BOOL HasValidRange() const;
const SwRedlineData& GetRedlineData(USHORT nPos = 0) const;
int operator==( const SwRedlineData& rCmp ) const
{ return *pRedlineData == rCmp; }
int operator!=( const SwRedlineData& rCmp ) const
{ return *pRedlineData != rCmp; }
void SetAutoFmtFlag() { pRedlineData->SetAutoFmtFlag(); }
USHORT GetStackCount() const;
USHORT GetAuthor( USHORT nPos = 0) const;
const String& GetAuthorString( USHORT nPos = 0 ) const;
const DateTime& GetTimeStamp( USHORT nPos = 0) const;
SwRedlineType GetRealType( USHORT nPos = 0 ) const;
SwRedlineType GetType( USHORT nPos = 0) const
{ return SwRedlineType( GetRealType( nPos ) & REDLINE_NO_FLAG_MASK); }
const String& GetComment( USHORT nPos = 0 ) const;
void SetComment( const String& rS ) { pRedlineData->SetComment( rS ); }
// ExtraData wird kopiert, der Pointer geht also NICHT in den Besitz
// des RedlineObjectes!
void SetExtraData( const SwRedlineExtraData* pData )
{ pRedlineData->SetExtraData( pData ); }
const SwRedlineExtraData* GetExtraData() const
{ return pRedlineData->GetExtraData(); }
// fuers UI-seitige zusammenfassen von Redline-Actionen. Wird z.Z. nur
// fuers Autoformat mit Redline benoetigt. Der Wert != 0 bedeutet dabei,
// das es noch weitere geben kann!
USHORT GetSeqNo() const { return pRedlineData->GetSeqNo(); }
void SetSeqNo( USHORT nNo ) { pRedlineData->SetSeqNo( nNo ); }
// Beim Hide/ShowOriginal wird 2 mal ueber die Liste gelaufen, damit
// die Del-Redlines per Copy und Delete versteckt werden. Beim Move
// wird sonst die Attributierung falsch behandelt.
// Alle anderen Aufrufer muessen immer 0 angeben.
void CallDisplayFunc( USHORT nLoop = 0 );
void Show( USHORT nLoop = 0 );
void Hide( USHORT nLoop = 0 );
void ShowOriginal( USHORT nLoop = 0 );
// calculates the intersection with text node number nNdIdx
void CalcStartEnd( USHORT nNdIdx, USHORT& nStart, USHORT& nEnd ) const;
void InvalidateRange(); // das Layout anstossen
BOOL IsOwnRedline( const SwRedline& rRedl ) const
{ return GetAuthor() == rRedl.GetAuthor(); }
BOOL CanCombine( const SwRedline& rRedl ) const;
void PushData( const SwRedline& rRedl, BOOL bOwnAsNext = TRUE );
BOOL PopData();
// #111827#
/**
Returns textual description of this a redline data element of
this redline.
@param nPos index of the redline data element to describe
The textual description of the selected element contains the
kind of redline and the possibly shortened text of the redline.
@return textual description of the selected redline data element
*/
String GetDescr(USHORT nPos = 0);
int operator==( const SwRedline& ) const;
int operator<( const SwRedline& ) const;
};
#endif