sl@0: // Copyright (c) 2008-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: #ifndef TREGIONEXTEND_H_
sl@0: #define TREGIONEXTEND_H_
sl@0: 
sl@0: #include <e32std.h>
sl@0: 
sl@0: class TRegionExtend : public TRegion
sl@0: 	{
sl@0: 	//Note that this class is generally only good for regions with dimensions less than 45000x45000
sl@0: 	//as integers are used to hold the final total area, and would overflow.
sl@0: 	//In debug build, panic TRegionExtend x003 is raised, where x indicates a code-point
sl@0: 	// when any rectangle in the region exceeds 32k
sl@0: 	
sl@0: private:
sl@0: 	//Do not construct instances of this class, use the Cast() methods to convert existing region instances
sl@0: 	TRegionExtend();
sl@0: 	TRegionExtend(const TRegionExtend&);
sl@0: public:
sl@0: 	//Please use TRegionExtend::Cast() calls to extend existing TRegion objects
sl@0: 	static TRegionExtend& 		Cast(TRegion& aSrc)			{	return (TRegionExtend&) aSrc;	}
sl@0: 	static TRegionExtend* 		Cast(TRegion* aSrc)			{	return (TRegionExtend*) aSrc;	}
sl@0: 	static const TRegionExtend& Cast(const TRegion& aSrc)	{	return (const TRegionExtend&) aSrc;	}
sl@0: 	static const TRegionExtend* Cast(const TRegion* aSrc)	{	return (const TRegionExtend*) aSrc;	}
sl@0: 	
sl@0: public:
sl@0: 	using	TRegion::RectangleListW;
sl@0: 	enum TOverlapFlags
sl@0: 		{
sl@0: 		EExact=			0x0000,
sl@0: 		ESub=			0x0001,	
sl@0: 		EAdd=			0x0002,
sl@0: 		EDiffers=		0x0003,	//Added and/or subtracted
sl@0: 		ENoIntersect=	0x0004,
sl@0: 		EErrorRegion=	0x0008	//This code is returned if one of the input regions is flagged as invalid
sl@0: 		};
sl@0: 
sl@0: 	/** Avoids the use of a temp region by performing area calc on the fly.
sl@0: 	 * If both regions are empty then EOverlapNoIntersect only is returned.
sl@0: 	 * Limitation: this method is only good for regions with less than 2 billion units of area!
sl@0: 	 * @param aTarget	target region for difference
sl@0: 	 **/
sl@0: 	TOverlapFlags	TestDifference(const TRegion& aTarget)const;
sl@0: 	
sl@0: 	/** Further avoids the use of a temp region by performing area calc on the fly.
sl@0: 	 * If both regions are empty then EOverlapNoIntersect only is returned.
sl@0: 	 * Limitation: this method is only good for regions with less than 2 billion units of area!
sl@0: 	 * @param aTarget	target region for difference
sl@0: 	 * @param aOffset	origin offset transformation from this to target region
sl@0: 	 **/
sl@0: 	TOverlapFlags	TestDifference(const TRegion& aTarget,TPoint aOffset )const;
sl@0: 	
sl@0: 	/** Avoids the use of a temp region by performing area calc on the fly.
sl@0: 	 * If region and rect both empty then EOverlapNoIntersect only is returned.
sl@0: 	 * Limitation: this method is only good for regions and rects with less than 2 billion units of area!
sl@0: 	 **/
sl@0: 	TOverlapFlags	TestDifference(const TRect&)const;
sl@0: 	
sl@0: 	/** Intended as an internal method to test for the overlap of two rectangles.
sl@0: 	 * 
sl@0: 	 **/
sl@0: 	static TOverlapFlags TestDifference(const TRect&,const TRect&);
sl@0: 	
sl@0: 	/** Returns total area of the region
sl@0: 	 * Limitation: this method is only good for regions with less than 2 billion units of area!
sl@0: 	 **/
sl@0: 	TUint	Area()const;
sl@0: 	
sl@0: 
sl@0: protected:
sl@0: 	};
sl@0: 
sl@0: #endif /*TREGIONEXTEND_H_*/