sl@0: // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #include <gdi.h>
sl@0: #include "GDIPANIC.h"
sl@0: 
sl@0: _LIT(KGdiCPicturePanicCategory,"CPicture");
sl@0: 
sl@0: EXPORT_C TPictureHeader::TPictureHeader():
sl@0: 	iPicture(NULL),
sl@0: 	iPictureType(KNullUid),
sl@0: 	iSize()
sl@0: /** Constructs a default picture header. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C void TPictureHeader::DeletePicture()
sl@0: /** Deletes the internalised picture.
sl@0: 
sl@0: The picture can only be deleted if the picture has been internalized. */
sl@0: 	{
sl@0: 	if (iPicture.IsPtr())
sl@0: 		{
sl@0: 		delete iPicture.AsPtr();
sl@0: 		iPicture=NULL;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 
sl@0: // Persist this object
sl@0: // Does not take responsibility for storing the picture
sl@0: //
sl@0: EXPORT_C void TPictureHeader::ExternalizeL(RWriteStream& aStream)const
sl@0: /** Externalises a picture header object to a write stream. 
sl@0: 
sl@0: The presence of this function means that the standard templated stream operator<<() 
sl@0: is available to externalise objects of this class.
sl@0: 
sl@0: @param aStream The write stream. */
sl@0:     {
sl@0:     aStream<< iPictureType;
sl@0:     aStream<< iPicture;
sl@0: 	aStream.WriteInt32L(iSize.iWidth);
sl@0: 	aStream.WriteInt32L(iSize.iHeight);
sl@0:     }
sl@0: 
sl@0: 
sl@0: // Restore this object from the specified stream
sl@0: // Does not take responsibility for restoring the picture
sl@0: //
sl@0: EXPORT_C void TPictureHeader::InternalizeL(RReadStream& aStream)
sl@0: /** Internalises a picture header object from a read stream.
sl@0: 
sl@0: The presence of this function means that the standard templated stream operator>>() 
sl@0: is available to internalise objects of this class.
sl@0: 
sl@0: @param aStream The read stream. */
sl@0:     {
sl@0:     aStream>> iPictureType;
sl@0:     aStream>> iPicture;
sl@0: 	iSize.iWidth=aStream.ReadInt32L();
sl@0: 	iSize.iHeight=aStream.ReadInt32L();
sl@0:     }
sl@0: 
sl@0: EXPORT_C CPicture::CPicture():
sl@0: 	CBase()
sl@0: 	{
sl@0: 	__DECLARE_NAME(_S("CPicture"));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CPicture::~CPicture()
sl@0: /** Frees all resources owned by the object prior to its destruction. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TPictureCapability CPicture::Capability() const
sl@0: /** Gets the picture's capabilities.
sl@0: 
sl@0: These include whether it is scalable and croppable.
sl@0: 
sl@0: @return The capabilities of the picture. */
sl@0: 	{
sl@0: 	return TPictureCapability(TPictureCapability::ENotScaleable,EFalse);
sl@0: 	}
sl@0: 
sl@0: // Assumes everything goes into the head stream.
sl@0: // (Must be replaced by concrete pictures that have components)
sl@0: //
sl@0: EXPORT_C TStreamId CPicture::StoreL(CStreamStore& aStore) const
sl@0: /** Stores the picture to the specified store.
sl@0: 
sl@0: The default implementation assumes that the content of the picture is externalized 
sl@0: to a single stream. The implementation may need to be changed for those derived 
sl@0: classes that have components.
sl@0: 
sl@0: @param aStore The store. 
sl@0: @return The ID of the (head) stream used to store the picture. */
sl@0: 	{
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id=stream.CreateLC(aStore);
sl@0: 	ExternalizeL(stream);  // provided by the concrete picture stream.CommitL();
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::ResetToOriginal()
sl@0: /** Resets the picture's scaling and cropping attributes to their original values. */
sl@0: 	{
sl@0: 	TMargins cropInTwips;
sl@0: 	cropInTwips.iLeft=0;
sl@0: 	cropInTwips.iRight=0;
sl@0: 	cropInTwips.iTop=0;
sl@0: 	cropInTwips.iBottom=0;
sl@0: 	SetCropInTwips(cropInTwips);
sl@0: 	SetScaleFactor(1000,1000);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::GetSizeInPixels(MGraphicsDeviceMap* aMap,TSize& aSize) const
sl@0: /** Gets the picture's size in pixels. 
sl@0: 
sl@0: This is calculated from the original size of the picture, taking cropping 
sl@0: and scaling into account.
sl@0: 
sl@0: @param aMap The pixels to twips mapping interface of the graphics device 
sl@0: @param aSize The size of the picture, in pixels. */
sl@0: 	{
sl@0: 	GDI_ASSERT_ALWAYS_GENERAL(aMap!=NULL,User::Panic(KGdiCPicturePanicCategory,KErrNotFound));
sl@0: 	TSize size;
sl@0: 	GetSizeInTwips(size);
sl@0: 	aSize.iWidth = aMap->HorizontalTwipsToPixels(size.iWidth);
sl@0: 	aSize.iHeight = aMap->VerticalTwipsToPixels(size.iHeight);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::SetSizeInPixels(MGraphicsDeviceMap* aMap,const TSize& aSize)
sl@0: /** Sets the picture's size in pixels.
sl@0: 
sl@0: @param aMap The pixels to twips mapping interface of the graphics device. 
sl@0: @param aSize The size of the picture, in pixels. */
sl@0: 	{
sl@0: 	GDI_ASSERT_ALWAYS_GENERAL(aMap!=NULL,User::Panic(KGdiCPicturePanicCategory,KErrNotFound));
sl@0: 	TSize size;
sl@0: 	size.iWidth = aMap->HorizontalPixelsToTwips(aSize.iWidth);
sl@0: 	size.iHeight = aMap->VerticalPixelsToTwips(aSize.iHeight);
sl@0: 	SetSizeInTwips(size);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::SetScaleFactor(TInt /*aScaleFactorWidth*/,TInt /*aScaleFactorHeight*/)
sl@0: /** Sets the picture's scale factors.
sl@0: 	
sl@0: 	@param aScaleFactorWidth The width scale factor, in percent. 
sl@0: 	@param aScaleFactorHeight The height scale factor, in percent. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CPicture::ScaleFactorWidth() const
sl@0: /** Gets the picture's width scale factor.
sl@0: 
sl@0: @return The width scale factor, in percent. */
sl@0: 	{
sl@0: 	return 1000; // no scaling
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CPicture::ScaleFactorHeight() const
sl@0: /** Gets the pictures height scale factor.
sl@0: 
sl@0: @return The height scale factor, in percent. */
sl@0: 	{
sl@0: 	return 1000; // no scaling
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::GetCropInTwips(TMargins& aCrop) const
sl@0: /** Gets the cropping margins of a picture in twips.
sl@0: 	
sl@0: These margins are relative to the original unscaled size of the picture.
sl@0: 	
sl@0: @param aMargins The cropping margins of the picture, in twips */
sl@0:     {
sl@0: 	aCrop.iLeft=0;
sl@0: 	aCrop.iRight=0;
sl@0: 	aCrop.iTop=0;
sl@0: 	aCrop.iBottom=0;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::SetCropInTwips(const TMargins& /*aMargins*/)
sl@0: /** Sets the cropping margins of a picture in twips.
sl@0: 	
sl@0: These are relative to the original unscaled size of the picture.
sl@0: 	
sl@0: @param aMargins The cropping margins of the picture, in twips. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C TBool CPicture::LineBreakPossible(TUint /*aClass*/,TBool /*aBeforePicture*/,TBool /*aHaveSpaces*/) const
sl@0: /** States whether a line break is possible, either before or after a picture.
sl@0: 	
sl@0: The default implementation returns ETrue, implying that there is a break opportunity 
sl@0: both before and after the picture, whether or not a space is present.
sl@0: 
sl@0: This may be overridden for special types of pictures.
sl@0: 
sl@0: @param aClass The line breaking class of the adjacent character. Line breaking 
sl@0: classes are defined in the header file, tagma.h
sl@0: @param aBeforePicture ETrue, if the adjacent character is before the picture; 
sl@0: EFalse, if the adjacent character is afterwards.
sl@0: @param aHaveSpaces ETrue, if spaces occur between the adjacent character and 
sl@0: the picture; EFalse, otherwise.
sl@0: @return ETrue, if a line break is possible; EFalse, otherwise. */
sl@0: 	{
sl@0: 	return TRUE;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: EXPORT_C TBool CPicture::NativePixelSize(TSize&)
sl@0: /** Derived classes might be implemented as bitmaps, in that case it might 
sl@0: be interesting to now the native pixel size of the bitmap. */
sl@0: 	{
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::GetSizeInTwips(TSize& aSize) const
sl@0: /** Gets the picture's size, in twips.
sl@0: 
sl@0: This size is calculated from the original size of the picture, taking cropping 
sl@0: and scaling into account.
sl@0: 
sl@0: @param aSize The size of the picture, in twips. */
sl@0: 	{
sl@0: 	TSize originalSizeInTwips;
sl@0: 	GetOriginalSizeInTwips(originalSizeInTwips);
sl@0: 	TMargins cropInTwips;
sl@0: 	GetCropInTwips(cropInTwips);
sl@0: 	aSize.iWidth = (ScaleFactorWidth()*(originalSizeInTwips.iWidth-cropInTwips.iLeft-cropInTwips.iRight))/1000;
sl@0: 	aSize.iHeight = (ScaleFactorHeight()*(originalSizeInTwips.iHeight-cropInTwips.iTop-cropInTwips.iBottom))/1000;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPicture::SetSizeInTwips(const TSize& aSize)
sl@0: /** Sets the picture's size, in twips
sl@0: 
sl@0: @param aSize The size of the picture, in twips. */
sl@0: 	{
sl@0: 	TSize originalSizeInTwips;
sl@0: 	GetOriginalSizeInTwips(originalSizeInTwips);
sl@0: 	TMargins cropInTwips;
sl@0: 	GetCropInTwips(cropInTwips);
sl@0: 	TSize size;
sl@0: 	size.iWidth  = originalSizeInTwips.iWidth-cropInTwips.iLeft-cropInTwips.iRight;
sl@0: 	size.iHeight = originalSizeInTwips.iHeight-cropInTwips.iTop-cropInTwips.iBottom;
sl@0: 	TSize scalefactor;
sl@0: 	if(size.iWidth!=0) scalefactor.iWidth=1000*aSize.iWidth/size.iWidth;
sl@0: 	if(size.iHeight!=0) scalefactor.iHeight=1000*aSize.iHeight/size.iHeight;
sl@0: 	SetScaleFactor(scalefactor.iWidth,scalefactor.iHeight);
sl@0:  	}
sl@0: 
sl@0: EXPORT_C void CPicture::AddCropInPixels(MGraphicsDeviceMap* aMap,const TMargins& aMargins)
sl@0: /** Adds pixel cropping margins to the picture.
sl@0: 
sl@0: @param aMap The pixels to twips mapping interface of the graphics device 
sl@0: @param aMargins The additional pixel cropping margins for the picture, in pixels. */
sl@0: 	{
sl@0: 	GDI_ASSERT_ALWAYS_GENERAL(aMap!=NULL,User::Panic(KGdiCPicturePanicCategory,KErrNotFound));
sl@0: 	TMargins cropInTwips;
sl@0: 	GetCropInTwips(cropInTwips);
sl@0: 	TInt scaleFactorWidth=ScaleFactorWidth();
sl@0: 	if(scaleFactorWidth!=0)
sl@0: 		{
sl@0: 		cropInTwips.iLeft += (1000*aMap->HorizontalPixelsToTwips(aMargins.iLeft))/scaleFactorWidth;
sl@0: 		cropInTwips.iRight += (1000*aMap->HorizontalPixelsToTwips(aMargins.iRight))/scaleFactorWidth;
sl@0: 		}
sl@0: 	TInt scaleFactorHeight=ScaleFactorHeight();
sl@0: 	if(scaleFactorHeight!=0)
sl@0: 		{
sl@0: 		cropInTwips.iTop += (1000*aMap->VerticalPixelsToTwips(aMargins.iTop))/scaleFactorHeight;
sl@0: 		cropInTwips.iBottom += (1000*aMap->VerticalPixelsToTwips(aMargins.iBottom))/scaleFactorHeight;
sl@0: 		}
sl@0: 	SetCropInTwips(cropInTwips);
sl@0: 	}
sl@0: