/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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 _EDITOBJ2_HXX
#define _EDITOBJ2_HXX

#include <editeng/editobj.hxx>
#include <editdoc.hxx>

#include <unotools/fontcvt.hxx>


class SfxStyleSheetPool; 

class XEditAttribute
{
    friend class ContentInfo;	// fuer DTOR
    friend class BinTextObject;	// fuer DTOR

private:
    const SfxPoolItem*	pItem;
    USHORT 				nStart;
    USHORT 				nEnd;

                        XEditAttribute();
                        XEditAttribute( const XEditAttribute& rCopyFrom );

                        ~XEditAttribute();

public:
                        XEditAttribute( const SfxPoolItem& rAttr );
                        XEditAttribute( const SfxPoolItem& rAttr, USHORT nStart, USHORT nEnd );

    const SfxPoolItem*	GetItem() const				{ return pItem; }

    USHORT&				GetStart()					{ return nStart; }
    USHORT&				GetEnd()					{ return nEnd; }

    USHORT				GetStart() const			{ return nStart; }
    USHORT				GetEnd() const				{ return nEnd; }

    USHORT				GetLen() const				{ return nEnd-nStart; }

    inline BOOL			IsFeature();

    inline bool			operator==( const XEditAttribute& rCompare );
};

inline bool XEditAttribute::operator==( const XEditAttribute& rCompare )
{
    return	(nStart == rCompare.nStart) &&
            (nEnd == rCompare.nEnd) &&
            ( (pItem == rCompare.pItem) ||
            ( pItem->Which() != rCompare.pItem->Which()) ||
            (*pItem == *rCompare.pItem));
}

inline BOOL XEditAttribute::IsFeature()
{
    USHORT nWhich = pItem->Which();
    return 	( ( nWhich >= EE_FEATURE_START ) &&
              ( nWhich <=  EE_FEATURE_END ) );
}

typedef XEditAttribute* XEditAttributePtr;
SV_DECL_PTRARR( XEditAttributeListImpl, XEditAttributePtr, 0, 4 )

class XEditAttributeList : public XEditAttributeListImpl
{
public:
    XEditAttribute* FindAttrib( USHORT nWhich, USHORT nChar ) const;
};

struct XParaPortion
{
    long				nHeight;
    USHORT				nFirstLineOffset;

    EditLineList		aLines;
    TextPortionList		aTextPortions;
};

typedef XParaPortion* XParaPortionPtr;
SV_DECL_PTRARR( XBaseParaPortionList, XParaPortionPtr, 0, 4 )

class XParaPortionList : public  XBaseParaPortionList
{
    ULONG 		nRefDevPtr;
    OutDevType	eRefDevType;
    MapMode		aRefMapMode;
    ULONG		nPaperWidth;


public:
            XParaPortionList( OutputDevice* pRefDev, ULONG nPW ) :
                aRefMapMode( pRefDev->GetMapMode() )
                {
                    nRefDevPtr = (ULONG)pRefDev; nPaperWidth = nPW;
                    eRefDevType = pRefDev->GetOutDevType();
                }

    ULONG			GetRefDevPtr() const 		{ return nRefDevPtr; }
    ULONG			GetPaperWidth() const 		{ return nPaperWidth; }
    OutDevType		GetRefDevType() const 		{ return eRefDevType; }
    const MapMode&	GetRefMapMode() const		{ return aRefMapMode; }
};

/* cl removed because not needed anymore since binfilter
struct LoadStoreTempInfos
{
    ByteString              aOrgString_Load;

    FontToSubsFontConverter hOldSymbolConv_Store;
    BOOL                    bSymbolParagraph_Store;


    LoadStoreTempInfos() { bSymbolParagraph_Store = FALSE; hOldSymbolConv_Store = NULL; }
};
*/

class ContentInfo
{
    friend class BinTextObject;

private:
    String				aText;
    String				aStyle;
    XEditAttributeList	aAttribs;
    SfxStyleFamily		eFamily;
    SfxItemSet			aParaAttribs;
    WrongList*			pWrongs;

/* cl removed because not needed anymore since binfilter
    LoadStoreTempInfos* pTempLoadStoreInfos;
*/

                        ContentInfo( SfxItemPool& rPool );
                        ContentInfo( const ContentInfo& rCopyFrom, SfxItemPool& rPoolToUse  );

public:
                        ~ContentInfo();

    const String&		GetText()			const	{ return aText; }
    const String&		GetStyle()			const	{ return aStyle; }
    const XEditAttributeList& GetAttribs()	const	{ return aAttribs; }
    const SfxItemSet&	GetParaAttribs()	const	{ return aParaAttribs; }
    SfxStyleFamily		GetFamily()			const	{ return eFamily; }

    String&				GetText()			{ return aText; }
    String&				GetStyle()			{ return aStyle; }
    XEditAttributeList&	GetAttribs()		{ return aAttribs; }
    SfxItemSet&			GetParaAttribs()	{ return aParaAttribs; }
    SfxStyleFamily&		GetFamily()			{ return eFamily; }

    WrongList*			GetWrongList() const			{ return pWrongs; }
    void				SetWrongList( WrongList* p )	{ pWrongs = p; }
    bool				operator==( const ContentInfo& rCompare ) const;

    // #i102062#
    bool isWrongListEqual(const ContentInfo& rCompare) const;
};

