TLazRegion.GetRegionKind function

Declaration

function GetRegionKind: LongInt

Function result

Region flag value for the class instance.

Description

GetRegionKind is a Longint function used to get the type of region represented in the class instance. The return value adheres to the region flag values used in the Windows GDI API, and can include one of the following:

COMPLEXREGION (3)

The region has more than one rectangle, polygon, or ellipse. Used when IsSimpleRectRegion is False.

SIMPLEREGION (2)

The region is a simple rectangle defined using the Rect member. Used when IsSimpleRectRegion is True, and Rect is not an empty rectangle (Left, Top, Bottom, and Right all contain zero).

NULLREGION (1)

The region has an empty value in its Rect member (Left, Top, Width, and Height all contain zero).

REGION_ERROR (0)

An error occurred. Not used in GetRegionKind.