Regions Interface Reference

A Regions object can be used for creating a regions. More...

List of all members.

Public Member Functions
	CombineRgn ([in] ULONG hrgnSrc1,[in] ULONG hrgnSrc2,[in] LONG fnCombineMode,[out, retval] IDispatch **pRegion)
	The CombineRgn method combines two regions and returns the result.
	CreateEllipticRgn ([in] LONG Left,[in] LONG Top,[in] LONG Width,[in] LONG Height,[out, retval] IDispatch **pRegion)
	The CreateEllipticRgn method creates an elliptical region.
	CreatePolygonRgn ([in] SAFEARRAY(VARIANT) Data,[out, retval] IDispatch **pRegion)
	The CreatePolygonRgn method creates an polygon region.
	CreateRectRgn ([in] LONG Left,[in] LONG Top,[in] LONG Width,[in] LONG Height,[out, retval] IDispatch **pRegion)
	The CreateRectRgn method creates an rectangle region.
	CreateRoundRectRgn ([in] LONG Left,[in] LONG Top,[in] LONG Width,[in] LONG Height,[in] LONG nWidthEllipse,[in] LONG nHeightEllipse,[out, retval] IDispatch **pRegion)
	The CreateRoundRectRgn method creates an rectangular region with rounded corners.
	TransformRgn ([in] ULONG ARegion,[in] FLOAT eM11,[in] FLOAT eM12,[in] FLOAT eM21,[in] FLOAT eM22,[in] FLOAT eDx,[in] FLOAT eDy,[out, retval] IDispatch **pRegion)
	The TransformRgn method creates a region from the specified region and transformation data.
	EqualRgn ([in] ULONG hSrcRgn1,[in] ULONG hSrcRgn2,[out, retval] VARIANT_BOOL *pResult)
	The EqualRgn method compares a two regions.
	CreateRgnFromImage ([in] VARIANT Image,[in] ULONG MaskColor,[out, retval] IDispatch **Region)
	The EqualRgn method creates a region from the Image.

---

Detailed Description

A Regions object can be used for creating a regions.

---

Member Function Documentation

CombineRgn	(	[in] ULONG	hrgnSrc1,
		[in] ULONG	hrgnSrc2,
		[in] LONG	fnCombineMode,
		[out, retval] IDispatch **	pRegion
	)

The CombineRgn method combines two regions and returns the result.

Parameters:

	hrgnSrc1	The first region.
	hrgnSrc2	The second region.
	fnCombineMode	The creation mode, this parameter can be one of the following values:

• RGN_AND Method creates the intersection of the two combined regions.
• RGN_OR Method creates the union of two combined regions.
• RGN_XOR Method creates the union of two combined regions except for any overlapping areas.
• RGN_DIFF Combines the parts of the first region that are not part of the second region.
• RGN_COPY Creates a copy of the first region.

Return values:

pRegion

The created Region object.

CreateEllipticRgn	(	[in] LONG	Left,
		[in] LONG	Top,
		[in] LONG	Width,
		[in] LONG	Height,
		[out, retval] IDispatch **	pRegion
	)

The CreateEllipticRgn method creates an elliptical region.

Parameters:

	Left	Specifies the x-coordinate of the upper-left corner of the bounding rectangle of the ellipse.
	Top	Specifies the y-coordinate of the upper-left corner of the bounding rectangle of the ellipse.
	Width	Specifies the width of the bounding rectangle of the ellipse.
	Height	Specifies the height of the bounding rectangle of the ellipse.

Return values:

pRegion

The created Region object.

CreatePolygonRgn	(	[in] SAFEARRAY(VARIANT)	Data,
		[out, retval] IDispatch **	pRegion
	)

The CreatePolygonRgn method creates an polygon region.

Parameters:

Data

An array of the points that defines the polygon.

Return values:

pRegion

The created Region object.

CreateRectRgn	(	[in] LONG	Left,
		[in] LONG	Top,
		[in] LONG	Width,
		[in] LONG	Height,
		[out, retval] IDispatch **	pRegion
	)

The CreateRectRgn method creates an rectangle region.

Parameters:

	Left	Specifies the x-coordinate of the upper-left corner of the rectangle.
	Top	Specifies the y-coordinate of the upper-left corner of the rectangle.
	Width	Specifies the width of the rectangle.
	Height	Specifies the height of the rectangle.

Return values:

pRegion

The created Region object.

CreateRgnFromImage	(	[in] VARIANT	Image,
		[in] ULONG	MaskColor,
		[out, retval] IDispatch **	Region
	)

The EqualRgn method creates a region from the Image.

Parameters:

	Image	Image;
	MaskColor	Mask color (or transparent color).

Return values:

Region

The created Region object.

Since:

1.1.6.

CreateRoundRectRgn	(	[in] LONG	Left,
		[in] LONG	Top,
		[in] LONG	Width,
		[in] LONG	Height,
		[in] LONG	nWidthEllipse,
		[in] LONG	nHeightEllipse,
		[out, retval] IDispatch **	pRegion
	)

The CreateRoundRectRgn method creates an rectangular region with rounded corners.

Parameters:

	Left	Specifies the x-coordinate of the upper-left corner of the rectangle.
	Top	Specifies the y-coordinate of the upper-left corner of the rectangle.
	Width	Specifies the width of the rectangle.
	Height	Specifies the height of the rectangle.
	nWidthEllipse	Specifies the width of the ellipse that used to create the rounded corners.
	nHeightEllipse	Specifies the height of the ellipse that used to create the rounded corners.

Return values:

pRegion

The created Region object.

EqualRgn	(	[in] ULONG	hSrcRgn1,
		[in] ULONG	hSrcRgn2,
		[out, retval] VARIANT_BOOL *	pResult
	)

The EqualRgn method compares a two regions.

Parameters:

	hSrcRgn1	The first region.
	hSrcRgn2	The second region.

Return values:

pResult

The result.

TransformRgn	(	[in] ULONG	ARegion,
		[in] FLOAT	eM11,
		[in] FLOAT	eM12,
		[in] FLOAT	eM21,
		[in] FLOAT	eM22,
		[in] FLOAT	eDx,
		[in] FLOAT	eDy,
		[out, retval] IDispatch **	pRegion
	)

The TransformRgn method creates a region from the specified region and transformation data.

The transformation performed by the transformation matrix:

| eM11 eM12 0 |
| eM21 eM22 0 |
| eDx eDy 1 |

The new coordinates X and Y of an point calculated by the old coordinates x and y by formulas:

X = x * eM11 + y * eM21 + eDx,
Y = x * eM12 + y * eM22 + eDy,

Parameters:

	ARegion	The region.
	eM11	Specifies the eM11 field in the transformation matrix.
	eM12	Specifies the eM12 field in the transformation matrix.
	eM21	Specifies the eM21 field in the transformation matrix.
	eM22	Specifies the eM22 field in the transformation matrix.
	eDx	Specifies the eDx field in the transformation matrix.
	eDy	Specifies the eDy field in the transformation matrix.

Return values:

pRegion

The created Region object.

---