/*************************************************************************
 *
 * 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 _SV_IMPGRAPH_HXX
#define _SV_IMPGRAPH_HXX

#include <tools/urlobj.hxx>
#include <vcl/bitmap.hxx>
#include <vcl/bitmapex.hxx>
#include <vcl/animate.hxx>
#include <vcl/gdimtf.hxx>
#include <vcl/graph.h>
#include <vcl/svgdata.hxx>

// ---------------
// - ImpSwapInfo -
// ---------------

struct ImpSwapInfo
{
	MapMode		maPrefMapMode;
	Size		maPrefSize;
};

// --------------
// - ImpGraphic -
// --------------

class	OutputDevice;
class	GfxLink;
struct	ImpSwapFile;
class GraphicConversionParameters;

class ImpGraphic
{
	friend class Graphic;

private:

	GDIMetaFile			maMetaFile;
	BitmapEx			maEx;
	ImpSwapInfo			maSwapInfo;
	Animation*			mpAnimation;
	GraphicReader*		mpContext;
	ImpSwapFile*		mpSwapFile;
	GfxLink*			mpGfxLink;
	GraphicType			meType;
	String				maDocFileURLStr;
	sal_uLong			mnDocFilePos;
    mutable sal_uLong   mnSizeBytes;
	sal_uLong			mnRefCount;
	sal_Bool			mbSwapOut;
	sal_Bool			mbSwapUnderway;

    // SvgData support
    SvgDataPtr          maSvgData;

private:

						ImpGraphic();
						ImpGraphic( const ImpGraphic& rImpGraphic );
						ImpGraphic( const Bitmap& rBmp );
						ImpGraphic( const BitmapEx& rBmpEx );
						ImpGraphic(const SvgDataPtr& rSvgDataPtr);
						ImpGraphic( const Animation& rAnimation );
						ImpGraphic( const GDIMetaFile& rMtf );
	virtual				~ImpGraphic();

    ImpGraphic&			operator=( const ImpGraphic& rImpGraphic );
	sal_Bool				operator==( const ImpGraphic& rImpGraphic ) const;
	sal_Bool				operator!=( const ImpGraphic& rImpGraphic ) const { return !( *this == rImpGraphic ); }

	void				ImplClearGraphics( sal_Bool bCreateSwapInfo );
	void				ImplClear();

	GraphicType			ImplGetType() const;
	void				ImplSetDefaultType();
	sal_Bool				ImplIsSupportedGraphic() const;

	sal_Bool			ImplIsTransparent() const;
	sal_Bool			ImplIsAlpha() const;
	sal_Bool			ImplIsAnimated() const;
	sal_Bool			ImplIsEPS() const;

	Bitmap				    ImplGetBitmap(const GraphicConversionParameters& rParameters) const;
	BitmapEx			    ImplGetBitmapEx(const GraphicConversionParameters& rParameters) const;
	Animation			    ImplGetAnimation() const;
	const GDIMetaFile&	    ImplGetGDIMetaFile() const;


	Size				ImplGetPrefSize() const;
	void				ImplSetPrefSize( const Size& rPrefSize );

	MapMode				ImplGetPrefMapMode() const;
	void				ImplSetPrefMapMode( const MapMode& rPrefMapMode );

	sal_uLong				ImplGetSizeBytes() const;

	void				ImplDraw( OutputDevice* pOutDev,
								  const Point& rDestPt ) const;
	void				ImplDraw( OutputDevice* pOutDev,
								  const Point& rDestPt,
								  const Size& rDestSize ) const;

	void				ImplStartAnimation( OutputDevice* pOutDev,
											const Point& rDestPt,
											long nExtraData = 0,
											OutputDevice* pFirstFrameOutDev = NULL );
	void				ImplStartAnimation( OutputDevice* pOutDev,
											const Point& rDestPt,
											const Size& rDestSize,
											long nExtraData = 0,
											OutputDevice* pFirstFrameOutDev = NULL );
	void				ImplStopAnimation( OutputDevice* pOutputDevice = NULL,
										   long nExtraData = 0 );

	void				ImplSetAnimationNotifyHdl( const Link& rLink );
	Link				ImplGetAnimationNotifyHdl() const;

	sal_uLong				ImplGetAnimationLoopCount() const;
	void				ImplResetAnimationLoopCount();

	List*				ImplGetAnimationInfoList() const;

private:

	GraphicReader*		ImplGetContext();
	void				ImplSetContext( GraphicReader* pReader );

private:

	void				ImplSetDocFileName( const String& rName, sal_uLong nFilePos );
	const String&		ImplGetDocFileName() const;
	sal_uLong				ImplGetDocFilePos() const;

	sal_Bool				ImplReadEmbedded( SvStream& rIStream, sal_Bool bSwap = sal_False );
	sal_Bool				ImplWriteEmbedded( SvStream& rOStream );

	sal_Bool				ImplSwapIn();
	sal_Bool				ImplSwapIn( SvStream* pIStm );

	sal_Bool				ImplSwapOut();
	sal_Bool				ImplSwapOut( SvStream* pOStm );

	sal_Bool				ImplIsSwapOut() const;

	void				ImplSetLink( const GfxLink& );
	GfxLink				ImplGetLink();
	sal_Bool				ImplIsLink() const;

	sal_uLong				ImplGetChecksum() const;

	sal_Bool				ImplExportNative( SvStream& rOStm ) const;

	friend SvStream&	operator<<( SvStream& rOStm, const ImpGraphic& rImpGraphic );
	friend SvStream&	operator>>( SvStream& rIStm, ImpGraphic& rImpGraphic );

    // SvgData support
    const SvgDataPtr& getSvgData() const;
};

#endif // _SV_IMPGRAPH_HXX