typedef ContentInfo* ContentInfoPtr;
SV_DECL_PTRARR( ContentInfoList, ContentInfoPtr, 1, 4 )

// MT 05/00: Sollte mal direkt EditTextObjekt werden => keine virtuellen Methoden mehr.

class BinTextObject : public EditTextObject, public SfxItemPoolUser
{
    using EditTextObject::operator==;
    using EditTextObject::isWrongListEqual;

private:
    ContentInfoList			aContents;
    SfxItemPool*			pPool;
    BOOL					bOwnerOfPool;
    XParaPortionList*		pPortionInfo;
    
    sal_uInt32				nObjSettings;
    USHORT 					nMetric;
    USHORT 					nVersion;
    USHORT					nUserType;
    USHORT					nScriptType;

    BOOL					bVertical;
    BOOL					bStoreUnicodeStrings;

protected:
    void					DeleteContents();
    virtual void			StoreData( SvStream& rOStream ) const;
    virtual void			CreateData( SvStream& rIStream );
    BOOL					ImpChangeStyleSheets( const String& rOldName, SfxStyleFamily eOldFamily,
                                        const String& rNewName, SfxStyleFamily eNewFamily );

public:
                            BinTextObject( SfxItemPool* pPool );
                            BinTextObject( const BinTextObject& );
    virtual					~BinTextObject();

    virtual EditTextObject*	Clone() const;

    USHORT					GetUserType() const;
    void					SetUserType( USHORT n );

    ULONG					GetObjectSettings() const;
    void					SetObjectSettings( ULONG n );

    BOOL					IsVertical() const;
    void					SetVertical( BOOL b );

    USHORT					GetScriptType() const;
    void					SetScriptType( USHORT nType );

    USHORT					GetVersion() const;	// Solange der Outliner keine Recordlaenge speichert

    ContentInfo*			CreateAndInsertContent();
    XEditAttribute*			CreateAttrib( const SfxPoolItem& rItem, USHORT nStart, USHORT nEnd );
    void					DestroyAttrib( XEditAttribute* pAttr );

    ContentInfoList&		GetContents()			{ return aContents; }
    const ContentInfoList&	GetContents() const		{ return aContents; }
    SfxItemPool*			GetPool() const			{ return pPool; }
    XParaPortionList*		GetPortionInfo() const	{ return pPortionInfo; }
    void					SetPortionInfo( XParaPortionList* pP )
                                { pPortionInfo = pP; }

    virtual USHORT			GetParagraphCount() const;
    virtual String			GetText( USHORT nParagraph ) const;
    virtual void			Insert( const EditTextObject& rObj, USHORT nPara );
    virtual EditTextObject*	CreateTextObject( USHORT nPara, USHORT nParas = 1 ) const;
    virtual void			RemoveParagraph( USHORT nPara );

    virtual BOOL			HasPortionInfo() const;
    virtual void			ClearPortionInfo();

    virtual BOOL			HasOnlineSpellErrors() const;

    virtual BOOL			HasCharAttribs( USHORT nWhich = 0 ) const;
    virtual void			GetCharAttribs( USHORT nPara, EECharAttribArray& rLst ) const;

    virtual BOOL			RemoveCharAttribs( USHORT nWhich = 0 );
    virtual BOOL			RemoveParaAttribs( USHORT nWhich = 0 );
    
    virtual void			MergeParaAttribs( const SfxItemSet& rAttribs, USHORT nStart, USHORT nEnd );

    virtual BOOL			IsFieldObject() const;
    virtual const SvxFieldItem*	GetField() const;
    virtual BOOL			HasField( TypeId Type = NULL ) const;

    SfxItemSet 				GetParaAttribs( USHORT nPara ) const;
    void 					SetParaAttribs( USHORT nPara, const SfxItemSet& rAttribs );

    virtual BOOL			HasStyleSheet( const XubString& rName, SfxStyleFamily eFamily ) const;
    virtual void			GetStyleSheet( USHORT nPara, XubString& rName, SfxStyleFamily& eFamily ) const;
    virtual void			SetStyleSheet( USHORT nPara, const XubString& rName, const SfxStyleFamily& eFamily );
    virtual BOOL			ChangeStyleSheets( 	const XubString& rOldName, SfxStyleFamily eOldFamily,
                                                const String& rNewName, SfxStyleFamily eNewFamily );
    virtual void			ChangeStyleSheetName( SfxStyleFamily eFamily, const XubString& rOldName, const XubString& rNewName );

    void					CreateData300( SvStream& rIStream );

    BOOL					HasMetric() const			{ return nMetric != 0xFFFF; }
    USHORT					GetMetric() const			{ return nMetric; }
    void					SetMetric( USHORT n )		{ nMetric = n; }

    BOOL					IsOwnerOfPool() const		{ return bOwnerOfPool; }
    void					StoreUnicodeStrings( BOOL b ) { bStoreUnicodeStrings = b; }

/* cl removed because not needed anymore since binfilter
    void 					PrepareStore( SfxStyleSheetPool* pStyleSheetPool );
    void 					FinishStore();
    void 					FinishLoad( SfxStyleSheetPool* pStyleSheetPool );
*/

    bool					operator==( const BinTextObject& rCompare ) const;

    // #i102062#
    bool isWrongListEqual(const BinTextObject& rCompare) const;

    // from SfxItemPoolUser
    virtual void ObjectInDestruction(const SfxItemPool& rSfxItemPool);
};

#endif	// _EDITOBJ2_HXX