A fixed size region. More...

#include <e32std.h>

Inheritance diagram for TRegionFix< S >:

Public Member Functions
	TRegionFix ()
	Constructs a default fixed size region.

	TRegionFix (const TRect &aRect)
	Constructs a fixed size region with a TRect.

	TRegionFix (const TRegionFix< S > &aRegion)
	Copy constructor.

Public Member Functions inherited from TRegion
TInt	Count () const
	Gets the number of rectangles in this region.

const TRect *	RectangleList () const
	Gets a pointer to the array of rectangles defining this region.

TBool	CheckError () const
	Tests whether the region's error flag is set.

IMPORT_C TBool	IsEmpty () const
	Tests whether the region is empty.

IMPORT_C TRect	BoundingRect () const
	Gets the minimal rectangle that bounds the entire region.

IMPORT_C const TRect &	operator[] (TInt aIndex) const
	Gets a rectangle from the region.

IMPORT_C void	Copy (const TRegion &aRegion)
	Copies another region to this region.

IMPORT_C void	AddRect (const TRect &aRect)
	Adds a rectangle to this region.

IMPORT_C void	SubRect (const TRect &aRect, TRegion *aSubtractedRegion=NULL)
	Removes a rectangle from this region.

IMPORT_C void	Offset (TInt aXoffset, TInt aYoffset)
	Moves the region by adding X and Y offsets to the co-ordinates of its corners.

IMPORT_C void	Offset (const TPoint &aOffset)
	Moves the region by adding a TPoint offset to the co-ordinates of its corners.

IMPORT_C void	Union (const TRegion &aRegion)
	Replaces this region with the union of it and the specified region.

IMPORT_C void	Intersection (const TRegion &aRegion, const TRegion &aRegion2)
	Replaces this region with the area of intersection between two specified regions.

IMPORT_C void	Intersect (const TRegion &aRegion)
	Replaces this region with the area of intersection between it and the specified region.

IMPORT_C void	SubRegion (const TRegion &aRegion, TRegion *aSubtractedRegion=NULL)
	Removes a region.

IMPORT_C void	ClipRect (const TRect &aRect)
	Clips the region to the specified rectangle.

IMPORT_C void	Clear ()
	Clears this region.

IMPORT_C void	Tidy ()
	Merges all rectangles within this region which share an adjacent edge of the same length.

IMPORT_C TInt	Sort ()
	Sorts the region's array of rectangles according to their vertical position on the screen.

IMPORT_C TInt	Sort (const TPoint &aOffset)
	Sorts the region's array of rectangles according to a specified sort order.

IMPORT_C void	ForceError ()
	Sets the error flag, and clears the region.

IMPORT_C TBool	IsContainedBy (const TRect &aRect) const
	Tests whether the region is fully enclosed within the specified rectangle.

IMPORT_C TBool	Contains (const TPoint &aPoint) const
	Tests whether a point is located within the region.

IMPORT_C TBool	Intersects (const TRect &aRect) const
	Tests whether where there is any intersection between this region and the specified rectangle.

Additional Inherited Members
Protected Types inherited from TRegion
enum	{ ERRegionBuf =0x40000000 }

Protected Member Functions inherited from TRegion
IMPORT_C TRect *	RectangleListW ()

IMPORT_C	TRegion (TInt aAllocedRects)

	TRegion ()

TBool	SetListSize (TInt aCount)
	Ensure that the region is big enough to hold aCount rectangles.

void	AppendRect (const TRect &aRect)

void	DeleteRect (TRect *aRect)

void	AppendRegion (TRegion &aRegion)

void	MergeRect (const TRect &aRect, TBool aEnclosed)
	Merges a rectangle with this region.

void	SubtractRegion (const TRegion &aRegion, TRegion *aSubtractedRegion=NULL)
	Removes a region.

void	ShrinkRegion ()
	After an RRegion's iCount has reduced try to release some memory.

TRect *	ExpandRegion (TInt aCount)
	Ensure that the region is big enough to hold aCount rectangles.

Protected Attributes inherited from TRegion
TInt	iCount

TBool	iError

TInt	iAllocedRects

Detailed Description

template<TInt S>
class TRegionFix< S >

A fixed size region.

The region consists of a fixed number of rectangles; this number is specified in the templated argument. The region cannot be expanded to contain more than this number of rectangles. If an attempt is made to do so, the region's error flag is set, and the region is cleared.

Note that when adding a rectangle to a region, if that rectangle overlaps an existing rectangle, the operation causes more than one rectangle to be created.

API status: Published to all clients. Released API.

Definition at line 2913 of file e32std.h.

Constructor & Destructor Documentation

◆ TRegionFix() [1/3]

template<TInt S>

TRegionFix< S >::TRegionFix ( )

inline

Constructs a default fixed size region.

(generated from Symbian Developer Library)

◆ TRegionFix() [2/3]

template<TInt S>

TRegionFix< S >::TRegionFix ( const TRect & aRect )

inline

Constructs a fixed size region with a TRect.

Parameters

aRect Rectangle to be added to the newly constructed region.

(generated from Symbian Developer Library)

◆ TRegionFix() [3/3]

template<TInt S>

TRegionFix< S >::TRegionFix ( const TRegionFix< S > & aRegion )

inline

Copy constructor.

Parameters

aRegion The TRegionFix object to be copied.

(generated from Symbian Developer Library)

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TRegionFix() [1/3]

◆ TRegionFix() [2/3]

◆ TRegionFix() [3/3]